Enumerations

HttpMethod

constant   static

number

The HTTP method used to execute the job.

Value

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

State

static

number

State of the job.

Value

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.

Properties

HttpMethod

constant   static

number

The HTTP method used to execute the job.

Value

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

State

static

number

State of the job.

Value

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.

Abstract types

AppEngineHttpTarget

static

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.

Properties

Parameter

httpMethod

number

The HTTP method to use for the request. PATCH and OPTIONS are not permitted.

The number should be among the values of HttpMethod

appEngineRouting

Object

App Engine Routing setting for the job.

This object should have the same structure as AppEngineRouting

relativeUri

string

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.

headers

Object with string properties

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.

    If the job has an 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. See Reading request headers.

    In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler; see request headers.

body

string

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.

See also

google.cloud.scheduler.v1beta1.AppEngineHttpTarget definition in proto format

AppEngineRouting

static

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.

Properties

Parameter

service

string

App service.

By default, the job is sent to the service which is the default service when the job is attempted.

version

string

App version.

By default, the job is sent to the version which is the default version when the job is attempted.

instance

string

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

string

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:

  • 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

  • version = version

  • version_dot_service = version + '.' + service

  • instance = instance

  • instance_dot_service = instance + '.' + service

  • instance_dot_version = instance + '.' + version

  • instance_dot_version_dot_service = instance + '.' + version + '.' + service

If service is empty, then the job will be sent to the service which is the default service when the job is attempted.

If version is empty, then the job will be sent to the version which is the default version when the job is attempted.

If instance is empty, then the job will be sent to an instance which is available when the job is attempted.

If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted.

See also

google.cloud.scheduler.v1beta1.AppEngineRouting definition in proto format

CreateJobRequest

static

Request message for CreateJob.

Properties

Parameter

parent

string

Required.

The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

job

Object

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.

This object should have the same structure as Job

See also

google.cloud.scheduler.v1beta1.CreateJobRequest definition in proto format

DeleteJobRequest

static

Request message for deleting a job using DeleteJob.

Property

Parameter

name

string

Required.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

See also

google.cloud.scheduler.v1beta1.DeleteJobRequest definition in proto format

GetJobRequest

static

Request message for GetJob.

Property

Parameter

name

string

Required.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

See also

google.cloud.scheduler.v1beta1.GetJobRequest definition in proto format

HttpTarget

static

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.

Properties

Parameter

uri

string

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.

httpMethod

number

Which HTTP method to use for the request.

The number should be among the values of HttpMethod

headers

Object with string properties

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.

body

string

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.

See also

google.cloud.scheduler.v1beta1.HttpTarget definition in proto format

Job

static

Configuration for a job. The maximum allowed size for a job is 100KB.

Properties

Parameter

name

string

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
  • LOCATION_ID is the canonical ID for the job's location. The list of available locations can be obtained by calling 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.

description

string

A human-readable description for the job. This string must not contain more than 500 characters.

pubsubTarget

Object

Pub/Sub target.

This object should have the same structure as PubsubTarget

appEngineHttpTarget

Object

App Engine HTTP target.

This object should have the same structure as AppEngineHttpTarget

httpTarget

Object

HTTP target.

This object should have the same structure as HttpTarget

schedule

string

Required.

Describes the schedule on which the job will be executed.

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+1th execution is scheduled to run at 16:00 but the nth execution takes until 16:15, the n+1th 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 > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.

The schedule can be either of the following types:

timeZone

string

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.

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

Object

Output only. The creation time of the job.

This object should have the same structure as Timestamp

state

number

Output only. State of the job.

The number should be among the values of State

status

Object

Output only. The response from the target for the last attempted execution.

This object should have the same structure as Status

scheduleTime

Object

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.

This object should have the same structure as Timestamp

lastAttemptTime

Object

Output only. The time the last job attempt started.

This object should have the same structure as Timestamp

retryConfig

Object

Settings that determine the retry behavior.

This object should have the same structure as RetryConfig

See also

google.cloud.scheduler.v1beta1.Job definition in proto format

ListJobsRequest

static

Request message for listing jobs using ListJobs.

Properties

Parameter

parent

string

Required.

The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

pageSize

number

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.

pageToken

string

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 returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages.

See also

google.cloud.scheduler.v1beta1.ListJobsRequest definition in proto format

ListJobsResponse

static

Response message for listing jobs using ListJobs.

Properties

Parameter

jobs

Array of Object

The list of jobs.

This object should have the same structure as Job

nextPageToken

string

A token to retrieve next page of results. Pass this value in the page_token field in the subsequent call to 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.

See also

google.cloud.scheduler.v1beta1.ListJobsResponse definition in proto format

PauseJobRequest

static

Request message for PauseJob.

Property

Parameter

name

string

Required.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

See also

google.cloud.scheduler.v1beta1.PauseJobRequest definition in proto format

PubsubTarget

static

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

Properties

Parameter

topicName

string

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, for example projects/PROJECT_ID/topics/TOPIC_ID.

The topic must be in the same project as the Cloud Scheduler job.

data

string

The message payload for PubsubMessage.

Pubsub message must contain either non-empty data, or at least one attribute.

attributes

Object with string properties

Attributes for PubsubMessage.

Pubsub message must contain either non-empty data, or at least one attribute.

See also

google.cloud.scheduler.v1beta1.PubsubTarget definition in proto format

ResumeJobRequest

static

Request message for ResumeJob.

Property

Parameter

name

string

Required.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

See also

google.cloud.scheduler.v1beta1.ResumeJobRequest definition in proto format

RetryConfig

static

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.

Properties

Parameter

retryCount

number

The number of attempts that the system will make to run a job using the exponential backoff procedure described by 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.

maxRetryDuration

Object

The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, 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.

This object should have the same structure as Duration

minBackoffDuration

Object

The minimum amount of time to wait before retrying a job after it fails.

The default value of this field is 5 seconds.

This object should have the same structure as Duration

maxBackoffDuration

Object

The maximum amount of time to wait before retrying a job after it fails.

The default value of this field is 1 hour.

This object should have the same structure as Duration

maxDoublings

number

The time between retries will double max_doublings times.

A job's retry interval starts at min_backoff_duration, then doubles max_doublings times, then increases linearly, and finally retries retries at intervals of max_backoff_duration up to retry_count times.

For example, if min_backoff_duration is 10s, 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 until the job has been attempted 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.

See also

google.cloud.scheduler.v1beta1.RetryConfig definition in proto format

RunJobRequest

static

Request message for forcing a job to run now using RunJob.

Property

Parameter

name

string

Required.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

See also

google.cloud.scheduler.v1beta1.RunJobRequest definition in proto format

UpdateJobRequest

static

Request message for UpdateJob.

Properties

Parameter

job

Object

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.

This object should have the same structure as Job

updateMask

Object

A mask used to specify which fields of the job are being updated.

This object should have the same structure as FieldMask

See also

google.cloud.scheduler.v1beta1.UpdateJobRequest definition in proto format