package google.cloud.scheduler.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
The Cloud Scheduler API allows external entities to reliably schedule asynchronous jobs.
rpc CreateJob (, )
cloudscheduler.proto:49Creates a job.
message
cloudscheduler.proto:169Request message for [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob].
string parent = 1
Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.
optional job = 2
Required. The job to add. The user can optionally specify a name for the job in [name][google.cloud.scheduler.v1beta1.Job.name]. [name][google.cloud.scheduler.v1beta1.Job.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][google.cloud.scheduler.v1beta1.Job.name]) in the response.
rpc DeleteJob (, )
cloudscheduler.proto:73Deletes a job.
message
cloudscheduler.proto:202Request message for deleting a job using [DeleteJob][google.cloud.scheduler.v1beta1.CloudScheduler.DeleteJob].
string name = 1
Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
rpc GetJob (, )
cloudscheduler.proto:42Gets a job.
message
cloudscheduler.proto:160Request message for [GetJob][google.cloud.scheduler.v1beta1.CloudScheduler.GetJob].
string name = 1
Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
rpc ListJobs (, )
cloudscheduler.proto:35Lists jobs.
message
cloudscheduler.proto:119Request message for listing jobs using [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs].
string parent = 1
Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.
int32 page_size = 5
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.
string page_token = 6
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.v1beta1.ListJobsResponse.next_page_token] returned from the previous call to [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. It is an error to switch the value of [filter][google.cloud.scheduler.v1beta1.ListJobsRequest.filter] or [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while iterating through pages.
message
cloudscheduler.proto:145Response message for listing jobs using [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs].
repeated jobs = 1
The list of jobs.
string next_page_token = 2
A token to retrieve next page of results. Pass this value in the [page_token][google.cloud.scheduler.v1beta1.ListJobsRequest.page_token] field in the subsequent call to [ListJobs][google.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.
rpc PauseJob (, )
cloudscheduler.proto:86Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. The state of the job is stored in [state][google.cloud.scheduler.v1beta1.Job.state]; if paused it will be set to [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. A job must be in [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED] to be paused.
message
cloudscheduler.proto:211Request message for [PauseJob][google.cloud.scheduler.v1beta1.CloudScheduler.PauseJob].
string name = 1
Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
rpc ResumeJob (, )
cloudscheduler.proto:99Resume a job. This method reenables a job after it has been [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. The state of a job is stored in [Job.state][google.cloud.scheduler.v1beta1.Job.state]; after calling this method it will be set to [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED]. A job must be in [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED] to be resumed.
message
cloudscheduler.proto:220Request message for [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob].
string name = 1
Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
rpc RunJob (, )
cloudscheduler.proto:110Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.
message
cloudscheduler.proto:230Request message for forcing a job to run now using [RunJob][google.cloud.scheduler.v1beta1.CloudScheduler.RunJob].
string name = 1
Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
rpc UpdateJob (, )
cloudscheduler.proto:65Updates a job. If successful, the updated [Job][google.cloud.scheduler.v1beta1.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][google.cloud.scheduler.v1beta1.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.
message
cloudscheduler.proto:187Request message for [UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob].
optional job = 1
Required. The new job properties. [name][google.cloud.scheduler.v1beta1.Job.name] must be specified. Output only fields cannot be modified using UpdateJob. Any value specified for an output only field will be ignored.
optional update_mask = 2
A mask used to specify which fields of the job are being updated.
message
target.proto:81App 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.
Used in:
HttpMethod http_method = 1
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
optional app_engine_routing = 2
App Engine Routing setting for the job.
string relative_uri = 3
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.
map<string, string> headers = 4
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][google.cloud.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. See [Reading request headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#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](https://cloud.google.comappengine/docs/standard/python/config/cron#securing_urls_for_cron).
bytes body = 5
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][google.cloud.scheduler.v1beta1.HttpMethod].
message
target.proto:174App 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).
Used in:
string service = 1
App service. By default, the job is sent to the service which is the default service when the job is attempted.
string version = 2
App version. By default, the job is sent to the version which is the default version when the job is attempted.
string instance = 3
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).
string host = 4
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]`</br> `| [service] + '.' + [application_domain_name]`</br> `| [version] + '.' + [application_domain_name]`</br> `| [version_dot_service]+ '.' + [application_domain_name]`</br> `| [instance] + '.' + [application_domain_name]`</br> `| [instance_dot_service] + '.' + [application_domain_name]`</br> `| [instance_dot_version] + '.' + [application_domain_name]`</br> `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` * `application_domain_name` = The domain name of the app, for example <app-id>.appspot.com, which is associated with the job's project ID. * `service =` [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] * `version =` [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] * `version_dot_service =` [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] `+ '.' +` [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] * `instance =` [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] * `instance_dot_service =` [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+ '.' +` [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] * `instance_dot_version =` [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+ '.' +` [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] * `instance_dot_version_dot_service =` [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+ '.' +` [version][google.cloud.scheduler.v1beta1.AppEngineRouting.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.scheduler.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.v1beta1.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.AppEngineRouting.service], [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version], or [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] is invalid, then the job will be sent to the default version of the default service when the job is attempted.
The HTTP method used to execute the job.
Used in: ,
HTTP_METHOD_UNSPECIFIED = 0
HTTP method unspecified. Defaults to POST.
POST = 1
HTTP POST
GET = 2
HTTP GET
HEAD = 3
HTTP HEAD
PUT = 4
HTTP PUT
DELETE = 5
HTTP DELETE
PATCH = 6
HTTP PATCH
OPTIONS = 7
HTTP OPTIONS
message
target.proto:35Http 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.
Used in:
string uri = 1
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][google.cloud.scheduler.v1beta1.HttpTarget.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 http_method = 2
Which HTTP method to use for the request.
map<string, string> headers = 3
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][google.cloud.scheduler.v1beta1.HttpTarget.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.
bytes body = 4
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][google.cloud.scheduler.v1beta1.HttpMethod].
message
job.proto:34Configuration for a job. The maximum allowed size for a job is 100KB.
Used as response type in: CloudScheduler.CreateJob, CloudScheduler.GetJob, CloudScheduler.PauseJob, CloudScheduler.ResumeJob, CloudScheduler.RunJob, CloudScheduler.UpdateJob
Used as field type in: , ,
string name = 1
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 [ListLocations][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.
string description = 2
A human-readable description for the job. This string must not contain more than 500 characters.
oneof target
Required. Delivery settings containing destination and parameters.
pubsub_target = 4
Pub/Sub target.
app_engine_http_target = 5
App Engine HTTP target.
http_target = 6
HTTP target.
string schedule = 20
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+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.scheduler.v1beta1.RetryConfig.retry_count] > 0 and a job attempt fails, the job will be tried a total of [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] times, with exponential backoff, until the next scheduled start time. 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)
string time_zone = 21
Specifies the time zone to be used in interpreting [schedule][google.cloud.scheduler.v1beta1.Job.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).
optional user_update_time = 9
Output only. The creation time of the job.
Job.State state = 10
Output only. State of the job.
optional status = 11
Output only. The response from the target for the last attempted execution.
optional schedule_time = 17
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.
optional last_attempt_time = 18
Output only. The time the last job attempt started.
optional retry_config = 19
Settings that determine the retry behavior.
State of the job.
Used in:
STATE_UNSPECIFIED = 0
Unspecified state.
ENABLED = 1
The job is executing normally.
PAUSED = 2
The job is paused by the user. It will not execute. A user can intentionally pause the job using [PauseJobRequest][google.cloud.scheduler.v1beta1.PauseJobRequest].
DISABLED = 3
The job is disabled by the system due to error. The user cannot directly set a job to be disabled.
UPDATE_FAILED = 4
The job state resulting from a failed [CloudScheduler.UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob] operation. To recover a job from this state, retry [CloudScheduler.UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob] until a successful response is received.
message
target.proto:142Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic.
Used in:
string topic_name = 1
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/reference/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.
bytes data = 3
The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
map<string, string> attributes = 4
Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
message
job.proto:152Settings 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][google.cloud.scheduler.v1beta1.RetryConfig].
Used in:
int32 retry_count = 1
The number of attempts that the system will make to run a job using the exponential backoff procedure described by [max_doublings][google.cloud.scheduler.v1beta1.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.
optional max_retry_duration = 2
The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.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.
optional min_backoff_duration = 3
The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
optional max_backoff_duration = 4
The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
int32 max_doublings = 5
The time between retries will double `max_doublings` times. A job's retry interval starts at [min_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.min_backoff_duration], then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration] up to [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] times. For example, if [min_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.min_backoff_duration] is 10s, [max_backoff_duration][google.cloud.scheduler.v1beta1.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.scheduler.v1beta1.RetryConfig.max_backoff_duration] until the job has been attempted [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.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.