API documentation for scheduler_v1beta1.types module.
Classes
Any
API documentation for scheduler_v1beta1.types.Any class.
AppEngineHttpTarget
App Engine target. The job will be pushed to a job handler by means of an HTTP request via an [http_method][google.cloud.scheduler.v1beta1.AppEngineHttpTarget.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.
App Engine Routing setting for the job.
HTTP request headers. This map contains the header field
names and values. Headers can be set when the job is created.
Cloud Scheduler sets some headers to default values: -
User-Agent: By default, this header is "AppEngine-
Google; (+http://code.google.com/appengine)". This header
can be modified, but Cloud Scheduler will append
"AppEngine-Google; (+http://code.google.com/appengine)" to
the modified User-Agent. - X-CloudScheduler: This
header will be set to true. If the job has an [body][google.c
loud.scheduler.v1beta1.AppEngineHttpTarget.body], Cloud
Scheduler sets the following headers: - Content-Type: By
default, the Content-Type header is set to
"application/octet-stream". The default can be overridden
by explictly setting Content-Type to a particular media
type when the job is created. For example, Content-Type
can be set to "application/json". - Content-
Length: This is computed by Cloud Scheduler. This value
is output only. It cannot be changed. The headers below are
output only. They cannot be set or overridden: -
X-Google-*: For Google internal use only. -
X-AppEngine-*: For Google internal use only. In addition,
some App Engine headers, which contain job-specific
information, are also be sent to the job handler.
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>.
App version. By default, the job is sent to the version which is the default version when the job is attempted.
Output only. The host that the job is sent to. For more
information about how App Engine requests are routed, see
here
<https://cloud.google.com/appengine/docs/standard/python/how-
requests-are-routed>__. The host is constructed as: -
host = [application_domain_name]\ `| [service] + '.'
- [application_domain_name]
\| [version] + '.' + [application_domain_name]\| [version_dot_service]+ '.' + [application_domain_name]\| [instance] + '.' + [application_domain_name]\| [instance_dot_service] + '.' + [application_domain_name]\| [instance_dot_version] + '.' + [application_domain_name]`| [instance_dot_version_dot_service] + '.' + [application_domain_name]-application_domain_name= The domain name of the app, for example .appspot.com, which is associated with the job's project ID. -service =[service][google.cloud.scheduler.v1beta1.AppEngineRouting.serv ice] -version =[version][google.cloud.scheduler.v1b eta1.AppEngineRouting.version] -version_dot_service =[version][google.cloud.scheduler.v1beta1.AppEngineRouting.vers ion]+ '.' +[service][google.cloud.scheduler.v1beta 1.AppEngineRouting.service] -instance =[instance][g oogle.cloud.scheduler.v1beta1.AppEngineRouting.instance] -instance_dot_service =[instance][google.cloud.schedule r.v1beta1.AppEngineRouting.instance]+ '.' +[servic e][google.cloud.scheduler.v1beta1.AppEngineRouting.service] -instance_dot_version =[instance][google.cloud.schedule r.v1beta1.AppEngineRouting.instance]+ '.' +[versio n][google.cloud.scheduler.v1beta1.AppEngineRouting.version] -instance_dot_version_dot_service =[instance][google.cl oud.scheduler.v1beta1.AppEngineRouting.instance]+ '.' +[version][google.cloud.scheduler.v1beta1.AppEngineRouti ng.version]+ '.' +[service][google.cloud.scheduler .v1beta1.AppEngineRouting.service] If [service][google.cloud. scheduler.v1beta1.AppEngineRouting.service] is empty, then the job will be sent to the service which is the default service when the job is attempted. If [version][google.cloud.schedule r.v1beta1.AppEngineRouting.version] is empty, then the job will be sent to the version which is the default version when the job is attempted. If [instance][google.cloud.scheduler.v1 beta1.AppEngineRouting.instance] is empty, then the job will be sent to an instance which is available when the job is attempted. If [service][google.cloud.scheduler.v1beta1.AppEng ineRouting.service], [version][google.cloud.scheduler.v1beta1. AppEngineRouting.version], or [instance][google.cloud.schedule r.v1beta1.AppEngineRouting.instance] is invalid, then the job will be sent to the default version of the default service when the job is attempted.
CreateJobRequest
Request message for CreateJob.
Required. The job to add. The user can optionally specify a name for the job in name. name cannot be the same as an existing job. If a name is not specified then the system will generate a random unique name that will be returned (name) in the response.
DeleteJobRequest
Request message for deleting a job using DeleteJob.
Duration
API documentation for scheduler_v1beta1.types.Duration class.
Empty
API documentation for scheduler_v1beta1.types.Empty class.
FieldMask
API documentation for scheduler_v1beta1.types.FieldMask class.
GetJobRequest
Request message for GetJob.
HttpTarget
Http target. The job will be pushed to the job handler by means of an HTTP request via an [http_method][google.cloud.scheduler.v1beta1.HttpTarget.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.
Which HTTP method to use for the request.
HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
If specified, an OAuth token
<https://developers.google.com/identity/protocols/OAuth2>__
will be generated and attached as an Authorization header
in the HTTP request. This type of authorization should be
used when sending requests to a GCP endpoint.
Job
Configuration for a job. The maximum allowed size for a job is 100KB.
Optionally caller-specified in [CreateJob][google.cloud.schedu ler.v1beta1.CloudScheduler.CreateJob] or [UpdateJob][google.cl oud.scheduler.v1beta1.CloudScheduler.UpdateJob]. A human- readable description for the job. This string must not contain more than 500 characters.
Pub/Sub target.
HTTP target.
Specifies the time zone to be used in interpreting
schedule. The
value of this field must be a time zone name from the tz
database <http://en.wikipedia.org/wiki/Tz_database>__. Note
that some time zones include a provision for daylight savings
time. The rules for daylight saving time are determined by the
chosen tz. For UTC use the string "utc". If a time zone is not
specified, the default will be in UTC (also known as GMT).
Output only. State of the job.
Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
Settings that determine the retry behavior.
ListJobsRequest
Request message for listing jobs using ListJobs.
Requested page size. The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist.
ListJobsResponse
Response message for listing jobs using ListJobs.
A token to retrieve next page of results. Pass this value in the [page_token][google.cloud.scheduler.v1beta1.ListJobsReque st.page_token] field in the subsequent call to [ListJobs][goo gle.cloud.scheduler.v1beta1.CloudScheduler.ListJobs] to retrieve the next page of results. If this is empty it indicates that there are no more results through which to paginate. The page token is valid for only 2 hours.
OAuthToken
Contains information needed for generating an OAuth
token <https://developers.google.com/identity/protocols/OAuth2>__. This
type of authorization should be used when sending requests to a GCP
endpoint.
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud- platform" will be used.
OidcToken
Contains information needed for generating an OpenID Connect
token <https://developers.google.com/identity/protocols/OpenIDConnect>__.
This type of authorization should be used when sending requests to third
party endpoints.
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
PauseJobRequest
Request message for PauseJob.
PubsubTarget
Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic.
The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
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.
The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with [retr y_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_co unt], the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
RunJobRequest
Request message for forcing a job to run now using RunJob.
Status
API documentation for scheduler_v1beta1.types.Status class.
Timestamp
API documentation for scheduler_v1beta1.types.Timestamp class.
UpdateJobRequest
Request message for UpdateJob.
A mask used to specify which fields of the job are being updated.