API documentation for scheduler_v1.types module.
Classes
Any
API documentation for scheduler_v1.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.v1.AppEng ineHttpTarget.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. .. attribute:: http_method
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
The relative URI. The relative URL must begin with "/" and
must be a valid HTTP relative URL. It can contain a path,
query string arguments, and # fragments. If the relative
URL is empty, then the root path "/" will be used. No spaces
are allowed, and the maximum length allowed is 2083
characters.
Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
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>.
.. attribute:: service
App service. By default, the job is sent to the service which is the default service when the job is attempted.
App instance. By default, the job is sent to an instance
which is available when the job is attempted. Requests can
only be sent to a specific instance if manual scaling is used
in App Engine Standard
<https://cloud.google.com/appengine/docs/python/an-overview-
of-app-engine?hl=en_US#scaling_types_and_instance_classes>.
App Engine Flex does not support instances. For more
information, see 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. .. attribute:: parent
Required. The location name. For example:
projects/PROJECT_ID/locations/LOCATION_ID.
DeleteJobRequest
Request message for deleting a job using DeleteJob. .. attribute:: name
Required. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
Duration
API documentation for scheduler_v1.types.Duration class.
Empty
API documentation for scheduler_v1.types.Empty class.
FieldMask
API documentation for scheduler_v1.types.FieldMask class.
GetJobRequest
Request message for GetJob. .. attribute:: name
Required. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
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.v1.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. .. attribute:: uri
Required. The full URI path that the request will be sent to.
This string must begin with either "http://" or "https://".
Some examples of valid values for
uri are:
http://acme.com and https://acme.com/sales:8080. Cloud
Scheduler will encode some characters for safety and
compatibility. The maximum allowed URL length is 2083
characters after encoding.
The user can specify HTTP request headers to send with the
job's HTTP request. This map contains the header field names
and values. Repeated headers are not supported, but a header
value can contain commas. These headers represent a subset of
the headers that will accompany the job's HTTP request. Some
HTTP request headers will be ignored or replaced. A partial
list of headers that will be ignored or replaced is below: -
Host: This will be computed by Cloud Scheduler and derived
from uri. *
Content-Length: This will be computed by Cloud Scheduler.
* User-Agent: This will be set to "Google-Cloud-
Scheduler". * X-Google-*: Google internal use only. *
X-AppEngine-*: Google internal use only. The total size
of headers must be less than 80KB.
The mode for generating an Authorization header for HTTP
requests. If specified, all Authorization headers in the
[HttpTarget.headers][google.cloud.scheduler.v1.HttpTarget.head
ers] field will be overridden.
If specified, an OIDC <https://developers.google.com/identity
/protocols/OpenIDConnect>__ token will be generated and
attached as an Authorization header in the HTTP request.
This type of authorization can be used for many scenarios,
including calling Cloud Run, or endpoints where you intend to
validate the token yourself.
Job
Configuration for a job. The maximum allowed size for a job is 100KB. .. attribute:: name
Optionally caller-specified in [CreateJob][google.cloud.schedu
ler.v1.CloudScheduler.CreateJob], after which it becomes
output only. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID. -
PROJECT_ID can contain letters ([A-Za-z]), numbers
([0-9]), hyphens (-), colons (:), or periods (.). For more
information, see Identifying projects
<https://cloud.google.com/resource-manager/docs/creating-
managing-projects#identifying_projects>_ - LOCATION_ID
is the canonical ID for the job's location. The list of
available locations can be obtained by calling [ListLocatio
ns][google.cloud.location.Locations.ListLocations]. For
more information, see
https://cloud.google.com/about/locations/. - JOB_ID can
contain only letters ([A-Za-z]), numbers ([0-9]), hyphens
(-), or underscores (\). The maximum length is 500
characters.
Required. Delivery settings containing destination and parameters.
App Engine HTTP target.
Required, except when used with [UpdateJob][google.cloud.sched
uler.v1.CloudScheduler.UpdateJob]. Describes the schedule on
which the job will be executed. The schedule can be either of
the following types: - Crontab
<http://en.wikipedia.org/wiki/Cron#Overview> - English-
like schedule
<https://cloud.google.com/scheduler/docs/configuring/cron-job-
schedules> As a general rule, execution n + 1 of a job
will not begin until execution n has finished. Cloud
Scheduler will never allow two simultaneously outstanding
executions. For example, this implies that if the n+1\ th
execution is scheduled to run at 16:00 but the n\ th
execution takes until 16:15, the n+1\ th execution will
not start until 16:15. A scheduled start time will be
delayed if the previous execution has not ended when its
scheduled time occurs. If [retry_count][google.cloud.schedul
er.v1.RetryConfig.retry_count] > 0 and a job attempt fails,
the job will be tried a total of [retry_count][google.cloud.s
cheduler.v1.RetryConfig.retry_count] times, with exponential
backoff, until the next scheduled start time.
Output only. The creation time of the job.
Output only. The response from the target for the last attempted execution.
Output only. The time the last job attempt started.
The deadline for job attempts. If the request handler does not
respond by this deadline then the request is cancelled and the
attempt is marked as a DEADLINE_EXCEEDED failure. The
failed attempt can be viewed in execution logs. Cloud
Scheduler will retry the job according to the
RetryConfig. The
allowed duration for this deadline is: * For [HTTP
targets][google.cloud.scheduler.v1.Job.http_target], between
15 seconds and 30 minutes. * For [App Engine HTTP targets][go
ogle.cloud.scheduler.v1.Job.app_engine_http_target],
between 15 seconds and 24 hours.
ListJobsRequest
Request message for listing jobs using ListJobs. .. attribute:: parent
Required. The location name. For example:
projects/PROJECT_ID/locations/LOCATION_ID.
A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of [next_page_token][google.cloud.scheduler.v1.ListJob sResponse.next_page_token] returned from the previous call to ListJobs. It is an error to switch the value of filter or [order_by][google.cloud.scheduler.v1.ListJobsRequest.order_b y] while iterating through pages.
ListJobsResponse
Response message for listing jobs using ListJobs. .. attribute:: jobs
The list of jobs.
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.
.. attribute:: service_account_email
\ Service account email
<https://cloud.google.com/iam/docs/service-accounts>__ to be
used for generating OAuth token. The service account must be
within the same project as the job. The caller must have
iam.serviceAccounts.actAs permission for the service account.
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.
.. attribute:: service_account_email
\ Service account email
<https://cloud.google.com/iam/docs/service-accounts>__ to be
used for generating OIDC token. The service account must be
within the same project as the job. The caller must have
iam.serviceAccounts.actAs permission for the service account.
PauseJobRequest
Request message for PauseJob. .. attribute:: name
Required. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
PubsubTarget
Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. .. attribute:: topic_name
Required. The name of the Cloud Pub/Sub topic to which
messages will be published when a job is delivered. The topic
name must be in the same format as required by PubSub's
PublishRequest.name <https://cloud.google.com/pubsub/docs/ref
erence/rpc/google.pubsub.v1#publishrequest>__, for example
projects/PROJECT_ID/topics/TOPIC_ID. The topic must be in
the same project as the Cloud Scheduler job.
Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
ResumeJobRequest
Request message for ResumeJob. .. attribute:: name
Required. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
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. .. attribute:: retry_count
The number of attempts that the system will make to run a job using the exponential backoff procedure described by [max_dou blings][google.cloud.scheduler.v1.RetryConfig.max_doublings]. The default value of retry_count is zero. If retry_count is zero, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
The time between retries will double max_doublings times.
A job's retry interval starts at [min_backoff_duration][goog
le.cloud.scheduler.v1.RetryConfig.min_backoff_duration],
then doubles max_doublings times, then increases linearly,
and finally retries retries at intervals of [max_backoff_dur
ation][google.cloud.scheduler.v1.RetryConfig.max_backoff_dur
ation] up to [retry_count][google.cloud.scheduler.v1.RetryCon
fig.retry_count] times. For example, if [min_backoff_durat
ion][google.cloud.scheduler.v1.RetryConfig.min_backoff_durat
ion] is 10s, [max_backoff_duration][google.cloud.scheduler.v
1.RetryConfig.max_backoff_duration] is 300s, and
max_doublings is 3, then the a job will first be retried
in 10s. The retry interval will double three times, and then
increase linearly by 2^3 * 10s. Finally, the job will retry
at intervals of [max_backoff_duration][google.cloud.schedule
r.v1.RetryConfig.max_backoff_duration] until the job has
been attempted [retry_count][google.cloud.scheduler.v1.RetryC
onfig.retry_count] times. Thus, the requests will retry at
10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default
value of this field is 5.
RunJobRequest
Request message for forcing a job to run now using RunJob. .. attribute:: name
Required. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
Status
API documentation for scheduler_v1.types.Status class.
Timestamp
API documentation for scheduler_v1.types.Timestamp class.
UpdateJobRequest
Request message for UpdateJob. .. attribute:: job
Required. The new job properties. name must be specified. Output only fields cannot be modified using UpdateJob. Any value specified for an output only field will be ignored.