chore: regens API reference docs (#889)
diff --git a/docs/dyn/cloudscheduler_v1beta1.projects.locations.jobs.html b/docs/dyn/cloudscheduler_v1beta1.projects.locations.jobs.html
index 2236d0a..2845f3a 100644
--- a/docs/dyn/cloudscheduler_v1beta1.projects.locations.jobs.html
+++ b/docs/dyn/cloudscheduler_v1beta1.projects.locations.jobs.html
@@ -75,7 +75,7 @@
<h1><a href="cloudscheduler_v1beta1.html">Cloud Scheduler API</a> . <a href="cloudscheduler_v1beta1.projects.html">projects</a> . <a href="cloudscheduler_v1beta1.projects.locations.html">locations</a> . <a href="cloudscheduler_v1beta1.projects.locations.jobs.html">jobs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a job.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -84,13 +84,13 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a job.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">Lists jobs.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a job.</p>
<p class="toc_element">
<code><a href="#pause">pause(name, body=None, x__xgafv=None)</a></code></p>
@@ -103,15 +103,13 @@
<p class="firstline">Forces a job to run now.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a job.
Args:
- parent: string, Required.
-
-The location name. For example:
+ parent: string, Required. The location name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID`. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Configuration for a job.
@@ -134,28 +132,12 @@
},
],
},
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
# A human-readable description for the job. This string must not contain
# more than 500 characters.
- "name": "A String", # Optionally caller-specified in CreateJob, after
- # which it becomes output only.
- #
- # The job name. For example:
- # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the job's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -175,7 +157,7 @@
# A scheduled start time will be delayed if the previous
# execution has not ended when its scheduled time occurs.
#
- # If retry_count > 0 and a job attempt fails,
+ # If retry_count > 0 and a job attempt fails,
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
@@ -212,9 +194,7 @@
# 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
+ "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
@@ -336,17 +316,17 @@
# The host is constructed as:
#
#
- # * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # * `host = [application_domain_name]`</br>
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
- # example <app-id>.appspot.com, which is associated with the
+ # example <app-id>.appspot.com, which is associated with the
# job's project ID.
#
# * `service =` service
@@ -404,7 +384,23 @@
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
# permitted.
},
- "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "name": "A String", # Optionally caller-specified in CreateJob, after
+ # which it becomes output only.
+ #
+ # The job name. For example:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the job's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"state": "A String", # Output only. State of the job.
"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
# the given Pub/Sub topic.
@@ -418,9 +414,7 @@
#
# Pubsub message must contain either non-empty data, or at least one
# attribute.
- "topicName": "A String", # Required.
- #
- # The name of the Cloud Pub/Sub topic to which messages will
+ "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),
@@ -437,6 +431,19 @@
# 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).
+ "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "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
+ # execution logs. Cloud Scheduler will retry the job according
+ # to the RetryConfig.
+ #
+ # The allowed duration for this deadline is:
+ #
+ # * For HTTP targets, between 15 seconds and 30 minutes.
+ # * For App Engine HTTP targets, between 15
+ # seconds and 24 hours.
+ # * For PubSub targets, this field is ignored.
"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.
#
# By default, if a job does not complete successfully (meaning that
@@ -467,7 +474,7 @@
# A job's retry interval starts at
# min_backoff_duration, then doubles
# `max_doublings` times, then increases linearly, and finally
- # retries retries at intervals of
+ # retries at intervals of
# max_backoff_duration up to
# retry_count times.
#
@@ -493,19 +500,6 @@
#
# The default value of this field is 5 seconds.
},
- "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
- # execution logs. Cloud Scheduler will retry the job according
- # to the RetryConfig.
- #
- # The allowed duration for this deadline is:
- #
- # * For HTTP targets, between 15 seconds and 30 minutes.
- # * For App Engine HTTP targets, between 15
- # seconds and 24 hours.
- # * For PubSub targets, this field is ignored.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
}
x__xgafv: string, V1 error format.
@@ -536,28 +530,12 @@
},
],
},
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
# A human-readable description for the job. This string must not contain
# more than 500 characters.
- "name": "A String", # Optionally caller-specified in CreateJob, after
- # which it becomes output only.
- #
- # The job name. For example:
- # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the job's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -577,7 +555,7 @@
# A scheduled start time will be delayed if the previous
# execution has not ended when its scheduled time occurs.
#
- # If retry_count > 0 and a job attempt fails,
+ # If retry_count > 0 and a job attempt fails,
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
@@ -614,9 +592,7 @@
# 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
+ "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
@@ -738,17 +714,17 @@
# The host is constructed as:
#
#
- # * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # * `host = [application_domain_name]`</br>
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
- # example <app-id>.appspot.com, which is associated with the
+ # example <app-id>.appspot.com, which is associated with the
# job's project ID.
#
# * `service =` service
@@ -806,7 +782,23 @@
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
# permitted.
},
- "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "name": "A String", # Optionally caller-specified in CreateJob, after
+ # which it becomes output only.
+ #
+ # The job name. For example:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the job's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"state": "A String", # Output only. State of the job.
"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
# the given Pub/Sub topic.
@@ -820,9 +812,7 @@
#
# Pubsub message must contain either non-empty data, or at least one
# attribute.
- "topicName": "A String", # Required.
- #
- # The name of the Cloud Pub/Sub topic to which messages will
+ "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),
@@ -839,6 +829,19 @@
# 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).
+ "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "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
+ # execution logs. Cloud Scheduler will retry the job according
+ # to the RetryConfig.
+ #
+ # The allowed duration for this deadline is:
+ #
+ # * For HTTP targets, between 15 seconds and 30 minutes.
+ # * For App Engine HTTP targets, between 15
+ # seconds and 24 hours.
+ # * For PubSub targets, this field is ignored.
"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.
#
# By default, if a job does not complete successfully (meaning that
@@ -869,7 +872,7 @@
# A job's retry interval starts at
# min_backoff_duration, then doubles
# `max_doublings` times, then increases linearly, and finally
- # retries retries at intervals of
+ # retries at intervals of
# max_backoff_duration up to
# retry_count times.
#
@@ -895,19 +898,6 @@
#
# The default value of this field is 5 seconds.
},
- "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
- # execution logs. Cloud Scheduler will retry the job according
- # to the RetryConfig.
- #
- # The allowed duration for this deadline is:
- #
- # * For HTTP targets, between 15 seconds and 30 minutes.
- # * For App Engine HTTP targets, between 15
- # seconds and 24 hours.
- # * For PubSub targets, this field is ignored.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
}</pre>
</div>
@@ -916,9 +906,7 @@
<pre>Deletes a job.
Args:
- name: string, Required.
-
-The job name. For example:
+ name: string, Required. The job name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -945,9 +933,7 @@
<pre>Gets a job.
Args:
- name: string, Required.
-
-The job name. For example:
+ name: string, Required. The job name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -977,28 +963,12 @@
},
],
},
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
# A human-readable description for the job. This string must not contain
# more than 500 characters.
- "name": "A String", # Optionally caller-specified in CreateJob, after
- # which it becomes output only.
- #
- # The job name. For example:
- # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the job's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -1018,7 +988,7 @@
# A scheduled start time will be delayed if the previous
# execution has not ended when its scheduled time occurs.
#
- # If retry_count > 0 and a job attempt fails,
+ # If retry_count > 0 and a job attempt fails,
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
@@ -1055,9 +1025,7 @@
# 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
+ "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
@@ -1179,17 +1147,17 @@
# The host is constructed as:
#
#
- # * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # * `host = [application_domain_name]`</br>
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
- # example <app-id>.appspot.com, which is associated with the
+ # example <app-id>.appspot.com, which is associated with the
# job's project ID.
#
# * `service =` service
@@ -1247,7 +1215,23 @@
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
# permitted.
},
- "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "name": "A String", # Optionally caller-specified in CreateJob, after
+ # which it becomes output only.
+ #
+ # The job name. For example:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the job's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"state": "A String", # Output only. State of the job.
"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
# the given Pub/Sub topic.
@@ -1261,9 +1245,7 @@
#
# Pubsub message must contain either non-empty data, or at least one
# attribute.
- "topicName": "A String", # Required.
- #
- # The name of the Cloud Pub/Sub topic to which messages will
+ "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),
@@ -1280,6 +1262,19 @@
# 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).
+ "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "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
+ # execution logs. Cloud Scheduler will retry the job according
+ # to the RetryConfig.
+ #
+ # The allowed duration for this deadline is:
+ #
+ # * For HTTP targets, between 15 seconds and 30 minutes.
+ # * For App Engine HTTP targets, between 15
+ # seconds and 24 hours.
+ # * For PubSub targets, this field is ignored.
"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.
#
# By default, if a job does not complete successfully (meaning that
@@ -1310,7 +1305,7 @@
# A job's retry interval starts at
# min_backoff_duration, then doubles
# `max_doublings` times, then increases linearly, and finally
- # retries retries at intervals of
+ # retries at intervals of
# max_backoff_duration up to
# retry_count times.
#
@@ -1336,37 +1331,16 @@
#
# The default value of this field is 5 seconds.
},
- "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
- # execution logs. Cloud Scheduler will retry the job according
- # to the RetryConfig.
- #
- # The allowed duration for this deadline is:
- #
- # * For HTTP targets, between 15 seconds and 30 minutes.
- # * For App Engine HTTP targets, between 15
- # seconds and 24 hours.
- # * For PubSub targets, this field is ignored.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>Lists jobs.
Args:
- parent: string, Required.
-
-The location name. For example:
+ parent: string, Required. The location name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID`. (required)
- pageSize: integer, Requested page size.
-
-The maximum page size is 500. If unspecified, the page size will
-be the maximum. Fewer jobs than requested might be returned,
-even if more jobs exist; use next_page_token to determine if more
-jobs exist.
pageToken: string, A token identifying a page of results the server will return. To
request the first page results, page_token must be empty. To
request the next page of results, page_token must be the value of
@@ -1378,6 +1352,12 @@
Allowed values
1 - v1 error format
2 - v2 error format
+ pageSize: integer, Requested page size.
+
+The maximum page size is 500. If unspecified, the page size will
+be the maximum. Fewer jobs than requested might be returned,
+even if more jobs exist; use next_page_token to determine if more
+jobs exist.
Returns:
An object of the form:
@@ -1411,28 +1391,12 @@
},
],
},
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
# A human-readable description for the job. This string must not contain
# more than 500 characters.
- "name": "A String", # Optionally caller-specified in CreateJob, after
- # which it becomes output only.
- #
- # The job name. For example:
- # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the job's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -1452,7 +1416,7 @@
# A scheduled start time will be delayed if the previous
# execution has not ended when its scheduled time occurs.
#
- # If retry_count > 0 and a job attempt fails,
+ # If retry_count > 0 and a job attempt fails,
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
@@ -1489,9 +1453,7 @@
# 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
+ "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
@@ -1613,17 +1575,17 @@
# The host is constructed as:
#
#
- # * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # * `host = [application_domain_name]`</br>
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
- # example <app-id>.appspot.com, which is associated with the
+ # example <app-id>.appspot.com, which is associated with the
# job's project ID.
#
# * `service =` service
@@ -1681,7 +1643,23 @@
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
# permitted.
},
- "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "name": "A String", # Optionally caller-specified in CreateJob, after
+ # which it becomes output only.
+ #
+ # The job name. For example:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the job's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"state": "A String", # Output only. State of the job.
"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
# the given Pub/Sub topic.
@@ -1695,9 +1673,7 @@
#
# Pubsub message must contain either non-empty data, or at least one
# attribute.
- "topicName": "A String", # Required.
- #
- # The name of the Cloud Pub/Sub topic to which messages will
+ "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),
@@ -1714,6 +1690,19 @@
# 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).
+ "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "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
+ # execution logs. Cloud Scheduler will retry the job according
+ # to the RetryConfig.
+ #
+ # The allowed duration for this deadline is:
+ #
+ # * For HTTP targets, between 15 seconds and 30 minutes.
+ # * For App Engine HTTP targets, between 15
+ # seconds and 24 hours.
+ # * For PubSub targets, this field is ignored.
"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.
#
# By default, if a job does not complete successfully (meaning that
@@ -1744,7 +1733,7 @@
# A job's retry interval starts at
# min_backoff_duration, then doubles
# `max_doublings` times, then increases linearly, and finally
- # retries retries at intervals of
+ # retries at intervals of
# max_backoff_duration up to
# retry_count times.
#
@@ -1770,19 +1759,6 @@
#
# The default value of this field is 5 seconds.
},
- "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
- # execution logs. Cloud Scheduler will retry the job according
- # to the RetryConfig.
- #
- # The allowed duration for this deadline is:
- #
- # * For HTTP targets, between 15 seconds and 30 minutes.
- # * For App Engine HTTP targets, between 15
- # seconds and 24 hours.
- # * For PubSub targets, this field is ignored.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
},
],
}</pre>
@@ -1803,7 +1779,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a job.
If successful, the updated Job is returned. If the job does
@@ -1832,7 +1808,7 @@
For more information, see https://cloud.google.com/about/locations/.
* `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
hyphens (-), or underscores (_). The maximum length is 500 characters. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Configuration for a job.
@@ -1855,28 +1831,12 @@
},
],
},
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
# A human-readable description for the job. This string must not contain
# more than 500 characters.
- "name": "A String", # Optionally caller-specified in CreateJob, after
- # which it becomes output only.
- #
- # The job name. For example:
- # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the job's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -1896,7 +1856,7 @@
# A scheduled start time will be delayed if the previous
# execution has not ended when its scheduled time occurs.
#
- # If retry_count > 0 and a job attempt fails,
+ # If retry_count > 0 and a job attempt fails,
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
@@ -1933,9 +1893,7 @@
# 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
+ "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
@@ -2057,17 +2015,17 @@
# The host is constructed as:
#
#
- # * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # * `host = [application_domain_name]`</br>
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
- # example <app-id>.appspot.com, which is associated with the
+ # example <app-id>.appspot.com, which is associated with the
# job's project ID.
#
# * `service =` service
@@ -2125,7 +2083,23 @@
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
# permitted.
},
- "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "name": "A String", # Optionally caller-specified in CreateJob, after
+ # which it becomes output only.
+ #
+ # The job name. For example:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the job's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"state": "A String", # Output only. State of the job.
"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
# the given Pub/Sub topic.
@@ -2139,9 +2113,7 @@
#
# Pubsub message must contain either non-empty data, or at least one
# attribute.
- "topicName": "A String", # Required.
- #
- # The name of the Cloud Pub/Sub topic to which messages will
+ "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),
@@ -2158,6 +2130,19 @@
# 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).
+ "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "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
+ # execution logs. Cloud Scheduler will retry the job according
+ # to the RetryConfig.
+ #
+ # The allowed duration for this deadline is:
+ #
+ # * For HTTP targets, between 15 seconds and 30 minutes.
+ # * For App Engine HTTP targets, between 15
+ # seconds and 24 hours.
+ # * For PubSub targets, this field is ignored.
"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.
#
# By default, if a job does not complete successfully (meaning that
@@ -2188,7 +2173,7 @@
# A job's retry interval starts at
# min_backoff_duration, then doubles
# `max_doublings` times, then increases linearly, and finally
- # retries retries at intervals of
+ # retries at intervals of
# max_backoff_duration up to
# retry_count times.
#
@@ -2214,19 +2199,6 @@
#
# The default value of this field is 5 seconds.
},
- "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
- # execution logs. Cloud Scheduler will retry the job according
- # to the RetryConfig.
- #
- # The allowed duration for this deadline is:
- #
- # * For HTTP targets, between 15 seconds and 30 minutes.
- # * For App Engine HTTP targets, between 15
- # seconds and 24 hours.
- # * For PubSub targets, this field is ignored.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
}
updateMask: string, A mask used to specify which fields of the job are being updated.
@@ -2258,28 +2230,12 @@
},
],
},
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
# A human-readable description for the job. This string must not contain
# more than 500 characters.
- "name": "A String", # Optionally caller-specified in CreateJob, after
- # which it becomes output only.
- #
- # The job name. For example:
- # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the job's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -2299,7 +2255,7 @@
# A scheduled start time will be delayed if the previous
# execution has not ended when its scheduled time occurs.
#
- # If retry_count > 0 and a job attempt fails,
+ # If retry_count > 0 and a job attempt fails,
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
@@ -2336,9 +2292,7 @@
# 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
+ "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
@@ -2460,17 +2414,17 @@
# The host is constructed as:
#
#
- # * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # * `host = [application_domain_name]`</br>
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
- # example <app-id>.appspot.com, which is associated with the
+ # example <app-id>.appspot.com, which is associated with the
# job's project ID.
#
# * `service =` service
@@ -2528,7 +2482,23 @@
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
# permitted.
},
- "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "name": "A String", # Optionally caller-specified in CreateJob, after
+ # which it becomes output only.
+ #
+ # The job name. For example:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the job's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"state": "A String", # Output only. State of the job.
"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
# the given Pub/Sub topic.
@@ -2542,9 +2512,7 @@
#
# Pubsub message must contain either non-empty data, or at least one
# attribute.
- "topicName": "A String", # Required.
- #
- # The name of the Cloud Pub/Sub topic to which messages will
+ "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),
@@ -2561,6 +2529,19 @@
# 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).
+ "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "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
+ # execution logs. Cloud Scheduler will retry the job according
+ # to the RetryConfig.
+ #
+ # The allowed duration for this deadline is:
+ #
+ # * For HTTP targets, between 15 seconds and 30 minutes.
+ # * For App Engine HTTP targets, between 15
+ # seconds and 24 hours.
+ # * For PubSub targets, this field is ignored.
"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.
#
# By default, if a job does not complete successfully (meaning that
@@ -2591,7 +2572,7 @@
# A job's retry interval starts at
# min_backoff_duration, then doubles
# `max_doublings` times, then increases linearly, and finally
- # retries retries at intervals of
+ # retries at intervals of
# max_backoff_duration up to
# retry_count times.
#
@@ -2617,19 +2598,6 @@
#
# The default value of this field is 5 seconds.
},
- "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
- # execution logs. Cloud Scheduler will retry the job according
- # to the RetryConfig.
- #
- # The allowed duration for this deadline is:
- #
- # * For HTTP targets, between 15 seconds and 30 minutes.
- # * For App Engine HTTP targets, between 15
- # seconds and 24 hours.
- # * For PubSub targets, this field is ignored.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
}</pre>
</div>
@@ -2644,9 +2612,7 @@
to be paused.
Args:
- name: string, Required.
-
-The job name. For example:
+ name: string, Required. The job name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)
body: object, The request body.
The object takes the form of:
@@ -2682,28 +2648,12 @@
},
],
},
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
# A human-readable description for the job. This string must not contain
# more than 500 characters.
- "name": "A String", # Optionally caller-specified in CreateJob, after
- # which it becomes output only.
- #
- # The job name. For example:
- # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the job's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -2723,7 +2673,7 @@
# A scheduled start time will be delayed if the previous
# execution has not ended when its scheduled time occurs.
#
- # If retry_count > 0 and a job attempt fails,
+ # If retry_count > 0 and a job attempt fails,
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
@@ -2760,9 +2710,7 @@
# 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
+ "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
@@ -2884,17 +2832,17 @@
# The host is constructed as:
#
#
- # * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # * `host = [application_domain_name]`</br>
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
- # example <app-id>.appspot.com, which is associated with the
+ # example <app-id>.appspot.com, which is associated with the
# job's project ID.
#
# * `service =` service
@@ -2952,7 +2900,23 @@
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
# permitted.
},
- "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "name": "A String", # Optionally caller-specified in CreateJob, after
+ # which it becomes output only.
+ #
+ # The job name. For example:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the job's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"state": "A String", # Output only. State of the job.
"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
# the given Pub/Sub topic.
@@ -2966,9 +2930,7 @@
#
# Pubsub message must contain either non-empty data, or at least one
# attribute.
- "topicName": "A String", # Required.
- #
- # The name of the Cloud Pub/Sub topic to which messages will
+ "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),
@@ -2985,6 +2947,19 @@
# 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).
+ "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "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
+ # execution logs. Cloud Scheduler will retry the job according
+ # to the RetryConfig.
+ #
+ # The allowed duration for this deadline is:
+ #
+ # * For HTTP targets, between 15 seconds and 30 minutes.
+ # * For App Engine HTTP targets, between 15
+ # seconds and 24 hours.
+ # * For PubSub targets, this field is ignored.
"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.
#
# By default, if a job does not complete successfully (meaning that
@@ -3015,7 +2990,7 @@
# A job's retry interval starts at
# min_backoff_duration, then doubles
# `max_doublings` times, then increases linearly, and finally
- # retries retries at intervals of
+ # retries at intervals of
# max_backoff_duration up to
# retry_count times.
#
@@ -3041,19 +3016,6 @@
#
# The default value of this field is 5 seconds.
},
- "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
- # execution logs. Cloud Scheduler will retry the job according
- # to the RetryConfig.
- #
- # The allowed duration for this deadline is:
- #
- # * For HTTP targets, between 15 seconds and 30 minutes.
- # * For App Engine HTTP targets, between 15
- # seconds and 24 hours.
- # * For PubSub targets, this field is ignored.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
}</pre>
</div>
@@ -3067,9 +3029,7 @@
Job.State.PAUSED to be resumed.
Args:
- name: string, Required.
-
-The job name. For example:
+ name: string, Required. The job name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)
body: object, The request body.
The object takes the form of:
@@ -3105,28 +3065,12 @@
},
],
},
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
# A human-readable description for the job. This string must not contain
# more than 500 characters.
- "name": "A String", # Optionally caller-specified in CreateJob, after
- # which it becomes output only.
- #
- # The job name. For example:
- # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the job's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -3146,7 +3090,7 @@
# A scheduled start time will be delayed if the previous
# execution has not ended when its scheduled time occurs.
#
- # If retry_count > 0 and a job attempt fails,
+ # If retry_count > 0 and a job attempt fails,
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
@@ -3183,9 +3127,7 @@
# 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
+ "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
@@ -3307,17 +3249,17 @@
# The host is constructed as:
#
#
- # * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # * `host = [application_domain_name]`</br>
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
- # example <app-id>.appspot.com, which is associated with the
+ # example <app-id>.appspot.com, which is associated with the
# job's project ID.
#
# * `service =` service
@@ -3375,7 +3317,23 @@
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
# permitted.
},
- "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "name": "A String", # Optionally caller-specified in CreateJob, after
+ # which it becomes output only.
+ #
+ # The job name. For example:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the job's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"state": "A String", # Output only. State of the job.
"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
# the given Pub/Sub topic.
@@ -3389,9 +3347,7 @@
#
# Pubsub message must contain either non-empty data, or at least one
# attribute.
- "topicName": "A String", # Required.
- #
- # The name of the Cloud Pub/Sub topic to which messages will
+ "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),
@@ -3408,6 +3364,19 @@
# 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).
+ "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "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
+ # execution logs. Cloud Scheduler will retry the job according
+ # to the RetryConfig.
+ #
+ # The allowed duration for this deadline is:
+ #
+ # * For HTTP targets, between 15 seconds and 30 minutes.
+ # * For App Engine HTTP targets, between 15
+ # seconds and 24 hours.
+ # * For PubSub targets, this field is ignored.
"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.
#
# By default, if a job does not complete successfully (meaning that
@@ -3438,7 +3407,7 @@
# A job's retry interval starts at
# min_backoff_duration, then doubles
# `max_doublings` times, then increases linearly, and finally
- # retries retries at intervals of
+ # retries at intervals of
# max_backoff_duration up to
# retry_count times.
#
@@ -3464,19 +3433,6 @@
#
# The default value of this field is 5 seconds.
},
- "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
- # execution logs. Cloud Scheduler will retry the job according
- # to the RetryConfig.
- #
- # The allowed duration for this deadline is:
- #
- # * For HTTP targets, between 15 seconds and 30 minutes.
- # * For App Engine HTTP targets, between 15
- # seconds and 24 hours.
- # * For PubSub targets, this field is ignored.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
}</pre>
</div>
@@ -3488,9 +3444,7 @@
if the job is already running.
Args:
- name: string, Required.
-
-The job name. For example:
+ name: string, Required. The job name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)
body: object, The request body.
The object takes the form of:
@@ -3527,28 +3481,12 @@
},
],
},
+ "userUpdateTime": "A String", # Output only. The creation time of the job.
"description": "A String", # Optionally caller-specified in CreateJob or
# UpdateJob.
#
# A human-readable description for the job. This string must not contain
# more than 500 characters.
- "name": "A String", # Optionally caller-specified in CreateJob, after
- # which it becomes output only.
- #
- # The job name. For example:
- # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the job's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
"schedule": "A String", # Required, except when used with UpdateJob.
#
# Describes the schedule on which the job will be executed.
@@ -3568,7 +3506,7 @@
# A scheduled start time will be delayed if the previous
# execution has not ended when its scheduled time occurs.
#
- # If retry_count > 0 and a job attempt fails,
+ # If retry_count > 0 and a job attempt fails,
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time.
@@ -3605,9 +3543,7 @@
# 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
+ "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
@@ -3729,17 +3665,17 @@
# The host is constructed as:
#
#
- # * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # * `host = [application_domain_name]`</br>
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
- # example <app-id>.appspot.com, which is associated with the
+ # example <app-id>.appspot.com, which is associated with the
# job's project ID.
#
# * `service =` service
@@ -3797,7 +3733,23 @@
"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
# permitted.
},
- "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "name": "A String", # Optionally caller-specified in CreateJob, after
+ # which it becomes output only.
+ #
+ # The job name. For example:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the job's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"state": "A String", # Output only. State of the job.
"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.
# the given Pub/Sub topic.
@@ -3811,9 +3763,7 @@
#
# Pubsub message must contain either non-empty data, or at least one
# attribute.
- "topicName": "A String", # Required.
- #
- # The name of the Cloud Pub/Sub topic to which messages will
+ "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),
@@ -3830,6 +3780,19 @@
# 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).
+ "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
+ "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
+ # execution logs. Cloud Scheduler will retry the job according
+ # to the RetryConfig.
+ #
+ # The allowed duration for this deadline is:
+ #
+ # * For HTTP targets, between 15 seconds and 30 minutes.
+ # * For App Engine HTTP targets, between 15
+ # seconds and 24 hours.
+ # * For PubSub targets, this field is ignored.
"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.
#
# By default, if a job does not complete successfully (meaning that
@@ -3860,7 +3823,7 @@
# A job's retry interval starts at
# min_backoff_duration, then doubles
# `max_doublings` times, then increases linearly, and finally
- # retries retries at intervals of
+ # retries at intervals of
# max_backoff_duration up to
# retry_count times.
#
@@ -3886,19 +3849,6 @@
#
# The default value of this field is 5 seconds.
},
- "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
- # execution logs. Cloud Scheduler will retry the job according
- # to the RetryConfig.
- #
- # The allowed duration for this deadline is:
- #
- # * For HTTP targets, between 15 seconds and 30 minutes.
- # * For App Engine HTTP targets, between 15
- # seconds and 24 hours.
- # * For PubSub targets, this field is ignored.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
}</pre>
</div>