- Resource: Job
- PubsubTarget
- AppEngineHttpTarget
- HttpMethod
- AppEngineRouting
- HttpTarget
- OAuthToken
- OidcToken
- State
- RetryConfig
- Methods
Resource: Job
Configuration for a job. The maximum allowed size for a job is 1MB.
JSON representation |
---|
{ "name": string, "description": string, "schedule": string, "timeZone": string, "userUpdateTime": string, "state": enum ( |
Fields | |
---|---|
name |
Optionally caller-specified in The job name. For example:
|
description |
Optionally caller-specified in A human-readable description for the job. This string must not contain more than 500 characters. |
schedule |
Required, except when used with Describes the schedule on which the job will be executed. The schedule can be either of the following types: As a general rule, execution If |
timeZone |
Specifies the time zone to be used in interpreting 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). |
userUpdateTime |
Output only. The creation time of the job. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
state |
Output only. State of the job. |
status |
Output only. The response from the target for the last attempted execution. |
scheduleTime |
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. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
lastAttemptTime |
Output only. The time the last job attempt started. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
retryConfig |
Settings that determine the retry behavior. |
attemptDeadline |
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 The default and the allowed values depend on the type of target:
A duration in seconds with up to nine fractional digits, ending with ' |
legacyAppEngineCron |
Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets. |
Union field Delivery settings containing destination and parameters. |
|
pubsubTarget |
Pub/Sub target. |
appEngineHttpTarget |
App Engine HTTP target. |
httpTarget |
HTTP target. |
PubsubTarget
Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic.
JSON representation |
---|
{ "topicName": string, "data": string, "attributes": { string: string, ... } } |
Fields | |
---|---|
topicName |
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 Pub/Sub's PublishRequest.name, for example The topic must be in the same project as the Cloud Scheduler job. |
data |
The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. A base64-encoded string. |
attributes |
Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. An object containing a list of |
AppEngineHttpTarget
App Engine target. The job will be pushed to a job handler by means of an HTTP request via an httpMethod
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.
JSON representation |
---|
{ "httpMethod": enum ( |
Fields | |
---|---|
httpMethod |
The HTTP method to use for the request. PATCH and OPTIONS are not permitted. |
appEngineRouting |
App Engine Routing setting for the job. |
relativeUri |
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 |
headers |
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:
If the job has a
The headers below are output only. They cannot be set or overridden:
In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. An object containing a list of |
body |
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 A base64-encoded string. |
HttpMethod
The HTTP method used to execute the job.
Enums | |
---|---|
HTTP_METHOD_UNSPECIFIED |
HTTP method unspecified. Defaults to POST. |
POST |
HTTP POST |
GET |
HTTP GET |
HEAD |
HTTP HEAD |
PUT |
HTTP PUT |
DELETE |
HTTP DELETE |
PATCH |
HTTP PATCH |
OPTIONS |
HTTP OPTIONS |
AppEngineRouting
App Engine Routing.
For more information about services, versions, and instances see An Overview of App Engine, Microservices Architecture on Google App Engine, App Engine Standard request routing, and App Engine Flex request routing.
JSON representation |
---|
{ "service": string, "version": string, "instance": string, "host": string } |
Fields | |
---|---|
service |
App service. By default, the job is sent to the service which is the default service when the job is attempted. |
version |
App version. By default, the job is sent to the version which is the default version when the job is attempted. |
instance |
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. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing. |
host |
Output only. The host that the job is sent to. For more information about how App Engine requests are routed, see here. The host is constructed as:
If If If If |
HttpTarget
Http target. The job will be pushed to the job handler by means of an HTTP request via an httpMethod
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.
JSON representation |
---|
{ "uri": string, "httpMethod": enum ( |
Fields | |
---|---|
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 |
httpMethod |
Which HTTP method to use for the request. |
headers |
HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below:
If the job has a
The total size of headers must be less than 80KB. An object containing a list of |
body |
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 A base64-encoded string. |
Union field If specified, all |
|
oauthToken |
If specified, an OAuth token will be generated and attached as an This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. |
oidcToken |
If specified, an OIDC token will be generated and attached as an This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. |
OAuthToken
Contains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
JSON representation |
---|
{ "serviceAccountEmail": string, "scope": string } |
Fields | |
---|---|
serviceAccountEmail |
Service account email 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. |
scope |
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. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
JSON representation |
---|
{ "serviceAccountEmail": string, "audience": string } |
Fields | |
---|---|
serviceAccountEmail |
Service account email 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. |
audience |
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. |
State
State of the job.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unspecified state. |
ENABLED |
The job is executing normally. |
PAUSED |
The job is paused by the user. It will not execute. A user can intentionally pause the job using PauseJobRequest . |
DISABLED |
The job is disabled by the system due to error. The user cannot directly set a job to be disabled. |
UPDATE_FAILED |
The job state resulting from a failed CloudScheduler.UpdateJob operation. To recover a job from this state, retry CloudScheduler.UpdateJob until a successful response is received. |
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
.
JSON representation |
---|
{ "retryCount": integer, "maxRetryDuration": string, "minBackoffDuration": string, "maxBackoffDuration": string, "maxDoublings": integer } |
Fields | |
---|---|
retryCount |
The number of attempts that the system will make to run a job using the exponential backoff procedure described by The default value of retryCount is zero. If retryCount is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retryCount to 0 does not prevent failed jobs from running according to schedule after the failure. If retryCount is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retryCount times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed. |
maxRetryDuration |
The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with The default value for maxRetryDuration is zero, which means retry duration is unlimited. A duration in seconds with up to nine fractional digits, ending with ' |
minBackoffDuration |
The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds. A duration in seconds with up to nine fractional digits, ending with ' |
maxBackoffDuration |
The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour. A duration in seconds with up to nine fractional digits, ending with ' |
maxDoublings |
The time between retries will double A job's retry interval starts at For example, if The default value of this field is 5. |
Methods |
|
---|---|
|
Creates a job. |
|
Deletes a job. |
|
Gets a job. |
|
Lists jobs. |
|
Updates a job. |
|
Pauses a job. |
|
Resume a job. |
|
Forces a job to run now. |