Types for Cloud Scheduler API Client#

class google.cloud.scheduler_v1.types.Any#
type_url#

Field google.protobuf.Any.type_url

value#

Field google.protobuf.Any.value

class google.cloud.scheduler_v1.types.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.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.

http_method#

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

app_engine_routing#

App Engine Routing setting for the job.

relative_uri#

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#

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. If the job has an [body][google.cloud.scheduler.v1.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. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.

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 [HttpMethod][google.cloud.scheduler.v1.HttpMethod].

class HeadersEntry#
key#

Field google.cloud.scheduler.v1.AppEngineHttpTarget.HeadersEntry.key

value#

Field google.cloud.scheduler.v1.AppEngineHttpTarget.HeadersEntry.value

app_engine_routing

Field google.cloud.scheduler.v1.AppEngineHttpTarget.app_engine_routing

body

Field google.cloud.scheduler.v1.AppEngineHttpTarget.body

headers

Field google.cloud.scheduler.v1.AppEngineHttpTarget.headers

http_method

Field google.cloud.scheduler.v1.AppEngineHttpTarget.http_method

relative_uri

Field google.cloud.scheduler.v1.AppEngineHttpTarget.relative_uri

class google.cloud.scheduler_v1.types.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.

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: - 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][google.cloud.scheduler.v1.AppEngineRouting.service] - version = [version][google.cloud.scheduler.v1.AppEngineRouting.version] - version_dot_service = [version][google.cloud.scheduler.v1.AppEngineRouting.version] + '.' + [service][google.cloud.scheduler.v1.AppEngineRouting.service] - instance = [instance][google.cloud.scheduler.v1.AppE ngineRouting.instance] - instance_dot_service = [inst ance][google.cloud.scheduler.v1.AppEngineRouting.instance] + '.' + [service][google.cloud.scheduler.v1.AppEngineRouting.service] - instance_dot_version = [instance][google.cloud.sched uler.v1.AppEngineRouting.instance] + '.' + [version][google.cloud.scheduler.v1.AppEngineRouting.version] - instance_dot_version_dot_service = [instance][google .cloud.scheduler.v1.AppEngineRouting.instance] + '.' + [version][google.cloud.scheduler.v1.AppEngineRouting.version] + '.' + [service][google.cloud.scheduler.v1.AppEngineRouting.service] If [service][google.cloud.scheduler.v1.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.v1.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.v1.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.v1.AppEngineRouting.service], [version][google.cloud.scheduler.v1.AppEngineRouting.version], or [instance][google.cloud.scheduler.v1.AppEngineRouting.insta nce] is invalid, then the job will be sent to the default version of the default service when the job is attempted.

host

Field google.cloud.scheduler.v1.AppEngineRouting.host

instance

Field google.cloud.scheduler.v1.AppEngineRouting.instance

service

Field google.cloud.scheduler.v1.AppEngineRouting.service

version

Field google.cloud.scheduler.v1.AppEngineRouting.version

class google.cloud.scheduler_v1.types.CreateJobRequest#

Request message for [CreateJob][google.cloud.scheduler.v1.CloudScheduler.CreateJob].

parent#

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

job#

Required. The job to add. The user can optionally specify a name for the job in [name][google.cloud.scheduler.v1.Job.name]. [name][google.cloud.scheduler.v1.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.v1.Job.name]) in the response.

job

Field google.cloud.scheduler.v1.CreateJobRequest.job

parent

Field google.cloud.scheduler.v1.CreateJobRequest.parent

class google.cloud.scheduler_v1.types.DeleteJobRequest#

Request message for deleting a job using [DeleteJob][google.cloud.scheduler.v1.CloudScheduler.DeleteJob].

name#

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

name

Field google.cloud.scheduler.v1.DeleteJobRequest.name

class google.cloud.scheduler_v1.types.Duration#
nanos#

Field google.protobuf.Duration.nanos

seconds#

Field google.protobuf.Duration.seconds

class google.cloud.scheduler_v1.types.Empty#
class google.cloud.scheduler_v1.types.FieldMask#
paths#

Field google.protobuf.FieldMask.paths

