docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html b/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html
index 485de52..6099625 100644
--- a/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html
+++ b/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html
@@ -114,15 +114,6 @@
{ # Configuration for a job.
# The maximum allowed size for a job is 100KB.
- "timeZone": "A 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](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).
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
@@ -137,19 +128,6 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
- "body": "A String", # Body.
- #
- # HTTP request body. A request body is allowed only if the HTTP method is
- # POST or PUT. It will result in invalid argument error to set a body on a
- # job with an incompatible HttpMethod.
- "relativeUri": "A 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": { # HTTP request headers.
#
# This map contains the header field names and values. Headers can be set
@@ -195,6 +173,23 @@
# 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).
+ "service": "A String", # App service.
+ #
+ # By default, the job is sent to the service which is the default
+ # service when the job is attempted.
+ "instance": "A 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](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).
"version": "A String", # App version.
#
# By default, the job is sent to the version which is the default
@@ -257,24 +252,20 @@
# version, or
# instance is invalid, then the job will be sent
# to the default version of the default service when the job is attempted.
- "service": "A String", # App service.
- #
- # By default, the job is sent to the service which is the default
- # service when the job is attempted.
- "instance": "A 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](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).
},
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
+ "body": "A String", # Body.
+ #
+ # HTTP request body. A request body is allowed only if the HTTP method is
+ # POST or PUT. It will result in invalid argument error to set a body on a
+ # job with an incompatible HttpMethod.
+ "relativeUri": "A 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.
},
"status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution.
# different programming environments, including REST APIs and RPC APIs. It is
@@ -283,7 +274,6 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -293,12 +283,40 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
"retryConfig": { # Settings that determine the retry behavior. # 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.
+ "maxDoublings": 42, # 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 a job will first be retried in 10s. The
+ # retry interval will double three times, and then increase linearly by
+ # 2^3 * 10s. Finally, the job will retry at intervals of
+ # max_backoff_duration until the job has
+ # been attempted retry_count times. Thus, the
+ # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
+ #
+ # The default value of this field is 5.
+ "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 5 seconds.
+ "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 1 hour.
"maxRetryDuration": "A String", # 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
@@ -322,33 +340,6 @@
# whichever comes first.
#
# Values greater than 5 and negative values are not allowed.
- "maxDoublings": 42, # 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 a job will first be retried in 10s. The
- # retry interval will double three times, and then increase linearly by
- # 2^3 * 10s. Finally, the job will retry at intervals of
- # max_backoff_duration until the job has
- # been attempted retry_count times. Thus, the
- # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
- #
- # The default value of this field is 5.
- "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 1 hour.
- "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 5 seconds.
},
"state": "A String", # Output only. State of the job.
"name": "A String", # Optionally caller-specified in CreateJob, after
@@ -372,6 +363,7 @@
"scheduleTime": "A String", # 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.
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -395,7 +387,6 @@
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
"attemptDeadline": "A String", # 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
@@ -406,40 +397,32 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
+ "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
+ # the given Pub/Sub topic.
+ "attributes": { # Attributes for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ "a_key": "A String",
+ },
+ "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
+ # be published when a job is delivered. The topic name must be in the
+ # same format as required by PubSub's
+ # [PublishRequest.name](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.
+ "data": "A String", # The message payload for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ },
"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.
# 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.
- "httpMethod": "A String", # Which HTTP method to use for the request.
- "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
- # method is POST, PUT, or PATCH. It is an error to set body on a job with an
- # incompatible HttpMethod.
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # 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.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # 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.
- },
- "uri": "A 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.
"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
@@ -477,27 +460,44 @@
# The service account must be within the same project as the job. The caller
# must have iam.serviceAccounts.actAs permission for the service account.
},
- },
- "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
- # the given Pub/Sub topic.
- "attributes": { # Attributes for PubsubMessage.
+ "httpMethod": "A String", # Which HTTP method to use for the request.
+ "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
+ # method is POST, PUT, or PATCH. It is an error to set body on a job with an
+ # incompatible HttpMethod.
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
#
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
- "a_key": "A String",
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # 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": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
},
- "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
- # be published when a job is delivered. The topic name must be in the
- # same format as required by PubSub's
- # [PublishRequest.name](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.
- "data": "A String", # The message payload for PubsubMessage.
- #
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
+ "uri": "A 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.
},
+ "timeZone": "A 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](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).
}
x__xgafv: string, V1 error format.
@@ -510,15 +510,6 @@
{ # Configuration for a job.
# The maximum allowed size for a job is 100KB.
- "timeZone": "A 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](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).
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
@@ -533,19 +524,6 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
- "body": "A String", # Body.
- #
- # HTTP request body. A request body is allowed only if the HTTP method is
- # POST or PUT. It will result in invalid argument error to set a body on a
- # job with an incompatible HttpMethod.
- "relativeUri": "A 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": { # HTTP request headers.
#
# This map contains the header field names and values. Headers can be set
@@ -591,6 +569,23 @@
# 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).
+ "service": "A String", # App service.
+ #
+ # By default, the job is sent to the service which is the default
+ # service when the job is attempted.
+ "instance": "A 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](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).
"version": "A String", # App version.
#
# By default, the job is sent to the version which is the default
@@ -653,24 +648,20 @@
# version, or
# instance is invalid, then the job will be sent
# to the default version of the default service when the job is attempted.
- "service": "A String", # App service.
- #
- # By default, the job is sent to the service which is the default
- # service when the job is attempted.
- "instance": "A 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](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).
},
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
+ "body": "A String", # Body.
+ #
+ # HTTP request body. A request body is allowed only if the HTTP method is
+ # POST or PUT. It will result in invalid argument error to set a body on a
+ # job with an incompatible HttpMethod.
+ "relativeUri": "A 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.
},
"status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution.
# different programming environments, including REST APIs and RPC APIs. It is
@@ -679,7 +670,6 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -689,12 +679,40 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
"retryConfig": { # Settings that determine the retry behavior. # 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.
+ "maxDoublings": 42, # 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 a job will first be retried in 10s. The
+ # retry interval will double three times, and then increase linearly by
+ # 2^3 * 10s. Finally, the job will retry at intervals of
+ # max_backoff_duration until the job has
+ # been attempted retry_count times. Thus, the
+ # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
+ #
+ # The default value of this field is 5.
+ "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 5 seconds.
+ "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 1 hour.
"maxRetryDuration": "A String", # 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
@@ -718,33 +736,6 @@
# whichever comes first.
#
# Values greater than 5 and negative values are not allowed.
- "maxDoublings": 42, # 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 a job will first be retried in 10s. The
- # retry interval will double three times, and then increase linearly by
- # 2^3 * 10s. Finally, the job will retry at intervals of
- # max_backoff_duration until the job has
- # been attempted retry_count times. Thus, the
- # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
- #
- # The default value of this field is 5.
- "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 1 hour.
- "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 5 seconds.
},
"state": "A String", # Output only. State of the job.
"name": "A String", # Optionally caller-specified in CreateJob, after
@@ -768,6 +759,7 @@
"scheduleTime": "A String", # 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.
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -791,7 +783,6 @@
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
"attemptDeadline": "A String", # 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
@@ -802,40 +793,32 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
+ "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
+ # the given Pub/Sub topic.
+ "attributes": { # Attributes for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ "a_key": "A String",
+ },
+ "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
+ # be published when a job is delivered. The topic name must be in the
+ # same format as required by PubSub's
+ # [PublishRequest.name](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.
+ "data": "A String", # The message payload for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ },
"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.
# 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.
- "httpMethod": "A String", # Which HTTP method to use for the request.
- "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
- # method is POST, PUT, or PATCH. It is an error to set body on a job with an
- # incompatible HttpMethod.
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # 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.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # 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.
- },
- "uri": "A 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.
"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
@@ -873,27 +856,44 @@
# The service account must be within the same project as the job. The caller
# must have iam.serviceAccounts.actAs permission for the service account.
},
- },
- "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
- # the given Pub/Sub topic.
- "attributes": { # Attributes for PubsubMessage.
+ "httpMethod": "A String", # Which HTTP method to use for the request.
+ "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
+ # method is POST, PUT, or PATCH. It is an error to set body on a job with an
+ # incompatible HttpMethod.
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
#
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
- "a_key": "A String",
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # 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": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
},
- "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
- # be published when a job is delivered. The topic name must be in the
- # same format as required by PubSub's
- # [PublishRequest.name](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.
- "data": "A String", # The message payload for PubsubMessage.
- #
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
+ "uri": "A 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.
},
+ "timeZone": "A 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](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).
}</pre>
</div>
@@ -941,15 +941,6 @@
{ # Configuration for a job.
# The maximum allowed size for a job is 100KB.
- "timeZone": "A 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](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).
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
@@ -964,19 +955,6 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
- "body": "A String", # Body.
- #
- # HTTP request body. A request body is allowed only if the HTTP method is
- # POST or PUT. It will result in invalid argument error to set a body on a
- # job with an incompatible HttpMethod.
- "relativeUri": "A 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": { # HTTP request headers.
#
# This map contains the header field names and values. Headers can be set
@@ -1022,6 +1000,23 @@
# 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).
+ "service": "A String", # App service.
+ #
+ # By default, the job is sent to the service which is the default
+ # service when the job is attempted.
+ "instance": "A 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](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).
"version": "A String", # App version.
#
# By default, the job is sent to the version which is the default
@@ -1084,24 +1079,20 @@
# version, or
# instance is invalid, then the job will be sent
# to the default version of the default service when the job is attempted.
- "service": "A String", # App service.
- #
- # By default, the job is sent to the service which is the default
- # service when the job is attempted.
- "instance": "A 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](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).
},
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
+ "body": "A String", # Body.
+ #
+ # HTTP request body. A request body is allowed only if the HTTP method is
+ # POST or PUT. It will result in invalid argument error to set a body on a
+ # job with an incompatible HttpMethod.
+ "relativeUri": "A 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.
},
"status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution.
# different programming environments, including REST APIs and RPC APIs. It is
@@ -1110,7 +1101,6 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -1120,12 +1110,40 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
"retryConfig": { # Settings that determine the retry behavior. # 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.
+ "maxDoublings": 42, # 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 a job will first be retried in 10s. The
+ # retry interval will double three times, and then increase linearly by
+ # 2^3 * 10s. Finally, the job will retry at intervals of
+ # max_backoff_duration until the job has
+ # been attempted retry_count times. Thus, the
+ # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
+ #
+ # The default value of this field is 5.
+ "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 5 seconds.
+ "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 1 hour.
"maxRetryDuration": "A String", # 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
@@ -1149,33 +1167,6 @@
# whichever comes first.
#
# Values greater than 5 and negative values are not allowed.
- "maxDoublings": 42, # 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 a job will first be retried in 10s. The
- # retry interval will double three times, and then increase linearly by
- # 2^3 * 10s. Finally, the job will retry at intervals of
- # max_backoff_duration until the job has
- # been attempted retry_count times. Thus, the
- # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
- #
- # The default value of this field is 5.
- "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 1 hour.
- "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 5 seconds.
},
"state": "A String", # Output only. State of the job.
"name": "A String", # Optionally caller-specified in CreateJob, after
@@ -1199,6 +1190,7 @@
"scheduleTime": "A String", # 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.
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -1222,7 +1214,6 @@
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
"attemptDeadline": "A String", # 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
@@ -1233,40 +1224,32 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
+ "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
+ # the given Pub/Sub topic.
+ "attributes": { # Attributes for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ "a_key": "A String",
+ },
+ "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
+ # be published when a job is delivered. The topic name must be in the
+ # same format as required by PubSub's
+ # [PublishRequest.name](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.
+ "data": "A String", # The message payload for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ },
"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.
# 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.
- "httpMethod": "A String", # Which HTTP method to use for the request.
- "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
- # method is POST, PUT, or PATCH. It is an error to set body on a job with an
- # incompatible HttpMethod.
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # 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.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # 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.
- },
- "uri": "A 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.
"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
@@ -1304,27 +1287,44 @@
# The service account must be within the same project as the job. The caller
# must have iam.serviceAccounts.actAs permission for the service account.
},
- },
- "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
- # the given Pub/Sub topic.
- "attributes": { # Attributes for PubsubMessage.
+ "httpMethod": "A String", # Which HTTP method to use for the request.
+ "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
+ # method is POST, PUT, or PATCH. It is an error to set body on a job with an
+ # incompatible HttpMethod.
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
#
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
- "a_key": "A String",
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # 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": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
},
- "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
- # be published when a job is delivered. The topic name must be in the
- # same format as required by PubSub's
- # [PublishRequest.name](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.
- "data": "A String", # The message payload for PubsubMessage.
- #
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
+ "uri": "A 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.
},
+ "timeZone": "A 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](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).
}</pre>
</div>
@@ -1360,15 +1360,6 @@
"jobs": [ # The list of jobs.
{ # Configuration for a job.
# The maximum allowed size for a job is 100KB.
- "timeZone": "A 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](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).
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
@@ -1383,19 +1374,6 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
- "body": "A String", # Body.
- #
- # HTTP request body. A request body is allowed only if the HTTP method is
- # POST or PUT. It will result in invalid argument error to set a body on a
- # job with an incompatible HttpMethod.
- "relativeUri": "A 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": { # HTTP request headers.
#
# This map contains the header field names and values. Headers can be set
@@ -1441,6 +1419,23 @@
# 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).
+ "service": "A String", # App service.
+ #
+ # By default, the job is sent to the service which is the default
+ # service when the job is attempted.
+ "instance": "A 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](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).
"version": "A String", # App version.
#
# By default, the job is sent to the version which is the default
@@ -1503,24 +1498,20 @@
# version, or
# instance is invalid, then the job will be sent
# to the default version of the default service when the job is attempted.
- "service": "A String", # App service.
- #
- # By default, the job is sent to the service which is the default
- # service when the job is attempted.
- "instance": "A 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](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).
},
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
+ "body": "A String", # Body.
+ #
+ # HTTP request body. A request body is allowed only if the HTTP method is
+ # POST or PUT. It will result in invalid argument error to set a body on a
+ # job with an incompatible HttpMethod.
+ "relativeUri": "A 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.
},
"status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution.
# different programming environments, including REST APIs and RPC APIs. It is
@@ -1529,7 +1520,6 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -1539,12 +1529,40 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
"retryConfig": { # Settings that determine the retry behavior. # 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.
+ "maxDoublings": 42, # 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 a job will first be retried in 10s. The
+ # retry interval will double three times, and then increase linearly by
+ # 2^3 * 10s. Finally, the job will retry at intervals of
+ # max_backoff_duration until the job has
+ # been attempted retry_count times. Thus, the
+ # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
+ #
+ # The default value of this field is 5.
+ "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 5 seconds.
+ "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 1 hour.
"maxRetryDuration": "A String", # 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
@@ -1568,33 +1586,6 @@
# whichever comes first.
#
# Values greater than 5 and negative values are not allowed.
- "maxDoublings": 42, # 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 a job will first be retried in 10s. The
- # retry interval will double three times, and then increase linearly by
- # 2^3 * 10s. Finally, the job will retry at intervals of
- # max_backoff_duration until the job has
- # been attempted retry_count times. Thus, the
- # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
- #
- # The default value of this field is 5.
- "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 1 hour.
- "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 5 seconds.
},
"state": "A String", # Output only. State of the job.
"name": "A String", # Optionally caller-specified in CreateJob, after
@@ -1618,6 +1609,7 @@
"scheduleTime": "A String", # 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.
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -1641,7 +1633,6 @@
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
"attemptDeadline": "A String", # 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
@@ -1652,40 +1643,32 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
+ "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
+ # the given Pub/Sub topic.
+ "attributes": { # Attributes for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ "a_key": "A String",
+ },
+ "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
+ # be published when a job is delivered. The topic name must be in the
+ # same format as required by PubSub's
+ # [PublishRequest.name](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.
+ "data": "A String", # The message payload for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ },
"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.
# 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.
- "httpMethod": "A String", # Which HTTP method to use for the request.
- "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
- # method is POST, PUT, or PATCH. It is an error to set body on a job with an
- # incompatible HttpMethod.
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # 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.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # 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.
- },
- "uri": "A 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.
"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
@@ -1723,27 +1706,44 @@
# The service account must be within the same project as the job. The caller
# must have iam.serviceAccounts.actAs permission for the service account.
},
- },
- "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
- # the given Pub/Sub topic.
- "attributes": { # Attributes for PubsubMessage.
+ "httpMethod": "A String", # Which HTTP method to use for the request.
+ "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
+ # method is POST, PUT, or PATCH. It is an error to set body on a job with an
+ # incompatible HttpMethod.
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
#
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
- "a_key": "A String",
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # 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": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
},
- "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
- # be published when a job is delivered. The topic name must be in the
- # same format as required by PubSub's
- # [PublishRequest.name](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.
- "data": "A String", # The message payload for PubsubMessage.
- #
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
+ "uri": "A 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.
},
+ "timeZone": "A 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](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).
},
],
"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the
@@ -1805,15 +1805,6 @@
{ # Configuration for a job.
# The maximum allowed size for a job is 100KB.
- "timeZone": "A 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](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).
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
@@ -1828,19 +1819,6 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
- "body": "A String", # Body.
- #
- # HTTP request body. A request body is allowed only if the HTTP method is
- # POST or PUT. It will result in invalid argument error to set a body on a
- # job with an incompatible HttpMethod.
- "relativeUri": "A 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": { # HTTP request headers.
#
# This map contains the header field names and values. Headers can be set
@@ -1886,6 +1864,23 @@
# 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).
+ "service": "A String", # App service.
+ #
+ # By default, the job is sent to the service which is the default
+ # service when the job is attempted.
+ "instance": "A 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](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).
"version": "A String", # App version.
#
# By default, the job is sent to the version which is the default
@@ -1948,24 +1943,20 @@
# version, or
# instance is invalid, then the job will be sent
# to the default version of the default service when the job is attempted.
- "service": "A String", # App service.
- #
- # By default, the job is sent to the service which is the default
- # service when the job is attempted.
- "instance": "A 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](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).
},
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
+ "body": "A String", # Body.
+ #
+ # HTTP request body. A request body is allowed only if the HTTP method is
+ # POST or PUT. It will result in invalid argument error to set a body on a
+ # job with an incompatible HttpMethod.
+ "relativeUri": "A 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.
},
"status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution.
# different programming environments, including REST APIs and RPC APIs. It is
@@ -1974,7 +1965,6 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -1984,12 +1974,40 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
"retryConfig": { # Settings that determine the retry behavior. # 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.
+ "maxDoublings": 42, # 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 a job will first be retried in 10s. The
+ # retry interval will double three times, and then increase linearly by
+ # 2^3 * 10s. Finally, the job will retry at intervals of
+ # max_backoff_duration until the job has
+ # been attempted retry_count times. Thus, the
+ # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
+ #
+ # The default value of this field is 5.
+ "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 5 seconds.
+ "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 1 hour.
"maxRetryDuration": "A String", # 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
@@ -2013,33 +2031,6 @@
# whichever comes first.
#
# Values greater than 5 and negative values are not allowed.
- "maxDoublings": 42, # 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 a job will first be retried in 10s. The
- # retry interval will double three times, and then increase linearly by
- # 2^3 * 10s. Finally, the job will retry at intervals of
- # max_backoff_duration until the job has
- # been attempted retry_count times. Thus, the
- # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
- #
- # The default value of this field is 5.
- "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 1 hour.
- "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 5 seconds.
},
"state": "A String", # Output only. State of the job.
"name": "A String", # Optionally caller-specified in CreateJob, after
@@ -2063,6 +2054,7 @@
"scheduleTime": "A String", # 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.
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -2086,7 +2078,6 @@
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
"attemptDeadline": "A String", # 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
@@ -2097,40 +2088,32 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
+ "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
+ # the given Pub/Sub topic.
+ "attributes": { # Attributes for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ "a_key": "A String",
+ },
+ "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
+ # be published when a job is delivered. The topic name must be in the
+ # same format as required by PubSub's
+ # [PublishRequest.name](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.
+ "data": "A String", # The message payload for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ },
"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.
# 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.
- "httpMethod": "A String", # Which HTTP method to use for the request.
- "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
- # method is POST, PUT, or PATCH. It is an error to set body on a job with an
- # incompatible HttpMethod.
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # 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.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # 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.
- },
- "uri": "A 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.
"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
@@ -2168,27 +2151,44 @@
# The service account must be within the same project as the job. The caller
# must have iam.serviceAccounts.actAs permission for the service account.
},
- },
- "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
- # the given Pub/Sub topic.
- "attributes": { # Attributes for PubsubMessage.
+ "httpMethod": "A String", # Which HTTP method to use for the request.
+ "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
+ # method is POST, PUT, or PATCH. It is an error to set body on a job with an
+ # incompatible HttpMethod.
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
#
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
- "a_key": "A String",
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # 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": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
},
- "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
- # be published when a job is delivered. The topic name must be in the
- # same format as required by PubSub's
- # [PublishRequest.name](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.
- "data": "A String", # The message payload for PubsubMessage.
- #
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
+ "uri": "A 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.
},
+ "timeZone": "A 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](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).
}
updateMask: string, A mask used to specify which fields of the job are being updated.
@@ -2202,15 +2202,6 @@
{ # Configuration for a job.
# The maximum allowed size for a job is 100KB.
- "timeZone": "A 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](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).
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
@@ -2225,19 +2216,6 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
- "body": "A String", # Body.
- #
- # HTTP request body. A request body is allowed only if the HTTP method is
- # POST or PUT. It will result in invalid argument error to set a body on a
- # job with an incompatible HttpMethod.
- "relativeUri": "A 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": { # HTTP request headers.
#
# This map contains the header field names and values. Headers can be set
@@ -2283,6 +2261,23 @@
# 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).
+ "service": "A String", # App service.
+ #
+ # By default, the job is sent to the service which is the default
+ # service when the job is attempted.
+ "instance": "A 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](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).
"version": "A String", # App version.
#
# By default, the job is sent to the version which is the default
@@ -2345,24 +2340,20 @@
# version, or
# instance is invalid, then the job will be sent
# to the default version of the default service when the job is attempted.
- "service": "A String", # App service.
- #
- # By default, the job is sent to the service which is the default
- # service when the job is attempted.
- "instance": "A 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](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).
},
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
+ "body": "A String", # Body.
+ #
+ # HTTP request body. A request body is allowed only if the HTTP method is
+ # POST or PUT. It will result in invalid argument error to set a body on a
+ # job with an incompatible HttpMethod.
+ "relativeUri": "A 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.
},
"status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution.
# different programming environments, including REST APIs and RPC APIs. It is
@@ -2371,7 +2362,6 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -2381,12 +2371,40 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
"retryConfig": { # Settings that determine the retry behavior. # 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.
+ "maxDoublings": 42, # 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 a job will first be retried in 10s. The
+ # retry interval will double three times, and then increase linearly by
+ # 2^3 * 10s. Finally, the job will retry at intervals of
+ # max_backoff_duration until the job has
+ # been attempted retry_count times. Thus, the
+ # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
+ #
+ # The default value of this field is 5.
+ "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 5 seconds.
+ "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 1 hour.
"maxRetryDuration": "A String", # 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
@@ -2410,33 +2428,6 @@
# whichever comes first.
#
# Values greater than 5 and negative values are not allowed.
- "maxDoublings": 42, # 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 a job will first be retried in 10s. The
- # retry interval will double three times, and then increase linearly by
- # 2^3 * 10s. Finally, the job will retry at intervals of
- # max_backoff_duration until the job has
- # been attempted retry_count times. Thus, the
- # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
- #
- # The default value of this field is 5.
- "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 1 hour.
- "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 5 seconds.
},
"state": "A String", # Output only. State of the job.
"name": "A String", # Optionally caller-specified in CreateJob, after
@@ -2460,6 +2451,7 @@
"scheduleTime": "A String", # 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.
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -2483,7 +2475,6 @@
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
"attemptDeadline": "A String", # 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
@@ -2494,40 +2485,32 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
+ "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
+ # the given Pub/Sub topic.
+ "attributes": { # Attributes for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ "a_key": "A String",
+ },
+ "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
+ # be published when a job is delivered. The topic name must be in the
+ # same format as required by PubSub's
+ # [PublishRequest.name](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.
+ "data": "A String", # The message payload for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ },
"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.
# 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.
- "httpMethod": "A String", # Which HTTP method to use for the request.
- "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
- # method is POST, PUT, or PATCH. It is an error to set body on a job with an
- # incompatible HttpMethod.
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # 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.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # 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.
- },
- "uri": "A 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.
"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
@@ -2565,27 +2548,44 @@
# The service account must be within the same project as the job. The caller
# must have iam.serviceAccounts.actAs permission for the service account.
},
- },
- "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
- # the given Pub/Sub topic.
- "attributes": { # Attributes for PubsubMessage.
+ "httpMethod": "A String", # Which HTTP method to use for the request.
+ "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
+ # method is POST, PUT, or PATCH. It is an error to set body on a job with an
+ # incompatible HttpMethod.
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
#
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
- "a_key": "A String",
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # 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": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
},
- "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
- # be published when a job is delivered. The topic name must be in the
- # same format as required by PubSub's
- # [PublishRequest.name](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.
- "data": "A String", # The message payload for PubsubMessage.
- #
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
+ "uri": "A 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.
},
+ "timeZone": "A 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](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).
}</pre>
</div>
@@ -2618,15 +2618,6 @@
{ # Configuration for a job.
# The maximum allowed size for a job is 100KB.
- "timeZone": "A 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](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).
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
@@ -2641,19 +2632,6 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
- "body": "A String", # Body.
- #
- # HTTP request body. A request body is allowed only if the HTTP method is
- # POST or PUT. It will result in invalid argument error to set a body on a
- # job with an incompatible HttpMethod.
- "relativeUri": "A 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": { # HTTP request headers.
#
# This map contains the header field names and values. Headers can be set
@@ -2699,6 +2677,23 @@
# 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).
+ "service": "A String", # App service.
+ #
+ # By default, the job is sent to the service which is the default
+ # service when the job is attempted.
+ "instance": "A 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](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).
"version": "A String", # App version.
#
# By default, the job is sent to the version which is the default
@@ -2761,24 +2756,20 @@
# version, or
# instance is invalid, then the job will be sent
# to the default version of the default service when the job is attempted.
- "service": "A String", # App service.
- #
- # By default, the job is sent to the service which is the default
- # service when the job is attempted.
- "instance": "A 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](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).
},
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
+ "body": "A String", # Body.
+ #
+ # HTTP request body. A request body is allowed only if the HTTP method is
+ # POST or PUT. It will result in invalid argument error to set a body on a
+ # job with an incompatible HttpMethod.
+ "relativeUri": "A 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.
},
"status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution.
# different programming environments, including REST APIs and RPC APIs. It is
@@ -2787,7 +2778,6 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -2797,12 +2787,40 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
"retryConfig": { # Settings that determine the retry behavior. # 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.
+ "maxDoublings": 42, # 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 a job will first be retried in 10s. The
+ # retry interval will double three times, and then increase linearly by
+ # 2^3 * 10s. Finally, the job will retry at intervals of
+ # max_backoff_duration until the job has
+ # been attempted retry_count times. Thus, the
+ # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
+ #
+ # The default value of this field is 5.
+ "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 5 seconds.
+ "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 1 hour.
"maxRetryDuration": "A String", # 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
@@ -2826,33 +2844,6 @@
# whichever comes first.
#
# Values greater than 5 and negative values are not allowed.
- "maxDoublings": 42, # 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 a job will first be retried in 10s. The
- # retry interval will double three times, and then increase linearly by
- # 2^3 * 10s. Finally, the job will retry at intervals of
- # max_backoff_duration until the job has
- # been attempted retry_count times. Thus, the
- # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
- #
- # The default value of this field is 5.
- "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 1 hour.
- "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 5 seconds.
},
"state": "A String", # Output only. State of the job.
"name": "A String", # Optionally caller-specified in CreateJob, after
@@ -2876,6 +2867,7 @@
"scheduleTime": "A String", # 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.
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -2899,7 +2891,6 @@
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
"attemptDeadline": "A String", # 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
@@ -2910,40 +2901,32 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
+ "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
+ # the given Pub/Sub topic.
+ "attributes": { # Attributes for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ "a_key": "A String",
+ },
+ "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
+ # be published when a job is delivered. The topic name must be in the
+ # same format as required by PubSub's
+ # [PublishRequest.name](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.
+ "data": "A String", # The message payload for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ },
"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.
# 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.
- "httpMethod": "A String", # Which HTTP method to use for the request.
- "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
- # method is POST, PUT, or PATCH. It is an error to set body on a job with an
- # incompatible HttpMethod.
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # 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.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # 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.
- },
- "uri": "A 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.
"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
@@ -2981,27 +2964,44 @@
# The service account must be within the same project as the job. The caller
# must have iam.serviceAccounts.actAs permission for the service account.
},
- },
- "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
- # the given Pub/Sub topic.
- "attributes": { # Attributes for PubsubMessage.
+ "httpMethod": "A String", # Which HTTP method to use for the request.
+ "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
+ # method is POST, PUT, or PATCH. It is an error to set body on a job with an
+ # incompatible HttpMethod.
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
#
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
- "a_key": "A String",
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # 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": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
},
- "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
- # be published when a job is delivered. The topic name must be in the
- # same format as required by PubSub's
- # [PublishRequest.name](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.
- "data": "A String", # The message payload for PubsubMessage.
- #
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
+ "uri": "A 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.
},
+ "timeZone": "A 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](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).
}</pre>
</div>
@@ -3033,15 +3033,6 @@
{ # Configuration for a job.
# The maximum allowed size for a job is 100KB.
- "timeZone": "A 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](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).
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
@@ -3056,19 +3047,6 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
- "body": "A String", # Body.
- #
- # HTTP request body. A request body is allowed only if the HTTP method is
- # POST or PUT. It will result in invalid argument error to set a body on a
- # job with an incompatible HttpMethod.
- "relativeUri": "A 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": { # HTTP request headers.
#
# This map contains the header field names and values. Headers can be set
@@ -3114,6 +3092,23 @@
# 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).
+ "service": "A String", # App service.
+ #
+ # By default, the job is sent to the service which is the default
+ # service when the job is attempted.
+ "instance": "A 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](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).
"version": "A String", # App version.
#
# By default, the job is sent to the version which is the default
@@ -3176,24 +3171,20 @@
# version, or
# instance is invalid, then the job will be sent
# to the default version of the default service when the job is attempted.
- "service": "A String", # App service.
- #
- # By default, the job is sent to the service which is the default
- # service when the job is attempted.
- "instance": "A 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](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).
},
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
+ "body": "A String", # Body.
+ #
+ # HTTP request body. A request body is allowed only if the HTTP method is
+ # POST or PUT. It will result in invalid argument error to set a body on a
+ # job with an incompatible HttpMethod.
+ "relativeUri": "A 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.
},
"status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution.
# different programming environments, including REST APIs and RPC APIs. It is
@@ -3202,7 +3193,6 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -3212,12 +3202,40 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
"retryConfig": { # Settings that determine the retry behavior. # 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.
+ "maxDoublings": 42, # 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 a job will first be retried in 10s. The
+ # retry interval will double three times, and then increase linearly by
+ # 2^3 * 10s. Finally, the job will retry at intervals of
+ # max_backoff_duration until the job has
+ # been attempted retry_count times. Thus, the
+ # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
+ #
+ # The default value of this field is 5.
+ "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 5 seconds.
+ "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 1 hour.
"maxRetryDuration": "A String", # 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
@@ -3241,33 +3259,6 @@
# whichever comes first.
#
# Values greater than 5 and negative values are not allowed.
- "maxDoublings": 42, # 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 a job will first be retried in 10s. The
- # retry interval will double three times, and then increase linearly by
- # 2^3 * 10s. Finally, the job will retry at intervals of
- # max_backoff_duration until the job has
- # been attempted retry_count times. Thus, the
- # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
- #
- # The default value of this field is 5.
- "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 1 hour.
- "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 5 seconds.
},
"state": "A String", # Output only. State of the job.
"name": "A String", # Optionally caller-specified in CreateJob, after
@@ -3291,6 +3282,7 @@
"scheduleTime": "A String", # 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.
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -3314,7 +3306,6 @@
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
"attemptDeadline": "A String", # 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
@@ -3325,40 +3316,32 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
+ "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
+ # the given Pub/Sub topic.
+ "attributes": { # Attributes for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ "a_key": "A String",
+ },
+ "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
+ # be published when a job is delivered. The topic name must be in the
+ # same format as required by PubSub's
+ # [PublishRequest.name](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.
+ "data": "A String", # The message payload for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ },
"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.
# 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.
- "httpMethod": "A String", # Which HTTP method to use for the request.
- "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
- # method is POST, PUT, or PATCH. It is an error to set body on a job with an
- # incompatible HttpMethod.
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # 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.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # 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.
- },
- "uri": "A 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.
"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
@@ -3396,27 +3379,44 @@
# The service account must be within the same project as the job. The caller
# must have iam.serviceAccounts.actAs permission for the service account.
},
- },
- "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
- # the given Pub/Sub topic.
- "attributes": { # Attributes for PubsubMessage.
+ "httpMethod": "A String", # Which HTTP method to use for the request.
+ "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
+ # method is POST, PUT, or PATCH. It is an error to set body on a job with an
+ # incompatible HttpMethod.
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
#
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
- "a_key": "A String",
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # 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": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
},
- "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
- # be published when a job is delivered. The topic name must be in the
- # same format as required by PubSub's
- # [PublishRequest.name](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.
- "data": "A String", # The message payload for PubsubMessage.
- #
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
+ "uri": "A 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.
},
+ "timeZone": "A 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](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).
}</pre>
</div>
@@ -3447,15 +3447,6 @@
{ # Configuration for a job.
# The maximum allowed size for a job is 100KB.
- "timeZone": "A 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](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).
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
@@ -3470,19 +3461,6 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
- "body": "A String", # Body.
- #
- # HTTP request body. A request body is allowed only if the HTTP method is
- # POST or PUT. It will result in invalid argument error to set a body on a
- # job with an incompatible HttpMethod.
- "relativeUri": "A 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": { # HTTP request headers.
#
# This map contains the header field names and values. Headers can be set
@@ -3528,6 +3506,23 @@
# 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).
+ "service": "A String", # App service.
+ #
+ # By default, the job is sent to the service which is the default
+ # service when the job is attempted.
+ "instance": "A 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](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).
"version": "A String", # App version.
#
# By default, the job is sent to the version which is the default
@@ -3590,24 +3585,20 @@
# version, or
# instance is invalid, then the job will be sent
# to the default version of the default service when the job is attempted.
- "service": "A String", # App service.
- #
- # By default, the job is sent to the service which is the default
- # service when the job is attempted.
- "instance": "A 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](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).
},
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
+ "body": "A String", # Body.
+ #
+ # HTTP request body. A request body is allowed only if the HTTP method is
+ # POST or PUT. It will result in invalid argument error to set a body on a
+ # job with an incompatible HttpMethod.
+ "relativeUri": "A 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.
},
"status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution.
# different programming environments, including REST APIs and RPC APIs. It is
@@ -3616,7 +3607,6 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -3626,12 +3616,40 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
"retryConfig": { # Settings that determine the retry behavior. # 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.
+ "maxDoublings": 42, # 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 a job will first be retried in 10s. The
+ # retry interval will double three times, and then increase linearly by
+ # 2^3 * 10s. Finally, the job will retry at intervals of
+ # max_backoff_duration until the job has
+ # been attempted retry_count times. Thus, the
+ # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
+ #
+ # The default value of this field is 5.
+ "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 5 seconds.
+ "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
+ # it fails.
+ #
+ # The default value of this field is 1 hour.
"maxRetryDuration": "A String", # 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
@@ -3655,33 +3673,6 @@
# whichever comes first.
#
# Values greater than 5 and negative values are not allowed.
- "maxDoublings": 42, # 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 a job will first be retried in 10s. The
- # retry interval will double three times, and then increase linearly by
- # 2^3 * 10s. Finally, the job will retry at intervals of
- # max_backoff_duration until the job has
- # been attempted retry_count times. Thus, the
- # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
- #
- # The default value of this field is 5.
- "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 1 hour.
- "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after
- # it fails.
- #
- # The default value of this field is 5 seconds.
},
"state": "A String", # Output only. State of the job.
"name": "A String", # Optionally caller-specified in CreateJob, after
@@ -3705,6 +3696,7 @@
"scheduleTime": "A String", # 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.
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -3728,7 +3720,6 @@
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
"attemptDeadline": "A String", # 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
@@ -3739,40 +3730,32 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
+ "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
+ # the given Pub/Sub topic.
+ "attributes": { # Attributes for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ "a_key": "A String",
+ },
+ "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
+ # be published when a job is delivered. The topic name must be in the
+ # same format as required by PubSub's
+ # [PublishRequest.name](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.
+ "data": "A String", # The message payload for PubsubMessage.
+ #
+ # Pubsub message must contain either non-empty data, or at least one
+ # attribute.
+ },
"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.
# 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.
- "httpMethod": "A String", # Which HTTP method to use for the request.
- "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
- # method is POST, PUT, or PATCH. It is an error to set body on a job with an
- # incompatible HttpMethod.
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # 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.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # 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.
- },
- "uri": "A 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.
"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
@@ -3810,27 +3793,44 @@
# The service account must be within the same project as the job. The caller
# must have iam.serviceAccounts.actAs permission for the service account.
},
- },
- "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
- # the given Pub/Sub topic.
- "attributes": { # Attributes for PubsubMessage.
+ "httpMethod": "A String", # Which HTTP method to use for the request.
+ "body": "A String", # HTTP request body. A request body is allowed only if the HTTP
+ # method is POST, PUT, or PATCH. It is an error to set body on a job with an
+ # incompatible HttpMethod.
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
#
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
- "a_key": "A String",
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # 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": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
},
- "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will
- # be published when a job is delivered. The topic name must be in the
- # same format as required by PubSub's
- # [PublishRequest.name](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.
- "data": "A String", # The message payload for PubsubMessage.
- #
- # Pubsub message must contain either non-empty data, or at least one
- # attribute.
+ "uri": "A 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.
},
+ "timeZone": "A 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](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).
}</pre>
</div>