Package Classes (2.17.0)

Summary of entries of Classes for cloudscheduler.

Classes

CloudSchedulerAsyncClient

The Cloud Scheduler API allows external entities to reliablyschedule asynchronous jobs.

CloudSchedulerClient

The Cloud Scheduler API allows external entities to reliablyschedule asynchronous jobs.

ListJobsAsyncPager

A pager for iterating throughlist_jobs requests.

This class thinly wraps an initialListJobsResponse object, andprovides an__aiter__ method to iterate through itsjobs field.

If there are more pages, the__aiter__ method will make additionalListJobs requests and continue to iteratethrough thejobs field on thecorresponding responses.

All the usualListJobsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListJobsPager

A pager for iterating throughlist_jobs requests.

This class thinly wraps an initialListJobsResponse object, andprovides an__iter__ method to iterate through itsjobs field.

If there are more pages, the__iter__ method will make additionalListJobs requests and continue to iteratethrough thejobs field on thecorresponding responses.

All the usualListJobsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

AppEngineHttpTarget

App Engine target. The job will be pushed to a job handler by meansof an HTTP request via anhttp_methodsuch as HTTP POST, HTTP GET, etc. The job is acknowledged by meansof an HTTP response code in the range [200 - 299]. Error 503 isconsidered an App Engine system error instead of an applicationerror. Requests returning error 503 will be retried regardless ofretry configuration and not counted against retry counts. Any otherresponse code, or a failure to receive a response before thedeadline, constitutes a failed attempt.

HeadersEntry

The abstract base class for a message.

AppEngineRouting

App Engine Routing.

For more information about services, versions, and instances seeAnOverview of AppEngine <https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine>,Microservices Architecture on Google AppEngine <https://cloud.google.com/appengine/docs/python/microservices-on-app-engine>,App Engine Standard requestrouting <https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed>,andApp Engine Flex requestrouting <https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed>.

CreateJobRequest

Request message forCreateJob.

DeleteJobRequest

Request message for deleting a job usingDeleteJob.

GetJobRequest

Request message forGetJob.

HttpMethod

The HTTP method used to execute the job.

HttpTarget

Http target. The job will be pushed to the job handler by means ofan HTTP request via anhttp_method suchas HTTP POST, HTTP GET, etc. The job is acknowledged by means of anHTTP response code in the range [200 - 299]. A failure to receive aresponse constitutes a failed execution. For a redirected request,the response returned by the redirected request is considered.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

HeadersEntry

The abstract base class for a message.

Job

Configuration for a job.The maximum allowed size for a job is 1MB.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

State of the job.

ListJobsRequest

Request message for listing jobs usingListJobs.

ListJobsResponse

Response message for listing jobs usingListJobs.

OAuthToken

Contains information needed for generating anOAuthtoken <https://developers.google.com/identity/protocols/OAuth2>__.This type of authorization should generally only be used whencalling Google APIs hosted on *.googleapis.com.

OidcToken

Contains information needed for generating anOpenID Connecttoken <https://developers.google.com/identity/protocols/OpenIDConnect>__.This type of authorization can be used for many scenarios, includingcalling Cloud Run, or endpoints where you intend to validate thetoken yourself.

PauseJobRequest

Request message forPauseJob.

PubsubTarget

Pub/Sub target. The job will be delivered by publishing amessage to the given Pub/Sub topic.

AttributesEntry

The abstract base class for a message.

ResumeJobRequest

Request message forResumeJob.

RetryConfig

Settings that determine the retry behavior.

By default, if a job does not complete successfully (meaning that anacknowledgement is not received from the handler, then it will beretried with exponential backoff according to the settings inRetryConfig.

RunJobRequest

Request message for forcing a job to run now usingRunJob.

UpdateJobRequest

Request message forUpdateJob.

CloudSchedulerAsyncClient

The Cloud Scheduler API allows external entities to reliablyschedule asynchronous jobs.

CloudSchedulerClient

The Cloud Scheduler API allows external entities to reliablyschedule asynchronous jobs.

ListJobsAsyncPager

A pager for iterating throughlist_jobs requests.

This class thinly wraps an initialListJobsResponse object, andprovides an__aiter__ method to iterate through itsjobs field.

If there are more pages, the__aiter__ method will make additionalListJobs requests and continue to iteratethrough thejobs field on thecorresponding responses.

All the usualListJobsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListJobsPager

A pager for iterating throughlist_jobs requests.

This class thinly wraps an initialListJobsResponse object, andprovides an__iter__ method to iterate through itsjobs field.

If there are more pages, the__iter__ method will make additionalListJobs requests and continue to iteratethrough thejobs field on thecorresponding responses.

All the usualListJobsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

AppEngineHttpTarget

App Engine target. The job will be pushed to a job handler by meansof an HTTP request via anhttp_methodsuch as HTTP POST, HTTP GET, etc. The job is acknowledged by meansof an HTTP response code in the range [200 - 299]. Error 503 isconsidered an App Engine system error instead of an applicationerror. Requests returning error 503 will be retried regardless ofretry configuration and not counted against retry counts. Any otherresponse code, or a failure to receive a response before thedeadline, constitutes a failed attempt.

HeadersEntry

The abstract base class for a message.

AppEngineRouting

App Engine Routing.

For more information about services, versions, and instances seeAnOverview of AppEngine <https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine>,Microservices Architecture on Google AppEngine <https://cloud.google.com/appengine/docs/python/microservices-on-app-engine>,App Engine Standard requestrouting <https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed>,andApp Engine Flex requestrouting <https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed>.

CreateJobRequest

Request message forCreateJob.

DeleteJobRequest

Request message for deleting a job usingDeleteJob.

GetJobRequest

Request message forGetJob.

HttpMethod

The HTTP method used to execute the job.

HttpTarget

Http target. The job will be pushed to the job handler by means ofan HTTP request via anhttp_methodsuch as HTTP POST, HTTP GET, etc. The job is acknowledged by meansof an HTTP response code in the range [200 - 299]. A failure toreceive a response constitutes a failed execution. For a redirectedrequest, the response returned by the redirected request isconsidered.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

HeadersEntry

The abstract base class for a message.

Job

Configuration for a job.The maximum allowed size for a job is 1MB.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

State of the job.

ListJobsRequest

Request message for listing jobs usingListJobs.

ListJobsResponse

Response message for listing jobs usingListJobs.

OAuthToken

Contains information needed for generating anOAuthtoken <https://developers.google.com/identity/protocols/OAuth2>__.This type of authorization should generally only be used whencalling Google APIs hosted on *.googleapis.com.

OidcToken

Contains information needed for generating anOpenID Connecttoken <https://developers.google.com/identity/protocols/OpenIDConnect>__.This type of authorization can be used for many scenarios, includingcalling Cloud Run, or endpoints where you intend to validate thetoken yourself.

PauseJobRequest

Request message forPauseJob.

PubsubTarget

Pub/Sub target. The job will be delivered by publishing amessage to the given Pub/Sub topic.

AttributesEntry

The abstract base class for a message.

ResumeJobRequest

Request message forResumeJob.

RetryConfig

Settings that determine the retry behavior.

By default, if a job does not complete successfully (meaning that anacknowledgement is not received from the handler, then it will beretried with exponential backoff according to the settings inRetryConfig.

RunJobRequest

Request message for forcing a job to run now usingRunJob.

UpdateJobRequest

Request message forUpdateJob.

Modules

pagers

API documentation forscheduler_v1.services.cloud_scheduler.pagers module.

pagers

API documentation forscheduler_v1beta1.services.cloud_scheduler.pagers module.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.