chore: regens API reference docs (#889)
diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html
index a354d55..12c0421 100644
--- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html
+++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html
@@ -75,13 +75,13 @@
<h1><a href="cloudtasks_v2beta2.html">Cloud Tasks API</a> . <a href="cloudtasks_v2beta2.projects.html">projects</a> . <a href="cloudtasks_v2beta2.projects.locations.html">locations</a> . <a href="cloudtasks_v2beta2.projects.locations.queues.html">queues</a> . <a href="cloudtasks_v2beta2.projects.locations.queues.tasks.html">tasks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#acknowledge">acknowledge(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#acknowledge">acknowledge(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Acknowledges a pull task.</p>
<p class="toc_element">
- <code><a href="#cancelLease">cancelLease(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#cancelLease">cancelLease(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancel a pull task's lease.</p>
<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 task and adds it to a queue.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -90,23 +90,23 @@
<code><a href="#get">get(name, responseView=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a task.</p>
<p class="toc_element">
- <code><a href="#lease">lease(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#lease">lease(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Leases tasks from a pull queue for</p>
<p class="toc_element">
- <code><a href="#list">list(parent, responseView=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, responseView=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">Lists the tasks in a queue.</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="#renewLease">renewLease(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#renewLease">renewLease(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Renew the current lease of a pull task.</p>
<p class="toc_element">
- <code><a href="#run">run(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#run">run(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Forces a task to run now.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="acknowledge">acknowledge(name, body, x__xgafv=None)</code>
+ <code class="details" id="acknowledge">acknowledge(name, body=None, x__xgafv=None)</code>
<pre>Acknowledges a pull task.
The worker, that is, the entity that
@@ -122,18 +122,14 @@
ListTasks.
Args:
- name: string, Required.
-
-The task name. For example:
+ name: string, Required. The task name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message for acknowledging a task using
# AcknowledgeTask.
- "scheduleTime": "A String", # Required.
- #
- # The task's current schedule time, available in the
+ "scheduleTime": "A String", # Required. The task's current schedule time, available in the
# schedule_time returned by
# LeaseTasks response or
# RenewLease response. This restriction is
@@ -161,7 +157,7 @@
</div>
<div class="method">
- <code class="details" id="cancelLease">cancelLease(name, body, x__xgafv=None)</code>
+ <code class="details" id="cancelLease">cancelLease(name, body=None, x__xgafv=None)</code>
<pre>Cancel a pull task's lease.
The worker can use this method to cancel a task's lease by
@@ -170,18 +166,14 @@
LeaseTasks.
Args:
- name: string, Required.
-
-The task name. For example:
+ name: string, Required. The task name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message for canceling a lease using
# CancelLease.
- "scheduleTime": "A String", # Required.
- #
- # The task's current schedule time, available in the
+ "scheduleTime": "A String", # Required. The task's current schedule time, available in the
# schedule_time returned by
# LeaseTasks response or
# RenewLease response. This restriction is
@@ -216,6 +208,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -237,12 +235,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
#
@@ -253,6 +245,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -274,12 +272,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
#
@@ -355,10 +347,10 @@
# delivered to can be set at the queue-level or task-level:
#
# * If set,
- # app_engine_routing_override
- # is used for all tasks in the queue, no matter what the setting
- # is for the
- # task-level app_engine_routing.
+ # app_engine_routing_override
+ # is used for all tasks in the queue, no matter what the setting
+ # is for the
+ # task-level app_engine_routing.
#
#
# The `url` that the task will be sent to is:
@@ -393,17 +385,50 @@
# It can contain a path and query string arguments.
# 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. The default is POST.
+ "headers": { # HTTP request headers.
#
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt will fail
- # with error code 405 (Method Not Allowed). See
- # [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the documentation for the request handlers in the language your app is
- # written in e.g.
- # [Python Request
- # Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks 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 Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -445,17 +470,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
# queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
@@ -536,50 +561,14 @@
# body, and thus a payload, is allowed only if the HTTP method is
# POST or PUT. It is an error to set a data payload on a task with
# an incompatible HttpMethod.
- "headers": { # HTTP request headers.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks 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 Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
+ # The app's request handler for the task's target URL must be able to handle
+ # HTTP requests with this http_method, otherwise the task attempt fails with
+ # error code 405 (Method Not Allowed). See [Writing a push task request
+ # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+ # and the App Engine documentation for your runtime on [How Requests are
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
"name": "A String", # Optionally caller-specified in CreateTask.
#
@@ -620,7 +609,7 @@
</div>
<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 task and adds it to a queue.
Tasks cannot be updated after creation; there is no UpdateTask command.
@@ -630,13 +619,11 @@
* For pull queues, the maximum task size is 1MB.
Args:
- parent: string, Required.
-
-The queue name. For example:
+ parent: string, Required. The queue name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
The queue must already exist. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message for CreateTask.
@@ -652,9 +639,7 @@
# Authorization for FULL requires
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
# permission on the Task resource.
- "task": { # A unit of scheduled work. # Required.
- #
- # The task to add.
+ "task": { # A unit of scheduled work. # Required. The task to add.
#
# Task names have the following format:
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
@@ -694,6 +679,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -715,12 +706,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
#
@@ -731,6 +716,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -752,12 +743,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
#
@@ -833,10 +818,10 @@
# delivered to can be set at the queue-level or task-level:
#
# * If set,
- # app_engine_routing_override
- # is used for all tasks in the queue, no matter what the setting
- # is for the
- # task-level app_engine_routing.
+ # app_engine_routing_override
+ # is used for all tasks in the queue, no matter what the setting
+ # is for the
+ # task-level app_engine_routing.
#
#
# The `url` that the task will be sent to is:
@@ -871,17 +856,50 @@
# It can contain a path and query string arguments.
# 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. The default is POST.
+ "headers": { # HTTP request headers.
#
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt will fail
- # with error code 405 (Method Not Allowed). See
- # [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the documentation for the request handlers in the language your app is
- # written in e.g.
- # [Python Request
- # Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks 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 Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -923,17 +941,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
# queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
@@ -1014,50 +1032,14 @@
# body, and thus a payload, is allowed only if the HTTP method is
# POST or PUT. It is an error to set a data payload on a task with
# an incompatible HttpMethod.
- "headers": { # HTTP request headers.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks 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 Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
+ # The app's request handler for the task's target URL must be able to handle
+ # HTTP requests with this http_method, otherwise the task attempt fails with
+ # error code 405 (Method Not Allowed). See [Writing a push task request
+ # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+ # and the App Engine documentation for your runtime on [How Requests are
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
"name": "A String", # Optionally caller-specified in CreateTask.
#
@@ -1113,6 +1095,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -1134,12 +1122,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
#
@@ -1150,6 +1132,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -1171,12 +1159,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
#
@@ -1252,10 +1234,10 @@
# delivered to can be set at the queue-level or task-level:
#
# * If set,
- # app_engine_routing_override
- # is used for all tasks in the queue, no matter what the setting
- # is for the
- # task-level app_engine_routing.
+ # app_engine_routing_override
+ # is used for all tasks in the queue, no matter what the setting
+ # is for the
+ # task-level app_engine_routing.
#
#
# The `url` that the task will be sent to is:
@@ -1290,17 +1272,50 @@
# It can contain a path and query string arguments.
# 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. The default is POST.
+ "headers": { # HTTP request headers.
#
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt will fail
- # with error code 405 (Method Not Allowed). See
- # [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the documentation for the request handlers in the language your app is
- # written in e.g.
- # [Python Request
- # Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks 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 Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -1342,17 +1357,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
# queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
@@ -1433,50 +1448,14 @@
# body, and thus a payload, is allowed only if the HTTP method is
# POST or PUT. It is an error to set a data payload on a task with
# an incompatible HttpMethod.
- "headers": { # HTTP request headers.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks 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 Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
+ # The app's request handler for the task's target URL must be able to handle
+ # HTTP requests with this http_method, otherwise the task attempt fails with
+ # error code 405 (Method Not Allowed). See [Writing a push task request
+ # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+ # and the App Engine documentation for your runtime on [How Requests are
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
"name": "A String", # Optionally caller-specified in CreateTask.
#
@@ -1525,9 +1504,7 @@
failed.
Args:
- name: string, Required.
-
-The task name. For example:
+ name: string, Required. The task name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -1554,9 +1531,7 @@
<pre>Gets a task.
Args:
- name: string, Required.
-
-The task name. For example:
+ name: string, Required. The task name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` (required)
responseView: string, The response_view specifies which subset of the Task will be
returned.
@@ -1586,6 +1561,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -1607,12 +1588,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
#
@@ -1623,6 +1598,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -1644,12 +1625,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
#
@@ -1725,10 +1700,10 @@
# delivered to can be set at the queue-level or task-level:
#
# * If set,
- # app_engine_routing_override
- # is used for all tasks in the queue, no matter what the setting
- # is for the
- # task-level app_engine_routing.
+ # app_engine_routing_override
+ # is used for all tasks in the queue, no matter what the setting
+ # is for the
+ # task-level app_engine_routing.
#
#
# The `url` that the task will be sent to is:
@@ -1763,17 +1738,50 @@
# It can contain a path and query string arguments.
# 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. The default is POST.
+ "headers": { # HTTP request headers.
#
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt will fail
- # with error code 405 (Method Not Allowed). See
- # [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the documentation for the request handlers in the language your app is
- # written in e.g.
- # [Python Request
- # Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks 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 Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -1815,17 +1823,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
# queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
@@ -1906,50 +1914,14 @@
# body, and thus a payload, is allowed only if the HTTP method is
# POST or PUT. It is an error to set a data payload on a task with
# an incompatible HttpMethod.
- "headers": { # HTTP request headers.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks 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 Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
+ # The app's request handler for the task's target URL must be able to handle
+ # HTTP requests with this http_method, otherwise the task attempt fails with
+ # error code 405 (Method Not Allowed). See [Writing a push task request
+ # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+ # and the App Engine documentation for your runtime on [How Requests are
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
"name": "A String", # Optionally caller-specified in CreateTask.
#
@@ -1990,7 +1962,7 @@
</div>
<div class="method">
- <code class="details" id="lease">lease(parent, body, x__xgafv=None)</code>
+ <code class="details" id="lease">lease(parent, body=None, x__xgafv=None)</code>
<pre>Leases tasks from a pull queue for
lease_duration.
@@ -2015,29 +1987,17 @@
is exceeded.
Args:
- parent: string, Required.
-
-The queue name. For example:
+ parent: string, Required. The queue name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message for leasing tasks using LeaseTasks.
- "maxTasks": 42, # The maximum number of tasks to lease.
- #
- # The system will make a best effort to return as close to as
- # `max_tasks` as possible.
- #
- # The largest that `max_tasks` can be is 1000.
- #
- # The maximum total size of a lease tasks response is
- # 32 MB. If the sum of all task sizes requested reaches this limit,
- # fewer tasks than requested are returned.
"filter": "A String", # `filter` can be used to specify a subset of tasks to lease.
#
- # When `filter` is set to `tag=<my-tag>` then the
+ # When `filter` is set to `tag=<my-tag>` then the
# response will contain only tasks whose
- # tag is equal to `<my-tag>`. `<my-tag>` must be
+ # tag is equal to `<my-tag>`. `<my-tag>` must be
# less than 500 characters.
#
# When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
@@ -2062,6 +2022,16 @@
# aren't UTF-8 encoded can't be used in the
# filter and the task's
# tag will be displayed as empty in Cloud Tasks.
+ "maxTasks": 42, # The maximum number of tasks to lease.
+ #
+ # The system will make a best effort to return as close to as
+ # `max_tasks` as possible.
+ #
+ # The largest that `max_tasks` can be is 1000.
+ #
+ # The maximum total size of a lease tasks response is
+ # 32 MB. If the sum of all task sizes requested reaches this limit,
+ # fewer tasks than requested are returned.
"responseView": "A String", # The response_view specifies which subset of the Task will be
# returned.
#
@@ -2074,7 +2044,16 @@
# Authorization for FULL requires
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
# permission on the Task resource.
- "leaseDuration": "A String", #
+ "leaseDuration": "A String", # Required. The duration of the lease.
+ #
+ # Each task returned in the response will
+ # have its schedule_time set to the current
+ # time plus the `lease_duration`. The task is leased until its
+ # schedule_time; thus, the task will not be
+ # returned to another LeaseTasks call
+ # before its schedule_time.
+ #
+ #
# After the worker has successfully finished the work associated
# with the task, the worker must call via
# AcknowledgeTask before the
@@ -2104,6 +2083,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -2125,12 +2110,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
#
@@ -2141,6 +2120,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -2162,12 +2147,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
#
@@ -2243,10 +2222,10 @@
# delivered to can be set at the queue-level or task-level:
#
# * If set,
- # app_engine_routing_override
- # is used for all tasks in the queue, no matter what the setting
- # is for the
- # task-level app_engine_routing.
+ # app_engine_routing_override
+ # is used for all tasks in the queue, no matter what the setting
+ # is for the
+ # task-level app_engine_routing.
#
#
# The `url` that the task will be sent to is:
@@ -2281,17 +2260,50 @@
# It can contain a path and query string arguments.
# 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. The default is POST.
+ "headers": { # HTTP request headers.
#
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt will fail
- # with error code 405 (Method Not Allowed). See
- # [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the documentation for the request handlers in the language your app is
- # written in e.g.
- # [Python Request
- # Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks 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 Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -2333,17 +2345,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
# queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
@@ -2424,50 +2436,14 @@
# body, and thus a payload, is allowed only if the HTTP method is
# POST or PUT. It is an error to set a data payload on a task with
# an incompatible HttpMethod.
- "headers": { # HTTP request headers.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks 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 Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
+ # The app's request handler for the task's target URL must be able to handle
+ # HTTP requests with this http_method, otherwise the task attempt fails with
+ # error code 405 (Method Not Allowed). See [Writing a push task request
+ # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+ # and the App Engine documentation for your runtime on [How Requests are
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
"name": "A String", # Optionally caller-specified in CreateTask.
#
@@ -2510,7 +2486,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent, responseView=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, responseView=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>Lists the tasks in a queue.
By default, only the BASIC view is retrieved
@@ -2522,9 +2498,7 @@
time.
Args:
- parent: string, Required.
-
-The queue name. For example:
+ parent: string, Required. The queue name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` (required)
responseView: string, The response_view specifies which subset of the Task will be
returned.
@@ -2538,14 +2512,6 @@
Authorization for FULL requires
`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
permission on the Task resource.
- pageSize: integer, Maximum page size.
-
-Fewer tasks than requested might be returned, even if more tasks exist; use
-next_page_token in the response to
-determine if more tasks exist.
-
-The maximum page size is 1000. If unspecified, the page size will be the
-maximum.
pageToken: string, A token identifying the page of results to return.
To request the first page results, page_token must be empty. To
@@ -2559,6 +2525,14 @@
Allowed values
1 - v1 error format
2 - v2 error format
+ pageSize: integer, Maximum page size.
+
+Fewer tasks than requested might be returned, even if more tasks exist; use
+next_page_token in the response to
+determine if more tasks exist.
+
+The maximum page size is 1000. If unspecified, the page size will be the
+maximum.
Returns:
An object of the form:
@@ -2580,6 +2554,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -2601,12 +2581,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
#
@@ -2617,6 +2591,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -2638,12 +2618,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
#
@@ -2719,10 +2693,10 @@
# delivered to can be set at the queue-level or task-level:
#
# * If set,
- # app_engine_routing_override
- # is used for all tasks in the queue, no matter what the setting
- # is for the
- # task-level app_engine_routing.
+ # app_engine_routing_override
+ # is used for all tasks in the queue, no matter what the setting
+ # is for the
+ # task-level app_engine_routing.
#
#
# The `url` that the task will be sent to is:
@@ -2757,17 +2731,50 @@
# It can contain a path and query string arguments.
# 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. The default is POST.
+ "headers": { # HTTP request headers.
#
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt will fail
- # with error code 405 (Method Not Allowed). See
- # [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the documentation for the request handlers in the language your app is
- # written in e.g.
- # [Python Request
- # Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks 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 Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -2809,17 +2816,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
# queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
@@ -2900,50 +2907,14 @@
# body, and thus a payload, is allowed only if the HTTP method is
# POST or PUT. It is an error to set a data payload on a task with
# an incompatible HttpMethod.
- "headers": { # HTTP request headers.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks 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 Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
+ # The app's request handler for the task's target URL must be able to handle
+ # HTTP requests with this http_method, otherwise the task attempt fails with
+ # error code 405 (Method Not Allowed). See [Writing a push task request
+ # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+ # and the App Engine documentation for your runtime on [How Requests are
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
"name": "A String", # Optionally caller-specified in CreateTask.
#
@@ -3000,7 +2971,7 @@
</div>
<div class="method">
- <code class="details" id="renewLease">renewLease(name, body, x__xgafv=None)</code>
+ <code class="details" id="renewLease">renewLease(name, body=None, x__xgafv=None)</code>
<pre>Renew the current lease of a pull task.
The worker can use this method to extend the lease by a new
@@ -3008,18 +2979,14 @@
returned in the task's schedule_time.
Args:
- name: string, Required.
-
-The task name. For example:
+ name: string, Required. The task name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message for renewing a lease using
# RenewLease.
- "scheduleTime": "A String", # Required.
- #
- # The task's current schedule time, available in the
+ "scheduleTime": "A String", # Required. The task's current schedule time, available in the
# schedule_time returned by
# LeaseTasks response or
# RenewLease response. This restriction is
@@ -3036,9 +3003,7 @@
# Authorization for FULL requires
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
# permission on the Task resource.
- "leaseDuration": "A String", # Required.
- #
- # The desired new lease duration, starting from now.
+ "leaseDuration": "A String", # Required. The desired new lease duration, starting from now.
#
#
# The maximum lease duration is 1 week.
@@ -3061,6 +3026,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -3082,12 +3053,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
#
@@ -3098,6 +3063,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -3119,12 +3090,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
#
@@ -3200,10 +3165,10 @@
# delivered to can be set at the queue-level or task-level:
#
# * If set,
- # app_engine_routing_override
- # is used for all tasks in the queue, no matter what the setting
- # is for the
- # task-level app_engine_routing.
+ # app_engine_routing_override
+ # is used for all tasks in the queue, no matter what the setting
+ # is for the
+ # task-level app_engine_routing.
#
#
# The `url` that the task will be sent to is:
@@ -3238,17 +3203,50 @@
# It can contain a path and query string arguments.
# 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. The default is POST.
+ "headers": { # HTTP request headers.
#
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt will fail
- # with error code 405 (Method Not Allowed). See
- # [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the documentation for the request handlers in the language your app is
- # written in e.g.
- # [Python Request
- # Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks 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 Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -3290,17 +3288,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
# queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
@@ -3381,50 +3379,14 @@
# body, and thus a payload, is allowed only if the HTTP method is
# POST or PUT. It is an error to set a data payload on a task with
# an incompatible HttpMethod.
- "headers": { # HTTP request headers.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks 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 Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
+ # The app's request handler for the task's target URL must be able to handle
+ # HTTP requests with this http_method, otherwise the task attempt fails with
+ # error code 405 (Method Not Allowed). See [Writing a push task request
+ # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+ # and the App Engine documentation for your runtime on [How Requests are
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
"name": "A String", # Optionally caller-specified in CreateTask.
#
@@ -3465,7 +3427,7 @@
</div>
<div class="method">
- <code class="details" id="run">run(name, body, x__xgafv=None)</code>
+ <code class="details" id="run">run(name, body=None, x__xgafv=None)</code>
<pre>Forces a task to run now.
When this method is called, Cloud Tasks will dispatch the task, even if
@@ -3495,11 +3457,9 @@
pull task.
Args:
- name: string, Required.
-
-The task name. For example:
+ name: string, Required. The task name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message for forcing a task to run now using
@@ -3534,6 +3494,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -3555,12 +3521,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
#
@@ -3571,6 +3531,12 @@
"scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
#
# `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
"responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
#
# If the task has not been attempted or the task is currently running
@@ -3592,12 +3558,6 @@
},
],
},
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
},
"attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
#
@@ -3673,10 +3633,10 @@
# delivered to can be set at the queue-level or task-level:
#
# * If set,
- # app_engine_routing_override
- # is used for all tasks in the queue, no matter what the setting
- # is for the
- # task-level app_engine_routing.
+ # app_engine_routing_override
+ # is used for all tasks in the queue, no matter what the setting
+ # is for the
+ # task-level app_engine_routing.
#
#
# The `url` that the task will be sent to is:
@@ -3711,17 +3671,50 @@
# It can contain a path and query string arguments.
# 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. The default is POST.
+ "headers": { # HTTP request headers.
#
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt will fail
- # with error code 405 (Method Not Allowed). See
- # [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the documentation for the request handlers in the language your app is
- # written in e.g.
- # [Python Request
- # Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks 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 Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -3763,17 +3756,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
# queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
@@ -3854,50 +3847,14 @@
# body, and thus a payload, is allowed only if the HTTP method is
# POST or PUT. It is an error to set a data payload on a task with
# an incompatible HttpMethod.
- "headers": { # HTTP request headers.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks 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 Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
+ # The app's request handler for the task's target URL must be able to handle
+ # HTTP requests with this http_method, otherwise the task attempt fails with
+ # error code 405 (Method Not Allowed). See [Writing a push task request
+ # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+ # and the App Engine documentation for your runtime on [How Requests are
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
"name": "A String", # Optionally caller-specified in CreateTask.
#