As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Scheduler v1 API

class google.cloud.scheduler_v1.types.AppEngineHttpTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

Type

google.cloud.scheduler_v1.types.HttpMethod

app_engine_routing

App Engine Routing setting for the job.

Type

google.cloud.scheduler_v1.types.AppEngineRouting

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.

Type

str

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.

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

Type

MutableMapping[str, str]

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

Type

bytes

class HeadersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.scheduler_v1.types.AppEngineRouting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

Type

str

version

App version.

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

Type

str

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.

Type

str

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.AppEngineRouting.instance]

• instance_dot_service = [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] + '.' + [service][google.cloud.scheduler.v1.AppEngineRouting.service]

• instance_dot_version = [instance][google.cloud.scheduler.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.instance] is invalid, then the job will be sent to the default version of the default service when the job is attempted.

Type

str

class google.cloud.scheduler_v1.types.CreateJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

parent

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

Type

str

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.

Type

google.cloud.scheduler_v1.types.Job

class google.cloud.scheduler_v1.types.DeleteJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

Type

str

class google.cloud.scheduler_v1.types.GetJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

Type

str

class google.cloud.scheduler_v1.types.HttpMethod(value)

Bases: proto.enums.Enum

The HTTP method used to execute the job.

Values:

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

class google.cloud.scheduler_v1.types.HttpTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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.

Type

str

http_method

Which HTTP method to use for the request.

Type

google.cloud.scheduler_v1.types.HttpMethod

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.

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

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

Type

MutableMapping[str, str]

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

Type

bytes

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 generally only be used when calling Google APIs hosted on *.googleapis.com.

This field is a member of oneof authorization_header.

Type

google.cloud.scheduler_v1.types.OAuthToken

oidc_token

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.

This field is a member of oneof authorization_header.

Type

google.cloud.scheduler_v1.types.OidcToken

class HeadersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.scheduler_v1.types.Job(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for a job. The maximum allowed size for a job is 1MB.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

name

Optionally caller-specified in [CreateJob][google.cloud.scheduler.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 [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.

Type

str

description

Optionally caller-specified in [CreateJob][google.cloud.scheduler.v1.CloudScheduler.CreateJob] or [UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob].

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

Type

str

pubsub_target

Pub/Sub target.

This field is a member of oneof target.

Type

google.cloud.scheduler_v1.types.PubsubTarget

app_engine_http_target

App Engine HTTP target.

This field is a member of oneof target.

Type

google.cloud.scheduler_v1.types.AppEngineHttpTarget

http_target

HTTP target.

This field is a member of oneof target.

Type

google.cloud.scheduler_v1.types.HttpTarget

schedule

Required, except when used with [UpdateJob][google.cloud.scheduler.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.scheduler.v1.RetryConfig.retry_count] > 0 and a job attempt fails, the job will be tried a total of [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count] times, with exponential backoff, until the next scheduled start time.

Type

str

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

Type

str

user_update_time

Output only. The creation time of the job.

Type

google.protobuf.timestamp_pb2.Timestamp

state

Output only. State of the job.

Type

google.cloud.scheduler_v1.types.Job.State

status

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

Type

google.rpc.status_pb2.Status

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.

Type

google.protobuf.timestamp_pb2.Timestamp

last_attempt_time

Output only. The time the last job attempt started.

Type

google.protobuf.timestamp_pb2.Timestamp

retry_config

Settings that determine the retry behavior.

Type

google.cloud.scheduler_v1.types.RetryConfig

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

• For [HTTP targets][google.cloud.scheduler.v1.Job.http_target], the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

• For [App Engine HTTP targets][google.cloud.scheduler.v1.Job.app_engine_http_target], 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][google.cloud.scheduler.v1.Job.pubsub_target], this field is ignored.

Type

google.protobuf.duration_pb2.Duration

class State(value)

Bases: proto.enums.Enum

State of the job.

Values:

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.v1.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.v1.CloudScheduler.UpdateJob] operation. To recover a job from this state, retry [CloudScheduler.UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob] until a successful response is received.

class google.cloud.scheduler_v1.types.ListJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

Type

str

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.

Type

int

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.ListJobsResponse.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_by] while iterating through pages.

Type

str

class google.cloud.scheduler_v1.types.ListJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

jobs

The list of jobs.

Type

MutableSequence[google.cloud.scheduler_v1.types.Job]

next_page_token

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

Type

str

class google.cloud.scheduler_v1.types.OAuthToken(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

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.

Type

str

scope

OAuth scope to be used for generating OAuth access token. If not specified, “https://www.googleapis.com/auth/cloud-platform” will be used.

Type

str

class google.cloud.scheduler_v1.types.OidcToken(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

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.

Type

str

audience

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

Type

str

class google.cloud.scheduler_v1.types.PauseJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

Type

str

class google.cloud.scheduler_v1.types.PubsubTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

Type

str

data

The message payload for PubsubMessage.

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

Type

bytes

attributes

Attributes for PubsubMessage.

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

Type

MutableMapping[str, str]

class AttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.scheduler_v1.types.ResumeJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

Type

str

class google.cloud.scheduler_v1.types.RetryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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_doublings][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.

Type

int

max_retry_duration

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

Type

google.protobuf.duration_pb2.Duration

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.

Type

google.protobuf.duration_pb2.Duration

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.

Type

google.protobuf.duration_pb2.Duration

max_doublings

The time between retries will double max_doublings times.

A job’s retry interval starts at [min_backoff_duration][google.cloud.scheduler.v1.RetryConfig.min_backoff_duration], then doubles max_doublings times, then increases linearly, and finally retries at intervals of [max_backoff_duration][google.cloud.scheduler.v1.RetryConfig.max_backoff_duration] up to [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count] times.

For example, if [min_backoff_duration][google.cloud.scheduler.v1.RetryConfig.min_backoff_duration] is 10s, [max_backoff_duration][google.cloud.scheduler.v1.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.v1.RetryConfig.max_backoff_duration] until the job has been attempted [retry_count][google.cloud.scheduler.v1.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.

Type

int

class google.cloud.scheduler_v1.types.RunJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

Type

str

class google.cloud.scheduler_v1.types.UpdateJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

Type

google.cloud.scheduler_v1.types.Job

update_mask

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

Type

google.protobuf.field_mask_pb2.FieldMask