Package google.cloud.scheduler.v1beta1

Index

CloudScheduler

The Cloud Scheduler API allows external entities to reliably schedule asynchronous jobs.

CreateJob

rpc CreateJob(CreateJobRequest) returns (Job)

Creates a job.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-scheduler

For more information, see the Authentication Overview.
DeleteJob

rpc DeleteJob(DeleteJobRequest) returns (Empty)

Deletes a job.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-scheduler

For more information, see the Authentication Overview.
GetJob

rpc GetJob(GetJobRequest) returns (Job)

Gets a job.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-scheduler

For more information, see the Authentication Overview.
ListJobs

rpc ListJobs(ListJobsRequest) returns (ListJobsResponse)

Lists jobs.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-scheduler

For more information, see the Authentication Overview.
PauseJob

rpc PauseJob(PauseJobRequest) returns (Job)

Pauses a job.

If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-scheduler

For more information, see the Authentication Overview.
ResumeJob

rpc ResumeJob(ResumeJobRequest) returns (Job)

Resume a job.

This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-scheduler

For more information, see the Authentication Overview.
RunJob

rpc RunJob(RunJobRequest) returns (Job)

Forces a job to run now.

When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-scheduler

For more information, see the Authentication Overview.
UpdateJob

rpc UpdateJob(UpdateJobRequest) returns (Job)

Updates a job.

If successful, the updated Job is returned. If the job does not exist, NOT_FOUND is returned.

If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-scheduler

For more information, see the Authentication Overview.

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.

Fields
http_method

HttpMethod

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

AppEngineRouting

App Engine Routing setting for the job.
relative_uri

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

map<string, string>

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.
  • X-CloudScheduler-JobName: This header will contain the job name.
  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values:

  • Content-Type: This will be set to "application/octet-stream". You can override this default by explicitly setting Content-Type to a particular media type when creating the job. For example, you can set Content-Type to "application/json".

The headers below are output only. They cannot be set or overridden:

  • Content-Length: This is computed by Cloud Scheduler.
  • 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.
body

bytes

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, Microservices Architecture on Google App Engine, App Engine Standard request routing, and App Engine Flex request routing.

Fields
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.

CreateJobRequest

Request message for CreateJob.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • cloudscheduler.jobs.create
job

Job

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.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • cloudscheduler.jobs.delete
legacy_app_engine_cron

bool

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 in the __cron queue with the corresponding name will be deleted instead.

GetJobRequest

Request message for GetJob.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • cloudscheduler.jobs.get

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

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.

Fields
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.
http_method

HttpMethod

Which HTTP method to use for the request.
headers

map<string, string>

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:

  • 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.
  • X-CloudScheduler: This header will be set to true.
  • X-CloudScheduler-JobName: This header will contain the job name.
  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values:

  • Content-Type: This will be set to "application/octet-stream". You can override this default by explicitly setting Content-Type to a particular media type when creating the job. For example, you can set Content-Type to "application/json".

The total size of headers must be less than 80KB.
body

bytes

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.

Union field authorization_header. The mode for generating an Authorization header for HTTP requests.

If specified, all Authorization headers in the HttpTarget.headers field will be overridden. authorization_header can be only one of the following:
oauth_token

OAuthToken

If specified, an OAuth token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
oidc_token

OidcToken

If specified, an OIDC 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 1MB.

Fields
name

string

Optionally caller-specified in 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
  • 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

Optionally caller-specified in CreateJob or UpdateJob.

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

string

Required, except when used with UpdateJob.

Describes the schedule on which the job will be executed.

The schedule can be either of the following types:

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. If retry_count 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 retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
time_zone

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).
user_update_time

Timestamp

Output only. The creation time of the job.
state

State

Output only. State of the job.
status

Status

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

Timestamp

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.
last_attempt_time

Timestamp

Output only. The time the last job attempt started.
retry_config

RetryConfig

Settings that determine the retry behavior.
attempt_deadline

Duration

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 default and the allowed values depend on the type of target:

  • For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

  • For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds].

  • For Pub/Sub targets, this field is ignored.
legacy_app_engine_cron

bool

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 target. Required.

Delivery settings containing destination and parameters. target can be only one of the following:
pubsub_target

PubsubTarget

Pub/Sub target.
app_engine_http_target

AppEngineHttpTarget

App Engine HTTP target.
http_target

HttpTarget

HTTP target.

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.

ListJobsRequest

Request message for listing jobs using ListJobs.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • cloudscheduler.jobs.list
filter

string

filter can be used to specify a subset of jobs.

If filter equals target_config="HttpConfig", then the http target jobs are retrieved. If filter equals target_config="PubSubConfig", then the Pub/Sub target jobs are retrieved. If filter equals labels.foo=value1 labels.foo=value2 then only jobs which are labeled with foo=value1 AND foo=value2 will be returned.
page_size

int32

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.
page_token

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.
legacy_app_engine_cron

bool

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 jobs in the __cron queue will be listed instead.

ListJobsResponse

Response message for listing jobs using ListJobs.

Fields
jobs[]

Job

The list of jobs.
next_page_token

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.

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.

Fields
service_account_email

string

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

string

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.

Fields
service_account_email

string

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

string

Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.

PauseJobRequest

Request message for PauseJob.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • cloudscheduler.jobs.pause

PubsubTarget

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

Fields
topic_name

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 Pub/Sub'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

bytes

The message payload for PubsubMessage.

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

map<string, string>

Attributes for PubsubMessage.

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

ResumeJobRequest

Request message for ResumeJob.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • cloudscheduler.jobs.enable

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.

Fields
retry_count

int32

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 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 retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.

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.
max_retry_duration

Duration

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.
min_backoff_duration

Duration

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

The default value of this field is 5 seconds.
max_backoff_duration

Duration

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

The default value of this field is 1 hour.
max_doublings

int32

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 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 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.

RunJobRequest

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

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • cloudscheduler.jobs.run
legacy_app_engine_cron

bool

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 in the __cron queue with the corresponding name will be forced to run instead.

UpdateJobRequest

Request message for UpdateJob.

Fields
job

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.

Authorization requires the following IAM permission on the specified resource job:

  • cloudscheduler.jobs.update
update_mask

FieldMask

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