API documentation for scheduler_v1.types package.
Classes
AppEngineHttpTarget
App Engine target. The job will be pushed to a job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. Error 503 is considered an App Engine system error instead of an application error. Requests returning error 503 will be retried regardless of retry configuration and not counted against retry counts. Any other response code, or a failure to receive a response before the deadline, constitutes a failed attempt.
AppEngineRouting
App Engine Routing.
For more information about services, versions, and instances see An
Overview of App
Engine <https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine>,
Microservices Architecture on Google App
Engine <https://cloud.google.com/appengine/docs/python/microservices-on-app-engine>,
App Engine Standard request
routing <https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed>,
and App Engine Flex request
routing <https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed>.
CreateJobRequest
Request message for CreateJob.
DeleteJobRequest
Request message for deleting a job using DeleteJob.
GetJobRequest
Request message for GetJob.
HttpMethod
The HTTP method used to execute the job.
Values: HTTP_METHOD_UNSPECIFIED (0): HTTP method unspecified. Defaults to POST. POST (1): HTTP POST GET (2): HTTP GET HEAD (3): HTTP HEAD PUT (4): HTTP PUT DELETE (5): HTTP DELETE PATCH (6): HTTP PATCH OPTIONS (7): HTTP OPTIONS
HttpTarget
Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered.
This message has oneof_ 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 other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Job
Configuration for a job. The maximum allowed size for a job is 1MB.
This message has oneof_ 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 other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListJobsRequest
Request message for listing jobs using ListJobs.
ListJobsResponse
Response message for listing jobs using ListJobs.
OAuthToken
Contains information needed for generating an OAuth
token <https://developers.google.com/identity/protocols/OAuth2>__.
This type of authorization should generally only be used when
calling Google APIs hosted on *.googleapis.com.
OidcToken
Contains information needed for generating an OpenID Connect
token <https://developers.google.com/identity/protocols/OpenIDConnect>__.
This type of authorization can be used for many scenarios, including
calling Cloud Run, or endpoints where you intend to validate the
token yourself.
PauseJobRequest
Request message for PauseJob.
PubsubTarget
Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic.
ResumeJobRequest
Request message for ResumeJob.
RetryConfig
Settings that determine the retry behavior.
By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig.
RunJobRequest
Request message for forcing a job to run now using RunJob.
UpdateJobRequest
Request message for UpdateJob.