chore: regens API reference docs (#889)
diff --git a/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html b/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html
index 2c21c95..81e5e8d 100644
--- a/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html
+++ b/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html
@@ -75,7 +75,7 @@
<h1><a href="cloudscheduler_v1.html">Cloud Scheduler API</a> . <a href="cloudscheduler_v1.projects.html">projects</a> . <a href="cloudscheduler_v1.projects.locations.html">locations</a> . <a href="cloudscheduler_v1.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, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=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.
@@ -228,9 +210,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
@@ -270,40 +250,8 @@
# 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.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values. Headers can be set
- # when the job is created.
- #
- # Cloud Scheduler sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Scheduler will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- # * `X-CloudScheduler`: This header will be set to true.
- #
- # If the job has an body, Cloud Scheduler sets
- # the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explictly
- # setting `Content-Type` to a particular media type when the job is
- # created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Scheduler. This value is
- # output only. It cannot be changed.
- #
- # The headers below are output only. They cannot be set or overridden:
- #
- # * `X-Google-*`: For Google internal use only.
- # * `X-AppEngine-*`: For Google internal use only.
- #
- # In addition, some App Engine headers, which contain
- # job-specific information, are also be sent to the job handler.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.
#
# For more information about services, versions, and instances see
@@ -336,17 +284,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
@@ -401,8 +349,40 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values. Headers can be set
+ # when the job is created.
+ #
+ # Cloud Scheduler sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Scheduler will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ # * `X-CloudScheduler`: This header will be set to true.
+ #
+ # If the job has an body, Cloud Scheduler sets
+ # the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explictly
+ # setting `Content-Type` to a particular media type when the job is
+ # created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Scheduler. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below are output only. They cannot be set or overridden:
+ #
+ # * `X-Google-*`: For Google internal use only.
+ # * `X-AppEngine-*`: For Google internal use only.
+ #
+ # In addition, some App Engine headers, which contain
+ # job-specific information, are also be sent to the job handler.
+ "a_key": "A String",
+ },
},
"lastAttemptTime": "A String", # Output only. The time the last job attempt started.
"state": "A String", # Output only. State of the job.
@@ -418,9 +398,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),
@@ -467,7 +445,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.
#
@@ -503,7 +481,23 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
+ "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.
}
x__xgafv: string, V1 error format.
@@ -534,28 +528,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.
@@ -575,7 +553,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.
@@ -628,9 +606,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
@@ -670,40 +646,8 @@
# 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.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values. Headers can be set
- # when the job is created.
- #
- # Cloud Scheduler sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Scheduler will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- # * `X-CloudScheduler`: This header will be set to true.
- #
- # If the job has an body, Cloud Scheduler sets
- # the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explictly
- # setting `Content-Type` to a particular media type when the job is
- # created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Scheduler. This value is
- # output only. It cannot be changed.
- #
- # The headers below are output only. They cannot be set or overridden:
- #
- # * `X-Google-*`: For Google internal use only.
- # * `X-AppEngine-*`: For Google internal use only.
- #
- # In addition, some App Engine headers, which contain
- # job-specific information, are also be sent to the job handler.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.
#
# For more information about services, versions, and instances see
@@ -736,17 +680,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
@@ -801,8 +745,40 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values. Headers can be set
+ # when the job is created.
+ #
+ # Cloud Scheduler sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Scheduler will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ # * `X-CloudScheduler`: This header will be set to true.
+ #
+ # If the job has an body, Cloud Scheduler sets
+ # the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explictly
+ # setting `Content-Type` to a particular media type when the job is
+ # created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Scheduler. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below are output only. They cannot be set or overridden:
+ #
+ # * `X-Google-*`: For Google internal use only.
+ # * `X-AppEngine-*`: For Google internal use only.
+ #
+ # In addition, some App Engine headers, which contain
+ # job-specific information, are also be sent to the job handler.
+ "a_key": "A String",
+ },
},
"lastAttemptTime": "A String", # Output only. The time the last job attempt started.
"state": "A String", # Output only. State of the job.
@@ -818,9 +794,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),
@@ -867,7 +841,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.
#
@@ -903,7 +877,23 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
+ "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.
}</pre>
</div>
@@ -912,9 +902,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
@@ -941,9 +929,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
@@ -973,28 +959,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.
@@ -1014,7 +984,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.
@@ -1067,9 +1037,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
@@ -1109,40 +1077,8 @@
# 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.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values. Headers can be set
- # when the job is created.
- #
- # Cloud Scheduler sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Scheduler will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- # * `X-CloudScheduler`: This header will be set to true.
- #
- # If the job has an body, Cloud Scheduler sets
- # the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explictly
- # setting `Content-Type` to a particular media type when the job is
- # created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Scheduler. This value is
- # output only. It cannot be changed.
- #
- # The headers below are output only. They cannot be set or overridden:
- #
- # * `X-Google-*`: For Google internal use only.
- # * `X-AppEngine-*`: For Google internal use only.
- #
- # In addition, some App Engine headers, which contain
- # job-specific information, are also be sent to the job handler.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.
#
# For more information about services, versions, and instances see
@@ -1175,17 +1111,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
@@ -1240,8 +1176,40 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values. Headers can be set
+ # when the job is created.
+ #
+ # Cloud Scheduler sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Scheduler will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ # * `X-CloudScheduler`: This header will be set to true.
+ #
+ # If the job has an body, Cloud Scheduler sets
+ # the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explictly
+ # setting `Content-Type` to a particular media type when the job is
+ # created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Scheduler. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below are output only. They cannot be set or overridden:
+ #
+ # * `X-Google-*`: For Google internal use only.
+ # * `X-AppEngine-*`: For Google internal use only.
+ #
+ # In addition, some App Engine headers, which contain
+ # job-specific information, are also be sent to the job handler.
+ "a_key": "A String",
+ },
},
"lastAttemptTime": "A String", # Output only. The time the last job attempt started.
"state": "A String", # Output only. State of the job.
@@ -1257,9 +1225,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),
@@ -1306,7 +1272,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.
#
@@ -1342,19 +1308,39 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
+ "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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=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
@@ -1366,12 +1352,6 @@
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:
@@ -1405,28 +1385,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.
@@ -1446,7 +1410,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.
@@ -1499,9 +1463,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
@@ -1541,40 +1503,8 @@
# 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.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values. Headers can be set
- # when the job is created.
- #
- # Cloud Scheduler sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Scheduler will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- # * `X-CloudScheduler`: This header will be set to true.
- #
- # If the job has an body, Cloud Scheduler sets
- # the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explictly
- # setting `Content-Type` to a particular media type when the job is
- # created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Scheduler. This value is
- # output only. It cannot be changed.
- #
- # The headers below are output only. They cannot be set or overridden:
- #
- # * `X-Google-*`: For Google internal use only.
- # * `X-AppEngine-*`: For Google internal use only.
- #
- # In addition, some App Engine headers, which contain
- # job-specific information, are also be sent to the job handler.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.
#
# For more information about services, versions, and instances see
@@ -1607,17 +1537,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
@@ -1672,8 +1602,40 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values. Headers can be set
+ # when the job is created.
+ #
+ # Cloud Scheduler sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Scheduler will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ # * `X-CloudScheduler`: This header will be set to true.
+ #
+ # If the job has an body, Cloud Scheduler sets
+ # the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explictly
+ # setting `Content-Type` to a particular media type when the job is
+ # created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Scheduler. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below are output only. They cannot be set or overridden:
+ #
+ # * `X-Google-*`: For Google internal use only.
+ # * `X-AppEngine-*`: For Google internal use only.
+ #
+ # In addition, some App Engine headers, which contain
+ # job-specific information, are also be sent to the job handler.
+ "a_key": "A String",
+ },
},
"lastAttemptTime": "A String", # Output only. The time the last job attempt started.
"state": "A String", # Output only. State of the job.
@@ -1689,9 +1651,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),
@@ -1738,7 +1698,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.
#
@@ -1774,7 +1734,23 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
+ "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.
},
],
}</pre>
@@ -1795,7 +1771,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
@@ -1824,7 +1800,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.
@@ -1847,28 +1823,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.
@@ -1888,7 +1848,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.
@@ -1941,9 +1901,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
@@ -1983,40 +1941,8 @@
# 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.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values. Headers can be set
- # when the job is created.
- #
- # Cloud Scheduler sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Scheduler will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- # * `X-CloudScheduler`: This header will be set to true.
- #
- # If the job has an body, Cloud Scheduler sets
- # the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explictly
- # setting `Content-Type` to a particular media type when the job is
- # created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Scheduler. This value is
- # output only. It cannot be changed.
- #
- # The headers below are output only. They cannot be set or overridden:
- #
- # * `X-Google-*`: For Google internal use only.
- # * `X-AppEngine-*`: For Google internal use only.
- #
- # In addition, some App Engine headers, which contain
- # job-specific information, are also be sent to the job handler.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.
#
# For more information about services, versions, and instances see
@@ -2049,17 +1975,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
@@ -2114,8 +2040,40 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values. Headers can be set
+ # when the job is created.
+ #
+ # Cloud Scheduler sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Scheduler will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ # * `X-CloudScheduler`: This header will be set to true.
+ #
+ # If the job has an body, Cloud Scheduler sets
+ # the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explictly
+ # setting `Content-Type` to a particular media type when the job is
+ # created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Scheduler. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below are output only. They cannot be set or overridden:
+ #
+ # * `X-Google-*`: For Google internal use only.
+ # * `X-AppEngine-*`: For Google internal use only.
+ #
+ # In addition, some App Engine headers, which contain
+ # job-specific information, are also be sent to the job handler.
+ "a_key": "A String",
+ },
},
"lastAttemptTime": "A String", # Output only. The time the last job attempt started.
"state": "A String", # Output only. State of the job.
@@ -2131,9 +2089,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),
@@ -2180,7 +2136,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.
#
@@ -2216,7 +2172,23 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
+ "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.
}
updateMask: string, A mask used to specify which fields of the job are being updated.
@@ -2248,28 +2220,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.
@@ -2289,7 +2245,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.
@@ -2342,9 +2298,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
@@ -2384,40 +2338,8 @@
# 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.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values. Headers can be set
- # when the job is created.
- #
- # Cloud Scheduler sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Scheduler will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- # * `X-CloudScheduler`: This header will be set to true.
- #
- # If the job has an body, Cloud Scheduler sets
- # the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explictly
- # setting `Content-Type` to a particular media type when the job is
- # created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Scheduler. This value is
- # output only. It cannot be changed.
- #
- # The headers below are output only. They cannot be set or overridden:
- #
- # * `X-Google-*`: For Google internal use only.
- # * `X-AppEngine-*`: For Google internal use only.
- #
- # In addition, some App Engine headers, which contain
- # job-specific information, are also be sent to the job handler.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.
#
# For more information about services, versions, and instances see
@@ -2450,17 +2372,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
@@ -2515,8 +2437,40 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values. Headers can be set
+ # when the job is created.
+ #
+ # Cloud Scheduler sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Scheduler will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ # * `X-CloudScheduler`: This header will be set to true.
+ #
+ # If the job has an body, Cloud Scheduler sets
+ # the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explictly
+ # setting `Content-Type` to a particular media type when the job is
+ # created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Scheduler. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below are output only. They cannot be set or overridden:
+ #
+ # * `X-Google-*`: For Google internal use only.
+ # * `X-AppEngine-*`: For Google internal use only.
+ #
+ # In addition, some App Engine headers, which contain
+ # job-specific information, are also be sent to the job handler.
+ "a_key": "A String",
+ },
},
"lastAttemptTime": "A String", # Output only. The time the last job attempt started.
"state": "A String", # Output only. State of the job.
@@ -2532,9 +2486,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),
@@ -2581,7 +2533,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,7 +2569,23 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
+ "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.
}</pre>
</div>
@@ -2632,9 +2600,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:
@@ -2670,28 +2636,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.
@@ -2711,7 +2661,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.
@@ -2764,9 +2714,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
@@ -2806,40 +2754,8 @@
# 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.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values. Headers can be set
- # when the job is created.
- #
- # Cloud Scheduler sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Scheduler will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- # * `X-CloudScheduler`: This header will be set to true.
- #
- # If the job has an body, Cloud Scheduler sets
- # the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explictly
- # setting `Content-Type` to a particular media type when the job is
- # created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Scheduler. This value is
- # output only. It cannot be changed.
- #
- # The headers below are output only. They cannot be set or overridden:
- #
- # * `X-Google-*`: For Google internal use only.
- # * `X-AppEngine-*`: For Google internal use only.
- #
- # In addition, some App Engine headers, which contain
- # job-specific information, are also be sent to the job handler.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.
#
# For more information about services, versions, and instances see
@@ -2872,17 +2788,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
@@ -2937,8 +2853,40 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values. Headers can be set
+ # when the job is created.
+ #
+ # Cloud Scheduler sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Scheduler will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ # * `X-CloudScheduler`: This header will be set to true.
+ #
+ # If the job has an body, Cloud Scheduler sets
+ # the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explictly
+ # setting `Content-Type` to a particular media type when the job is
+ # created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Scheduler. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below are output only. They cannot be set or overridden:
+ #
+ # * `X-Google-*`: For Google internal use only.
+ # * `X-AppEngine-*`: For Google internal use only.
+ #
+ # In addition, some App Engine headers, which contain
+ # job-specific information, are also be sent to the job handler.
+ "a_key": "A String",
+ },
},
"lastAttemptTime": "A String", # Output only. The time the last job attempt started.
"state": "A String", # Output only. State of the job.
@@ -2954,9 +2902,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),
@@ -3003,7 +2949,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.
#
@@ -3039,7 +2985,23 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
+ "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.
}</pre>
</div>
@@ -3053,9 +3015,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:
@@ -3091,28 +3051,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.
@@ -3132,7 +3076,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.
@@ -3185,9 +3129,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
@@ -3227,40 +3169,8 @@
# 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.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values. Headers can be set
- # when the job is created.
- #
- # Cloud Scheduler sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Scheduler will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- # * `X-CloudScheduler`: This header will be set to true.
- #
- # If the job has an body, Cloud Scheduler sets
- # the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explictly
- # setting `Content-Type` to a particular media type when the job is
- # created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Scheduler. This value is
- # output only. It cannot be changed.
- #
- # The headers below are output only. They cannot be set or overridden:
- #
- # * `X-Google-*`: For Google internal use only.
- # * `X-AppEngine-*`: For Google internal use only.
- #
- # In addition, some App Engine headers, which contain
- # job-specific information, are also be sent to the job handler.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.
#
# For more information about services, versions, and instances see
@@ -3293,17 +3203,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
@@ -3358,8 +3268,40 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values. Headers can be set
+ # when the job is created.
+ #
+ # Cloud Scheduler sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Scheduler will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ # * `X-CloudScheduler`: This header will be set to true.
+ #
+ # If the job has an body, Cloud Scheduler sets
+ # the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explictly
+ # setting `Content-Type` to a particular media type when the job is
+ # created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Scheduler. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below are output only. They cannot be set or overridden:
+ #
+ # * `X-Google-*`: For Google internal use only.
+ # * `X-AppEngine-*`: For Google internal use only.
+ #
+ # In addition, some App Engine headers, which contain
+ # job-specific information, are also be sent to the job handler.
+ "a_key": "A String",
+ },
},
"lastAttemptTime": "A String", # Output only. The time the last job attempt started.
"state": "A String", # Output only. State of the job.
@@ -3375,9 +3317,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),
@@ -3424,7 +3364,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.
#
@@ -3460,7 +3400,23 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
+ "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.
}</pre>
</div>
@@ -3472,9 +3428,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:
@@ -3511,28 +3465,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.
@@ -3552,7 +3490,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
@@ -3647,40 +3583,8 @@
# 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.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values. Headers can be set
- # when the job is created.
- #
- # Cloud Scheduler sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Scheduler will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- # * `X-CloudScheduler`: This header will be set to true.
- #
- # If the job has an body, Cloud Scheduler sets
- # the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explictly
- # setting `Content-Type` to a particular media type when the job is
- # created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Scheduler. This value is
- # output only. It cannot be changed.
- #
- # The headers below are output only. They cannot be set or overridden:
- #
- # * `X-Google-*`: For Google internal use only.
- # * `X-AppEngine-*`: For Google internal use only.
- #
- # In addition, some App Engine headers, which contain
- # job-specific information, are also be sent to the job handler.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
+ # permitted.
"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.
#
# For more information about services, versions, and instances see
@@ -3713,17 +3617,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
@@ -3778,8 +3682,40 @@
# 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.
- "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not
- # permitted.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values. Headers can be set
+ # when the job is created.
+ #
+ # Cloud Scheduler sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Scheduler will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ # * `X-CloudScheduler`: This header will be set to true.
+ #
+ # If the job has an body, Cloud Scheduler sets
+ # the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explictly
+ # setting `Content-Type` to a particular media type when the job is
+ # created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Scheduler. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below are output only. They cannot be set or overridden:
+ #
+ # * `X-Google-*`: For Google internal use only.
+ # * `X-AppEngine-*`: For Google internal use only.
+ #
+ # In addition, some App Engine headers, which contain
+ # job-specific information, are also be sent to the job handler.
+ "a_key": "A String",
+ },
},
"lastAttemptTime": "A String", # Output only. The time the last job attempt started.
"state": "A String", # Output only. State of the job.
@@ -3795,9 +3731,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),
@@ -3844,7 +3778,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.
#
@@ -3880,7 +3814,23 @@
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
- "userUpdateTime": "A String", # Output only. The creation time of the job.
+ "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.
}</pre>
</div>