class google.cloud.scheduler_v1.types.GetJobRequest#

Request message for [GetJob][google.cloud.scheduler.v1.CloudScheduler.GetJob].

name#

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

name

Field google.cloud.scheduler.v1.GetJobRequest.name

class google.cloud.scheduler_v1.types.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.

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][google.cloud.scheduler.v1.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.

http_method#

Which HTTP method to use for the request.

headers#

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

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 [HttpMethod][google.cloud.scheduler.v1.HttpMethod].

authorization_header#

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.

oauth_token#

If specified, an OAuth token will be generated and attached as an Authorization header in the HTTP request. This type of authorization should be used when sending requests to a GCP endpoint.

oidc_token#

If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request. This type of authorization should be used when sending requests to third party endpoints or Cloud Run.

class HeadersEntry#
key#

Field google.cloud.scheduler.v1.HttpTarget.HeadersEntry.key

value#

Field google.cloud.scheduler.v1.HttpTarget.HeadersEntry.value

body

Field google.cloud.scheduler.v1.HttpTarget.body

headers

Field google.cloud.scheduler.v1.HttpTarget.headers

http_method

Field google.cloud.scheduler.v1.HttpTarget.http_method

oauth_token

Field google.cloud.scheduler.v1.HttpTarget.oauth_token

oidc_token

Field google.cloud.scheduler.v1.HttpTarget.oidc_token

uri

Field google.cloud.scheduler.v1.HttpTarget.uri

class google.cloud.scheduler_v1.types.Job#

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

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

description#

Optionally caller-specified in [CreateJob][google.cloud.schedu ler.v1.CloudScheduler.CreateJob] or [UpdateJob][google.cloud.s cheduler.v1.CloudScheduler.UpdateJob]. A human-readable description for the job. This string must not contain more than 500 characters.

target#

Required. Delivery settings containing destination and parameters.

pubsub_target#

Pub/Sub target.

app_engine_http_target#

App Engine HTTP target.

http_target#

HTTP target.

schedule#

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 - English- like schedule 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][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.

time_zone#

Specifies the time zone to be used in interpreting [schedule][google.cloud.scheduler.v1.Job.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#

Output only. The creation time of the job.

state#

Output only. State of the job.

status#

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

schedule_time#

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#

Output only. The time the last job attempt started.

retry_config#

Settings that determine the retry behavior.

attempt_deadline#

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][google.cloud.scheduler.v1.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.

app_engine_http_target

Field google.cloud.scheduler.v1.Job.app_engine_http_target

attempt_deadline

Field google.cloud.scheduler.v1.Job.attempt_deadline

description

Field google.cloud.scheduler.v1.Job.description

http_target

Field google.cloud.scheduler.v1.Job.http_target

last_attempt_time

Field google.cloud.scheduler.v1.Job.last_attempt_time

name

Field google.cloud.scheduler.v1.Job.name

pubsub_target

Field google.cloud.scheduler.v1.Job.pubsub_target

retry_config

Field google.cloud.scheduler.v1.Job.retry_config

schedule

Field google.cloud.scheduler.v1.Job.schedule

schedule_time

Field google.cloud.scheduler.v1.Job.schedule_time

state

Field google.cloud.scheduler.v1.Job.state

status

Field google.cloud.scheduler.v1.Job.status

time_zone

Field google.cloud.scheduler.v1.Job.time_zone

user_update_time

Field google.cloud.scheduler.v1.Job.user_update_time

class google.cloud.scheduler_v1.types.ListJobsRequest#

Request message for listing jobs using [ListJobs][google.cloud.scheduler.v1.CloudScheduler.ListJobs].

parent#

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

page_size#

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#

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][google.cloud.scheduler.v1.CloudScheduler.ListJobs]. It is an error to switch the value of [filter][google.cloud.scheduler.v1.ListJobsRequest.filter] or [order_by][google.cloud.scheduler.v1.ListJobsRequest.order_b y] while iterating through pages.

page_size

Field google.cloud.scheduler.v1.ListJobsRequest.page_size

page_token

Field google.cloud.scheduler.v1.ListJobsRequest.page_token

parent

Field google.cloud.scheduler.v1.ListJobsRequest.parent

class google.cloud.scheduler_v1.types.ListJobsResponse#

Response message for listing jobs using [ListJobs][google.cloud.scheduler.v1.CloudScheduler.ListJobs].

jobs#

The list of jobs.

next_page_token#

A token to retrieve next page of results. Pass this value in the [page_token][google.cloud.scheduler.v1.ListJobsRequest.pa ge_token] field in the subsequent call to [ListJobs][google.cloud.scheduler.v1.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.

jobs

Field google.cloud.scheduler.v1.ListJobsResponse.jobs

next_page_token

Field google.cloud.scheduler.v1.ListJobsResponse.next_page_token

class google.cloud.scheduler_v1.types.OAuthToken#

Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint.

service_account_email#

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.

scope

Field google.cloud.scheduler.v1.OAuthToken.scope

service_account_email

Field google.cloud.scheduler.v1.OAuthToken.service_account_email

class google.cloud.scheduler_v1.types.OidcToken#

Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run.

service_account_email#

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.

audience

Field google.cloud.scheduler.v1.OidcToken.audience

service_account_email

Field google.cloud.scheduler.v1.OidcToken.service_account_email

class google.cloud.scheduler_v1.types.PauseJobRequest#

Request message for [PauseJob][google.cloud.scheduler.v1.CloudScheduler.PauseJob].

name#

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

name

Field google.cloud.scheduler.v1.PauseJobRequest.name

class google.cloud.scheduler_v1.types.PubsubTarget#

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

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

attributes#

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

class AttributesEntry#
key#

Field google.cloud.scheduler.v1.PubsubTarget.AttributesEntry.key

value#

Field google.cloud.scheduler.v1.PubsubTarget.AttributesEntry.value

attributes

Field google.cloud.scheduler.v1.PubsubTarget.attributes

data

Field google.cloud.scheduler.v1.PubsubTarget.data

topic_name

Field google.cloud.scheduler.v1.PubsubTarget.topic_name

class google.cloud.scheduler_v1.types.ResumeJobRequest#

Request message for [ResumeJob][google.cloud.scheduler.v1.CloudScheduler.ResumeJob].

name#

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

name

Field google.cloud.scheduler.v1.ResumeJobRequest.name

class google.cloud.scheduler_v1.types.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][google.cloud.scheduler.v1.RetryConfig].

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.

max_retry_duration#

The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with [retr y_count][google.cloud.scheduler.v1.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.

min_backoff_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#

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#

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.

max_backoff_duration

Field google.cloud.scheduler.v1.RetryConfig.max_backoff_duration

max_doublings

Field google.cloud.scheduler.v1.RetryConfig.max_doublings

max_retry_duration

Field google.cloud.scheduler.v1.RetryConfig.max_retry_duration

min_backoff_duration

Field google.cloud.scheduler.v1.RetryConfig.min_backoff_duration

retry_count

Field google.cloud.scheduler.v1.RetryConfig.retry_count

class google.cloud.scheduler_v1.types.RunJobRequest#

Request message for forcing a job to run now using [RunJob][google.cloud.scheduler.v1.CloudScheduler.RunJob].

name#

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

name

Field google.cloud.scheduler.v1.RunJobRequest.name

class google.cloud.scheduler_v1.types.Status#
code#

Field google.rpc.Status.code

details#

Field google.rpc.Status.details

message#

Field google.rpc.Status.message

class google.cloud.scheduler_v1.types.Timestamp#
nanos#

Field google.protobuf.Timestamp.nanos

seconds#

Field google.protobuf.Timestamp.seconds

class google.cloud.scheduler_v1.types.UpdateJobRequest#

Request message for [UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob].

job#

Required. The new job properties. [name][google.cloud.scheduler.v1.Job.name] must be specified. Output only fields cannot be modified using UpdateJob. Any value specified for an output only field will be ignored.

update_mask#

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

job

Field google.cloud.scheduler.v1.UpdateJobRequest.job

update_mask

Field google.cloud.scheduler.v1.UpdateJobRequest.update_mask