From 951433b152f9d6e3f87e0b9ccffc4170125283a8 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 13 Sep 2023 15:52:59 -0700 Subject: [PATCH] docs: Minor formatting (#353) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: Minor formatting chore: Update gapic-generator-python to v1.11.5 build: Update rules_python to 0.24.0 PiperOrigin-RevId: 563436317 Source-Link: https://github.com/googleapis/googleapis/commit/42fd37b18d706f6f51f52f209973b3b2c28f509a Source-Link: https://github.com/googleapis/googleapis-gen/commit/280264ca02fb9316b4237a96d0af1a2343a81a56 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot --- .../scheduler_v1/services/cloud_scheduler/async_client.py | 1 + .../cloud/scheduler_v1/services/cloud_scheduler/client.py | 1 + .../scheduler_v1/services/cloud_scheduler/transports/grpc.py | 1 + .../services/cloud_scheduler/transports/grpc_asyncio.py | 1 + .../google/cloud/scheduler_v1/types/target.py | 4 ++++ .../services/cloud_scheduler/async_client.py | 1 + .../scheduler_v1beta1/services/cloud_scheduler/client.py | 1 + .../services/cloud_scheduler/transports/grpc.py | 1 + .../services/cloud_scheduler/transports/grpc_asyncio.py | 1 + .../google/cloud/scheduler_v1beta1/types/target.py | 4 ++++ 10 files changed, 16 insertions(+) diff --git a/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/async_client.py b/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/async_client.py index 698012e58fad..b11589c56b60 100644 --- a/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/async_client.py +++ b/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/async_client.py @@ -1049,6 +1049,7 @@ async def run_job( metadata: Sequence[Tuple[str, str]] = (), ) -> job.Job: r"""Forces a job to run now. + When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. diff --git a/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/client.py b/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/client.py index a8d5676169bf..034dd6664cf5 100644 --- a/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/client.py +++ b/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/client.py @@ -1263,6 +1263,7 @@ def run_job( metadata: Sequence[Tuple[str, str]] = (), ) -> job.Job: r"""Forces a job to run now. + When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. diff --git a/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/transports/grpc.py b/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/transports/grpc.py index e1bf08104129..bbddddaf9d15 100644 --- a/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/transports/grpc.py +++ b/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/transports/grpc.py @@ -442,6 +442,7 @@ def run_job(self) -> Callable[[cloudscheduler.RunJobRequest], job.Job]: r"""Return a callable for the run job method over gRPC. Forces a job to run now. + When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. diff --git a/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/transports/grpc_asyncio.py b/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/transports/grpc_asyncio.py index 1c8a30ad2be8..653a47cc1bc0 100644 --- a/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/transports/grpc_asyncio.py +++ b/packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/transports/grpc_asyncio.py @@ -455,6 +455,7 @@ def run_job(self) -> Callable[[cloudscheduler.RunJobRequest], Awaitable[job.Job] r"""Return a callable for the run job method over gRPC. Forces a job to run now. + When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. diff --git a/packages/google-cloud-scheduler/google/cloud/scheduler_v1/types/target.py b/packages/google-cloud-scheduler/google/cloud/scheduler_v1/types/target.py index 725c81a99608..0da4df8c9c85 100644 --- a/packages/google-cloud-scheduler/google/cloud/scheduler_v1/types/target.py +++ b/packages/google-cloud-scheduler/google/cloud/scheduler_v1/types/target.py @@ -302,10 +302,12 @@ class PubsubTarget(proto.Message): job. data (bytes): The message payload for PubsubMessage. + Pubsub message must contain either non-empty data, or at least one attribute. attributes (MutableMapping[str, str]): Attributes for PubsubMessage. + Pubsub message must contain either non-empty data, or at least one attribute. """ @@ -341,11 +343,13 @@ class AppEngineRouting(proto.Message): Attributes: service (str): App service. + By default, the job is sent to the service which is the default service when the job is attempted. version (str): App version. + By default, the job is sent to the version which is the default version when the job is attempted. diff --git a/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/async_client.py b/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/async_client.py index a3440e7f8341..ede6f7fbeddf 100644 --- a/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/async_client.py +++ b/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/async_client.py @@ -1070,6 +1070,7 @@ async def run_job( metadata: Sequence[Tuple[str, str]] = (), ) -> job.Job: r"""Forces a job to run now. + When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. diff --git a/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/client.py b/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/client.py index b3e80b1c067c..6df974f39d2d 100644 --- a/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/client.py +++ b/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/client.py @@ -1264,6 +1264,7 @@ def run_job( metadata: Sequence[Tuple[str, str]] = (), ) -> job.Job: r"""Forces a job to run now. + When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. diff --git a/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/transports/grpc.py b/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/transports/grpc.py index ac34e65381c3..031a8ce2b07b 100644 --- a/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/transports/grpc.py +++ b/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/transports/grpc.py @@ -442,6 +442,7 @@ def run_job(self) -> Callable[[cloudscheduler.RunJobRequest], job.Job]: r"""Return a callable for the run job method over gRPC. Forces a job to run now. + When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. diff --git a/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/transports/grpc_asyncio.py b/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/transports/grpc_asyncio.py index 4b5b53e39598..eefdcf741c0c 100644 --- a/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/transports/grpc_asyncio.py +++ b/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/services/cloud_scheduler/transports/grpc_asyncio.py @@ -455,6 +455,7 @@ def run_job(self) -> Callable[[cloudscheduler.RunJobRequest], Awaitable[job.Job] r"""Return a callable for the run job method over gRPC. Forces a job to run now. + When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. diff --git a/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/types/target.py b/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/types/target.py index 68505cd2ed44..ea180248383c 100644 --- a/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/types/target.py +++ b/packages/google-cloud-scheduler/google/cloud/scheduler_v1beta1/types/target.py @@ -303,10 +303,12 @@ class PubsubTarget(proto.Message): job. data (bytes): The message payload for PubsubMessage. + Pubsub message must contain either non-empty data, or at least one attribute. attributes (MutableMapping[str, str]): Attributes for PubsubMessage. + Pubsub message must contain either non-empty data, or at least one attribute. """ @@ -342,11 +344,13 @@ class AppEngineRouting(proto.Message): Attributes: service (str): App service. + By default, the job is sent to the service which is the default service when the job is attempted. version (str): App version. + By default, the job is sent to the version which is the default version when the job is attempted.