8000 docs: add generated snippets (#189) · googleapis/google-cloud-python@dfd5b71 · GitHub
[go: up one dir, main page]
Skip to content

Commit dfd5b71

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: add generated snippets (#189)
* chore: use gapic-generator-python 0.63.2 docs: add generated snippets PiperOrigin-RevId: 427792504 Source-Link: googleapis/googleapis@55b9e1e Source-Link: googleapis/googleapis-gen@bf4e86b Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYmY0ZTg2Yjc1M2Y0MmNiMGVkYjFmZDUxZmJlODQwZDdkYTBhMWNkZSJ9 * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent a6fe3c3 commit dfd5b71

File tree

38 files changed

+3484
-0
lines changed

38 files changed

+3484
-0
lines changed

‎packages/google-cloud-scheduler/google/cloud/scheduler_v1/services/cloud_scheduler/async_client.py

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,26 @@ async def list_jobs(
224224
) -> pagers.ListJobsAsyncPager:
225225
r"""Lists jobs.
226226
227+
.. code-block::
228+
229+
from google.cloud import scheduler_v1
230+
231+
def sample_list_jobs():
232+
# Create a client
233+
client = scheduler_v1.CloudSchedulerClient()
234+
235+
# Initialize request argument(s)
236+
request = scheduler_v1.ListJobsRequest(
237+
parent="parent_value",
238+
)
239+
240+
# Make the request
241+
page_result = client.list_jobs(request=request)
242+
243+
# Handle the response
244+
for response in page_result:
245+
print(response)
246+
227247
Args:
228248
request (Union[google.cloud.scheduler_v1.types.ListJobsRequest, dict]):
229249
The request object. Request message for listing jobs
@@ -315,6 +335,25 @@ async def get_job(
315335
) -> job.Job:
316336
r"""Gets a job.
317337
338+
.. code-block::
339+
340+
from google.cloud import scheduler_v1
341+
342+
def sample_get_job():
343+
# Create a client
344+
client = scheduler_v1.CloudSchedulerClient()
345+
346+
# Initialize request argument(s)
347+
request = scheduler_v1.GetJobRequest(
348+
name="name_value",
349+
)
350+
351+
# Make the request
352+
response = client.get_job(request=request)
353+
354+
# Handle the response
355+
print(response)
356+
318357
Args:
319358
request (Union[google.cloud.scheduler_v1.types.GetJobRequest, dict]):
320359
The request object. Request message for
@@ -398,6 +437,25 @@ async def create_job(
398437
) -> gcs_job.Job:
399438
r"""Creates a job.
400439
440+
.. code-block::
441+
442+
from google.cloud import scheduler_v1
443+
444+
def sample_create_job():
445+
# Create a client
446+
client = scheduler_v1.CloudSchedulerClient()
447+
448+
# Initialize request argument(s)
449+
request = scheduler_v1.CreateJobRequest(
450+
parent="parent_value",
451+
)
452+
453+
# Make the request
454+
response = client.create_job(request=request)
455+
456+
# Handle the response
457+
print(response)
458+
401459
Args:
402460
request (Union[google.cloud.scheduler_v1.types.CreateJobRequest, dict]):
403461
The request object. Request message for
@@ -497,6 +555,25 @@ async def update_job(
497555
retry the UpdateJob request until a successful response is
498556
received.
499557
558+
559+
.. code-block::
560+
561+
from google.cloud import scheduler_v1
562+
563+
def sample_update_job():
564+
# Create a client
565+
client = scheduler_v1.CloudSchedulerClient()
566+
567+
# Initialize request argument(s)
568+
request = scheduler_v1.UpdateJobRequest(
569+
)
570+
571+
# Make the request
572+
response = client.update_job(request=request)
573+
574+
# Handle the response
575+
print(response)
576+
500577
Args:
501578
request (Union[google.cloud.scheduler_v1.types.UpdateJobRequest, dict]):
502579
The request object. Request message for
@@ -583,6 +660,22 @@ async def delete_job(
583660
) -> None:
584661
r"""Deletes a job.
585662
663+
.. code-block::
664+
665+
from google.cloud import scheduler_v1
666+
667+
def sample_delete_job():
668+
# Create a client
669+
client = scheduler_v1.CloudSchedulerClient()
670+
671+
# Initialize request argument(s)
672+
request = scheduler_v1.DeleteJobRequest(
673+
name="name_value",
674+
)
675+
676+
# Make the request
677+
client.delete_job(request=request)
678+
586679
Args:
587680
request (Union[google.cloud.scheduler_v1.types.DeleteJobRequest, dict]):
588681
The request object. Request message for deleting a job
@@ -669,6 +762,26 @@ async def pause_job(
669762
[Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]
670763
to be paused.
671764
765+
766+
.. code-block::
767+
768+
from google.cloud import scheduler_v1
769+
770+
def sample_pause_job():
771+
# Create a client
772+
client = scheduler_v1.CloudSchedulerClient()
773+
774+
# Initialize request argument(s)
775+
request = scheduler_v1.PauseJobRequest(
776+
name="name_value",
777+
)
778+
779+
# Make the request
780+
response = client.pause_job(request=request)
781+
782+
# Handle the response
783+
print(response)
784+
672785
Args:
673786
request (Union[google.cloud.scheduler_v1.types.PauseJobRequest, dict]):
674787
The request object. Request message for
@@ -751,6 +864,26 @@ async def resume_job(
751864
[Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]
752865
to be resumed.
753866
867+
868+
.. code-block::
869+
870+
from google.cloud import scheduler_v1
871+
872+
def sample_resume_job():
873+
# Create a client
874+ EED3
client = scheduler_v1.CloudSchedulerClient()
875+
876+
# Initialize request argument(s)
877+
request = scheduler_v1.ResumeJobRequest(
878+
name="name_value",
879+
)
880+
881+
# Make the request
882+
response = client.resume_job(request=request)
883+
884+
# Handle the response
885+
print(response)
886+
754887
Args:
755888
request (Union[google.cloud.scheduler_v1.types.ResumeJobRequest, dict]):
756889
The request object. Request message for
@@ -825,6 +958,26 @@ async def run_job(
825958
When this method is called, Cloud Scheduler will
826959
dispatch the job, even if the job is already running.
827960
961+
962+
.. code-block::
963+
964+
from google.cloud import scheduler_v1
965+
966+
def sample_run_job():
967+
# Create a client
968+
client = scheduler_v1.CloudSchedulerClient()
969+
970+
# Initialize request argument(s)
971+
request = scheduler_v1.RunJobRequest(
972+
name="name_value",
973+
)
974+
975+
# Make the request
976+
response = client.run_job(request=request)
977+
978+
# Handle the response
979+
print(response)
980+
828981
Args:
829982
request (Union[google.cloud.scheduler_v1.types.RunJobRequest, dict]):
830983
The request object. Request message for forcing a job to

0 commit comments

Comments
 (0)
0