chore: regens API reference docs (#889)
diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
index 6a3e4d0..512dfb4 100644
--- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
+++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
@@ -75,7 +75,7 @@
<h1><a href="cloudtasks_v2beta3.html">Cloud Tasks API</a> . <a href="cloudtasks_v2beta3.projects.html">projects</a> . <a href="cloudtasks_v2beta3.projects.locations.html">locations</a> . <a href="cloudtasks_v2beta3.projects.locations.queues.html">queues</a> . <a href="cloudtasks_v2beta3.projects.locations.queues.tasks.html">tasks</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 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,11 +90,11 @@
<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="#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="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.
@@ -102,13 +102,11 @@
* The maximum task size is 100KB.
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.
@@ -124,9 +122,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`.
@@ -165,7 +161,7 @@
#
# The task will be pushed to the worker as an HTTP request. If the worker
# or the redirected worker acknowledges the task by returning a successful HTTP
- # response code ([`200` - `299`]), the task will removed from the queue. If
+ # response code ([`200` - `299`]), the task will be removed from the queue. If
# any other HTTP response code is returned or no response is received, the
# task will be retried according to the following:
#
@@ -178,13 +174,13 @@
#
# System throttling happens because:
#
- # * Cloud Tasks backoffs on all errors. Normally the backoff specified in
+ # * Cloud Tasks backs off on all errors. Normally the backoff specified in
# rate limits will be used. But if the worker returns
# `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
# errors is high, Cloud Tasks will use a higher backoff rate. The retry
# specified in the `Retry-After` HTTP response header is considered.
#
- # * To prevent traffic spikes and to smooth sudden large traffic spikes,
+ # * To prevent traffic spikes and to smooth sudden increases in traffic,
# dispatches ramp up slowly when the queue is newly created or idle and
# if large numbers of tasks suddenly become available to dispatch (due to
# spikes in create task rates, the queue being unpaused, or many tasks
@@ -194,7 +190,36 @@
# A request body is allowed only if the
# HTTP method is POST, PUT, or PATCH. It is an
# error to set body on a task with an incompatible HttpMethod.
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ #
+ # These headers represent a subset of the headers that will accompany the
+ # task's HTTP request. Some HTTP request headers will be ignored or replaced.
+ #
+ # A partial list of headers that will be ignored or replaced is:
+ #
+ # * Host: This will be computed by Cloud Tasks and derived from
+ # HttpRequest.url.
+ # * Content-Length: This will be computed by Cloud Tasks.
+ # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
+ # * X-Google-*: Google use only.
+ # * X-AppEngine-*: Google use only.
+ #
+ # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
+ # `Content-Type` to a media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/octet-stream"` or
+ # `"application/json"`.
+ #
+ # Headers which can have multiple values (according to RFC2616) can be
+ # specified using comma-separated values.
+ #
+ # The size of the headers must be less than 80KB.
+ "a_key": "A String",
+ },
"url": "A String", # Required. The full url path that the request will be sent to.
#
# This string must begin with either "http://" or "https://". Some examples
@@ -244,36 +269,7 @@
# caller must have iam.serviceAccounts.actAs permission for the service
# account.
},
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- #
- # These headers represent a subset of the headers that will accompany the
- # task's HTTP request. Some HTTP request headers will be ignored or replaced.
- #
- # A partial list of headers that will be ignored or replaced is:
- #
- # * Host: This will be computed by Cloud Tasks and derived from
- # HttpRequest.url.
- # * Content-Length: This will be computed by Cloud Tasks.
- # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
- # * X-Google-*: Google use only.
- # * X-AppEngine-*: Google use only.
- #
- # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
- # `Content-Type` to a media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/octet-stream"` or
- # `"application/json"`.
- #
- # Headers which can have multiple values (according to RFC2616) can be
- # specified using comma-separated values.
- #
- # The size of the headers must be less than 80KB.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
},
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
@@ -306,10 +302,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:
@@ -342,50 +338,14 @@
#
# A request body is allowed only if the HTTP method is POST or PUT. It is
# an error to set a body 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 body, 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).
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -421,7 +381,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -468,116 +428,51 @@
# It can contain a path and query string arguments.
# If the relative URI 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).
- },
- "name": "A String", # Optionally caller-specified in CreateTask.
- #
- # The task name.
- #
- # The task name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
- "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
- #
- # For App Engine queues, this is when the task will be attempted or retried.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
- "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ # 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.
#
- # `schedule_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 worker for this attempt.
+ # Cloud Tasks sets some headers to default values:
#
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
+ # * `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`.
#
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
+ # If the task has a body, 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/tasks/docs/creating-appengine-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",
},
- "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.
},
- "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
- # respond by this deadline then the request is cancelled and the attempt
- # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
- # task according to the RetryConfig.
- #
- # Note that when the request is cancelled, Cloud Tasks will stop listing for
- # the response, but whether the worker stops processing depends on the
- # worker. For example, if the worker is stuck, it may not react to cancelled
- # requests.
- #
- # The default and maximum values depend on the type of request:
- #
- # * For HTTP tasks, the default is 10 minutes. The deadline
- # must be in the interval [15 seconds, 30 minutes].
- #
- # * For App Engine tasks, 0 indicates that the
- # request has the default deadline. The default deadline depends on the
- # [scaling
- # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
- # of the service: 10 minutes for standard apps with automatic scaling, 24
- # hours for standard apps with manual and basic scaling, and 60 minutes for
- # flex apps. If the request deadline is set, it must be in the interval [15
- # seconds, 24 hours 15 seconds]. Regardless of the task's
- # `dispatch_deadline`, the app handler will not run for longer than than
- # the service's timeout. We recommend setting the `dispatch_deadline` to
- # at most a few seconds more than the app handler's timeout. For more
- # information see
- # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
- #
- # `dispatch_deadline` will be truncated to the nearest millisecond. The
- # deadline is an approximate deadline.
- "responseCount": 42, # Output only. The number of attempts which have received a response.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "dispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
"firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
#
# Only dispatch_time will be set.
@@ -613,6 +508,104 @@
#
# `dispatch_time` will be truncated to the nearest microsecond.
},
+ "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_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 worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "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.
+ },
+ "name": "A String", # Optionally caller-specified in CreateTask.
+ #
+ # The task name.
+ #
+ # The task name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
+ "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
+ #
+ # For App Engine queues, this is when the task will be attempted or retried.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
+ # respond by this deadline then the request is cancelled and the attempt
+ # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
+ # task according to the RetryConfig.
+ #
+ # Note that when the request is cancelled, Cloud Tasks will stop listing for
+ # the response, but whether the worker stops processing depends on the
+ # worker. For example, if the worker is stuck, it may not react to cancelled
+ # requests.
+ #
+ # The default and maximum values depend on the type of request:
+ #
+ # * For HTTP tasks, the default is 10 minutes. The deadline
+ # must be in the interval [15 seconds, 30 minutes].
+ #
+ # * For App Engine tasks, 0 indicates that the
+ # request has the default deadline. The default deadline depends on the
+ # [scaling
+ # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
+ # of the service: 10 minutes for standard apps with automatic scaling, 24
+ # hours for standard apps with manual and basic scaling, and 60 minutes for
+ # flex apps. If the request deadline is set, it must be in the interval [15
+ # seconds, 24 hours 15 seconds]. Regardless of the task's
+ # `dispatch_deadline`, the app handler will not run for longer than than
+ # the service's timeout. We recommend setting the `dispatch_deadline` to
+ # at most a few seconds more than the app handler's timeout. For more
+ # information see
+ # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
+ #
+ # `dispatch_deadline` will be truncated to the nearest millisecond. The
+ # deadline is an approximate deadline.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "dispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "responseCount": 42, # Output only. The number of attempts which have received a response.
},
}
@@ -631,7 +624,7 @@
#
# The task will be pushed to the worker as an HTTP request. If the worker
# or the redirected worker acknowledges the task by returning a successful HTTP
- # response code ([`200` - `299`]), the task will removed from the queue. If
+ # response code ([`200` - `299`]), the task will be removed from the queue. If
# any other HTTP response code is returned or no response is received, the
# task will be retried according to the following:
#
@@ -644,13 +637,13 @@
#
# System throttling happens because:
#
- # * Cloud Tasks backoffs on all errors. Normally the backoff specified in
+ # * Cloud Tasks backs off on all errors. Normally the backoff specified in
# rate limits will be used. But if the worker returns
# `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
# errors is high, Cloud Tasks will use a higher backoff rate. The retry
# specified in the `Retry-After` HTTP response header is considered.
#
- # * To prevent traffic spikes and to smooth sudden large traffic spikes,
+ # * To prevent traffic spikes and to smooth sudden increases in traffic,
# dispatches ramp up slowly when the queue is newly created or idle and
# if large numbers of tasks suddenly become available to dispatch (due to
# spikes in create task rates, the queue being unpaused, or many tasks
@@ -660,7 +653,36 @@
# A request body is allowed only if the
# HTTP method is POST, PUT, or PATCH. It is an
# error to set body on a task with an incompatible HttpMethod.
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ #
+ # These headers represent a subset of the headers that will accompany the
+ # task's HTTP request. Some HTTP request headers will be ignored or replaced.
+ #
+ # A partial list of headers that will be ignored or replaced is:
+ #
+ # * Host: This will be computed by Cloud Tasks and derived from
+ # HttpRequest.url.
+ # * Content-Length: This will be computed by Cloud Tasks.
+ # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
+ # * X-Google-*: Google use only.
+ # * X-AppEngine-*: Google use only.
+ #
+ # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
+ # `Content-Type` to a media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/octet-stream"` or
+ # `"application/json"`.
+ #
+ # Headers which can have multiple values (according to RFC2616) can be
+ # specified using comma-separated values.
+ #
+ # The size of the headers must be less than 80KB.
+ "a_key": "A String",
+ },
"url": "A String", # Required. The full url path that the request will be sent to.
#
# This string must begin with either "http://" or "https://". Some examples
@@ -710,36 +732,7 @@
# caller must have iam.serviceAccounts.actAs permission for the service
# account.
},
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- #
- # These headers represent a subset of the headers that will accompany the
- # task's HTTP request. Some HTTP request headers will be ignored or replaced.
- #
- # A partial list of headers that will be ignored or replaced is:
- #
- # * Host: This will be computed by Cloud Tasks and derived from
- # HttpRequest.url.
- # * Content-Length: This will be computed by Cloud Tasks.
- # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
- # * X-Google-*: Google use only.
- # * X-AppEngine-*: Google use only.
- #
- # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
- # `Content-Type` to a media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/octet-stream"` or
- # `"application/json"`.
- #
- # Headers which can have multiple values (according to RFC2616) can be
- # specified using comma-separated values.
- #
- # The size of the headers must be less than 80KB.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
},
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
@@ -772,10 +765,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:
@@ -808,50 +801,14 @@
#
# A request body is allowed only if the HTTP method is POST or PUT. It is
# an error to set a body 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 body, 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).
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -887,7 +844,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -934,116 +891,51 @@
# It can contain a path and query string arguments.
# If the relative URI 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).
- },
- "name": "A String", # Optionally caller-specified in CreateTask.
- #
- # The task name.
- #
- # The task name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
- "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
- #
- # For App Engine queues, this is when the task will be attempted or retried.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
- "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ # 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.
#
- # `schedule_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 worker for this attempt.
+ # Cloud Tasks sets some headers to default values:
#
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
+ # * `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`.
#
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
+ # If the task has a body, 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/tasks/docs/creating-appengine-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",
},
- "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.
},
- "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
- # respond by this deadline then the request is cancelled and the attempt
- # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
- # task according to the RetryConfig.
- #
- # Note that when the request is cancelled, Cloud Tasks will stop listing for
- # the response, but whether the worker stops processing depends on the
- # worker. For example, if the worker is stuck, it may not react to cancelled
- # requests.
- #
- # The default and maximum values depend on the type of request:
- #
- # * For HTTP tasks, the default is 10 minutes. The deadline
- # must be in the interval [15 seconds, 30 minutes].
- #
- # * For App Engine tasks, 0 indicates that the
- # request has the default deadline. The default deadline depends on the
- # [scaling
- # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
- # of the service: 10 minutes for standard apps with automatic scaling, 24
- # hours for standard apps with manual and basic scaling, and 60 minutes for
- # flex apps. If the request deadline is set, it must be in the interval [15
- # seconds, 24 hours 15 seconds]. Regardless of the task's
- # `dispatch_deadline`, the app handler will not run for longer than than
- # the service's timeout. We recommend setting the `dispatch_deadline` to
- # at most a few seconds more than the app handler's timeout. For more
- # information see
- # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
- #
- # `dispatch_deadline` will be truncated to the nearest millisecond. The
- # deadline is an approximate deadline.
- "responseCount": 42, # Output only. The number of attempts which have received a response.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "dispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
"firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
#
# Only dispatch_time will be set.
@@ -1079,6 +971,104 @@
#
# `dispatch_time` will be truncated to the nearest microsecond.
},
+ "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_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 worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "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.
+ },
+ "name": "A String", # Optionally caller-specified in CreateTask.
+ #
+ # The task name.
+ #
+ # The task name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
+ "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
+ #
+ # For App Engine queues, this is when the task will be attempted or retried.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
+ # respond by this deadline then the request is cancelled and the attempt
+ # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
+ # task according to the RetryConfig.
+ #
+ # Note that when the request is cancelled, Cloud Tasks will stop listing for
+ # the response, but whether the worker stops processing depends on the
+ # worker. For example, if the worker is stuck, it may not react to cancelled
+ # requests.
+ #
+ # The default and maximum values depend on the type of request:
+ #
+ # * For HTTP tasks, the default is 10 minutes. The deadline
+ # must be in the interval [15 seconds, 30 minutes].
+ #
+ # * For App Engine tasks, 0 indicates that the
+ # request has the default deadline. The default deadline depends on the
+ # [scaling
+ # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
+ # of the service: 10 minutes for standard apps with automatic scaling, 24
+ # hours for standard apps with manual and basic scaling, and 60 minutes for
+ # flex apps. If the request deadline is set, it must be in the interval [15
+ # seconds, 24 hours 15 seconds]. Regardless of the task's
+ # `dispatch_deadline`, the app handler will not run for longer than than
+ # the service's timeout. We recommend setting the `dispatch_deadline` to
+ # at most a few seconds more than the app handler's timeout. For more
+ # information see
+ # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
+ #
+ # `dispatch_deadline` will be truncated to the nearest millisecond. The
+ # deadline is an approximate deadline.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "dispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "responseCount": 42, # Output only. The number of attempts which have received a response.
}</pre>
</div>
@@ -1091,9 +1081,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
@@ -1120,9 +1108,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.
@@ -1151,7 +1137,7 @@
#
# The task will be pushed to the worker as an HTTP request. If the worker
# or the redirected worker acknowledges the task by returning a successful HTTP
- # response code ([`200` - `299`]), the task will removed from the queue. If
+ # response code ([`200` - `299`]), the task will be removed from the queue. If
# any other HTTP response code is returned or no response is received, the
# task will be retried according to the following:
#
@@ -1164,13 +1150,13 @@
#
# System throttling happens because:
#
- # * Cloud Tasks backoffs on all errors. Normally the backoff specified in
+ # * Cloud Tasks backs off on all errors. Normally the backoff specified in
# rate limits will be used. But if the worker returns
# `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
# errors is high, Cloud Tasks will use a higher backoff rate. The retry
# specified in the `Retry-After` HTTP response header is considered.
#
- # * To prevent traffic spikes and to smooth sudden large traffic spikes,
+ # * To prevent traffic spikes and to smooth sudden increases in traffic,
# dispatches ramp up slowly when the queue is newly created or idle and
# if large numbers of tasks suddenly become available to dispatch (due to
# spikes in create task rates, the queue being unpaused, or many tasks
@@ -1180,7 +1166,36 @@
# A request body is allowed only if the
# HTTP method is POST, PUT, or PATCH. It is an
# error to set body on a task with an incompatible HttpMethod.
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ #
+ # These headers represent a subset of the headers that will accompany the
+ # task's HTTP request. Some HTTP request headers will be ignored or replaced.
+ #
+ # A partial list of headers that will be ignored or replaced is:
+ #
+ # * Host: This will be computed by Cloud Tasks and derived from
+ # HttpRequest.url.
+ # * Content-Length: This will be computed by Cloud Tasks.
+ # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
+ # * X-Google-*: Google use only.
+ # * X-AppEngine-*: Google use only.
+ #
+ # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
+ # `Content-Type` to a media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/octet-stream"` or
+ # `"application/json"`.
+ #
+ # Headers which can have multiple values (according to RFC2616) can be
+ # specified using comma-separated values.
+ #
+ # The size of the headers must be less than 80KB.
+ "a_key": "A String",
+ },
"url": "A String", # Required. The full url path that the request will be sent to.
#
# This string must begin with either "http://" or "https://". Some examples
@@ -1230,36 +1245,7 @@
# caller must have iam.serviceAccounts.actAs permission for the service
# account.
},
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- #
- # These headers represent a subset of the headers that will accompany the
- # task's HTTP request. Some HTTP request headers will be ignored or replaced.
- #
- # A partial list of headers that will be ignored or replaced is:
- #
- # * Host: This will be computed by Cloud Tasks and derived from
- # HttpRequest.url.
- # * Content-Length: This will be computed by Cloud Tasks.
- # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
- # * X-Google-*: Google use only.
- # * X-AppEngine-*: Google use only.
- #
- # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
- # `Content-Type` to a media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/octet-stream"` or
- # `"application/json"`.
- #
- # Headers which can have multiple values (according to RFC2616) can be
- # specified using comma-separated values.
- #
- # The size of the headers must be less than 80KB.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
},
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
@@ -1292,10 +1278,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:
@@ -1328,50 +1314,14 @@
#
# A request body is allowed only if the HTTP method is POST or PUT. It is
# an error to set a body 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 body, 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).
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -1407,7 +1357,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -1454,116 +1404,51 @@
# It can contain a path and query string arguments.
# If the relative URI 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).
- },
- "name": "A String", # Optionally caller-specified in CreateTask.
- #
- # The task name.
- #
- # The task name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
- "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
- #
- # For App Engine queues, this is when the task will be attempted or retried.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
- "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ # 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.
#
- # `schedule_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 worker for this attempt.
+ # Cloud Tasks sets some headers to default values:
#
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
+ # * `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`.
#
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
+ # If the task has a body, 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/tasks/docs/creating-appengine-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",
},
- "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.
},
- "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
- # respond by this deadline then the request is cancelled and the attempt
- # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
- # task according to the RetryConfig.
- #
- # Note that when the request is cancelled, Cloud Tasks will stop listing for
- # the response, but whether the worker stops processing depends on the
- # worker. For example, if the worker is stuck, it may not react to cancelled
- # requests.
- #
- # The default and maximum values depend on the type of request:
- #
- # * For HTTP tasks, the default is 10 minutes. The deadline
- # must be in the interval [15 seconds, 30 minutes].
- #
- # * For App Engine tasks, 0 indicates that the
- # request has the default deadline. The default deadline depends on the
- # [scaling
- # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
- # of the service: 10 minutes for standard apps with automatic scaling, 24
- # hours for standard apps with manual and basic scaling, and 60 minutes for
- # flex apps. If the request deadline is set, it must be in the interval [15
- # seconds, 24 hours 15 seconds]. Regardless of the task's
- # `dispatch_deadline`, the app handler will not run for longer than than
- # the service's timeout. We recommend setting the `dispatch_deadline` to
- # at most a few seconds more than the app handler's timeout. For more
- # information see
- # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
- #
- # `dispatch_deadline` will be truncated to the nearest millisecond. The
- # deadline is an approximate deadline.
- "responseCount": 42, # Output only. The number of attempts which have received a response.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "dispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
"firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
#
# Only dispatch_time will be set.
@@ -1599,6 +1484,104 @@
#
# `dispatch_time` will be truncated to the nearest microsecond.
},
+ "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_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 worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "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.
+ },
+ "name": "A String", # Optionally caller-specified in CreateTask.
+ #
+ # The task name.
+ #
+ # The task name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
+ "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
+ #
+ # For App Engine queues, this is when the task will be attempted or retried.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
+ # respond by this deadline then the request is cancelled and the attempt
+ # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
+ # task according to the RetryConfig.
+ #
+ # Note that when the request is cancelled, Cloud Tasks will stop listing for
+ # the response, but whether the worker stops processing depends on the
+ # worker. For example, if the worker is stuck, it may not react to cancelled
+ # requests.
+ #
+ # The default and maximum values depend on the type of request:
+ #
+ # * For HTTP tasks, the default is 10 minutes. The deadline
+ # must be in the interval [15 seconds, 30 minutes].
+ #
+ # * For App Engine tasks, 0 indicates that the
+ # request has the default deadline. The default deadline depends on the
+ # [scaling
+ # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
+ # of the service: 10 minutes for standard apps with automatic scaling, 24
+ # hours for standard apps with manual and basic scaling, and 60 minutes for
+ # flex apps. If the request deadline is set, it must be in the interval [15
+ # seconds, 24 hours 15 seconds]. Regardless of the task's
+ # `dispatch_deadline`, the app handler will not run for longer than than
+ # the service's timeout. We recommend setting the `dispatch_deadline` to
+ # at most a few seconds more than the app handler's timeout. For more
+ # information see
+ # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
+ #
+ # `dispatch_deadline` will be truncated to the nearest millisecond. The
+ # deadline is an approximate deadline.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "dispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "responseCount": 42, # Output only. The number of attempts which have received a response.
}</pre>
</div>
@@ -1615,9 +1598,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.
@@ -1672,7 +1653,7 @@
#
# The task will be pushed to the worker as an HTTP request. If the worker
# or the redirected worker acknowledges the task by returning a successful HTTP
- # response code ([`200` - `299`]), the task will removed from the queue. If
+ # response code ([`200` - `299`]), the task will be removed from the queue. If
# any other HTTP response code is returned or no response is received, the
# task will be retried according to the following:
#
@@ -1685,13 +1666,13 @@
#
# System throttling happens because:
#
- # * Cloud Tasks backoffs on all errors. Normally the backoff specified in
+ # * Cloud Tasks backs off on all errors. Normally the backoff specified in
# rate limits will be used. But if the worker returns
# `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
# errors is high, Cloud Tasks will use a higher backoff rate. The retry
# specified in the `Retry-After` HTTP response header is considered.
#
- # * To prevent traffic spikes and to smooth sudden large traffic spikes,
+ # * To prevent traffic spikes and to smooth sudden increases in traffic,
# dispatches ramp up slowly when the queue is newly created or idle and
# if large numbers of tasks suddenly become available to dispatch (due to
# spikes in create task rates, the queue being unpaused, or many tasks
@@ -1701,7 +1682,36 @@
# A request body is allowed only if the
# HTTP method is POST, PUT, or PATCH. It is an
# error to set body on a task with an incompatible HttpMethod.
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ #
+ # These headers represent a subset of the headers that will accompany the
+ # task's HTTP request. Some HTTP request headers will be ignored or replaced.
+ #
+ # A partial list of headers that will be ignored or replaced is:
+ #
+ # * Host: This will be computed by Cloud Tasks and derived from
+ # HttpRequest.url.
+ # * Content-Length: This will be computed by Cloud Tasks.
+ # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
+ # * X-Google-*: Google use only.
+ # * X-AppEngine-*: Google use only.
+ #
+ # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
+ # `Content-Type` to a media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/octet-stream"` or
+ # `"application/json"`.
+ #
+ # Headers which can have multiple values (according to RFC2616) can be
+ # specified using comma-separated values.
+ #
+ # The size of the headers must be less than 80KB.
+ "a_key": "A String",
+ },
"url": "A String", # Required. The full url path that the request will be sent to.
#
# This string must begin with either "http://" or "https://". Some examples
@@ -1751,36 +1761,7 @@
# caller must have iam.serviceAccounts.actAs permission for the service
# account.
},
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- #
- # These headers represent a subset of the headers that will accompany the
- # task's HTTP request. Some HTTP request headers will be ignored or replaced.
- #
- # A partial list of headers that will be ignored or replaced is:
- #
- # * Host: This will be computed by Cloud Tasks and derived from
- # HttpRequest.url.
- # * Content-Length: This will be computed by Cloud Tasks.
- # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
- # * X-Google-*: Google use only.
- # * X-AppEngine-*: Google use only.
- #
- # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
- # `Content-Type` to a media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/octet-stream"` or
- # `"application/json"`.
- #
- # Headers which can have multiple values (according to RFC2616) can be
- # specified using comma-separated values.
- #
- # The size of the headers must be less than 80KB.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
},
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
@@ -1813,10 +1794,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:
@@ -1849,50 +1830,14 @@
#
# A request body is allowed only if the HTTP method is POST or PUT. It is
# an error to set a body 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 body, 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).
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -1928,7 +1873,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -1975,116 +1920,51 @@
# It can contain a path and query string arguments.
# If the relative URI 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).
- },
- "name": "A String", # Optionally caller-specified in CreateTask.
- #
- # The task name.
- #
- # The task name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
- "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
- #
- # For App Engine queues, this is when the task will be attempted or retried.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
- "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ # 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.
#
- # `schedule_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 worker for this attempt.
+ # Cloud Tasks sets some headers to default values:
#
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
+ # * `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`.
#
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
+ # If the task has a body, 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/tasks/docs/creating-appengine-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",
},
- "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.
},
- "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
- # respond by this deadline then the request is cancelled and the attempt
- # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
- # task according to the RetryConfig.
- #
- # Note that when the request is cancelled, Cloud Tasks will stop listing for
- # the response, but whether the worker stops processing depends on the
- # worker. For example, if the worker is stuck, it may not react to cancelled
- # requests.
- #
- # The default and maximum values depend on the type of request:
- #
- # * For HTTP tasks, the default is 10 minutes. The deadline
- # must be in the interval [15 seconds, 30 minutes].
- #
- # * For App Engine tasks, 0 indicates that the
- # request has the default deadline. The default deadline depends on the
- # [scaling
- # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
- # of the service: 10 minutes for standard apps with automatic scaling, 24
- # hours for standard apps with manual and basic scaling, and 60 minutes for
- # flex apps. If the request deadline is set, it must be in the interval [15
- # seconds, 24 hours 15 seconds]. Regardless of the task's
- # `dispatch_deadline`, the app handler will not run for longer than than
- # the service's timeout. We recommend setting the `dispatch_deadline` to
- # at most a few seconds more than the app handler's timeout. For more
- # information see
- # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
- #
- # `dispatch_deadline` will be truncated to the nearest millisecond. The
- # deadline is an approximate deadline.
- "responseCount": 42, # Output only. The number of attempts which have received a response.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "dispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
"firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
#
# Only dispatch_time will be set.
@@ -2120,6 +2000,104 @@
#
# `dispatch_time` will be truncated to the nearest microsecond.
},
+ "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_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 worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "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.
+ },
+ "name": "A String", # Optionally caller-specified in CreateTask.
+ #
+ # The task name.
+ #
+ # The task name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
+ "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
+ #
+ # For App Engine queues, this is when the task will be attempted or retried.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
+ # respond by this deadline then the request is cancelled and the attempt
+ # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
+ # task according to the RetryConfig.
+ #
+ # Note that when the request is cancelled, Cloud Tasks will stop listing for
+ # the response, but whether the worker stops processing depends on the
+ # worker. For example, if the worker is stuck, it may not react to cancelled
+ # requests.
+ #
+ # The default and maximum values depend on the type of request:
+ #
+ # * For HTTP tasks, the default is 10 minutes. The deadline
+ # must be in the interval [15 seconds, 30 minutes].
+ #
+ # * For App Engine tasks, 0 indicates that the
+ # request has the default deadline. The default deadline depends on the
+ # [scaling
+ # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
+ # of the service: 10 minutes for standard apps with automatic scaling, 24
+ # hours for standard apps with manual and basic scaling, and 60 minutes for
+ # flex apps. If the request deadline is set, it must be in the interval [15
+ # seconds, 24 hours 15 seconds]. Regardless of the task's
+ # `dispatch_deadline`, the app handler will not run for longer than than
+ # the service's timeout. We recommend setting the `dispatch_deadline` to
+ # at most a few seconds more than the app handler's timeout. For more
+ # information see
+ # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
+ #
+ # `dispatch_deadline` will be truncated to the nearest millisecond. The
+ # deadline is an approximate deadline.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "dispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "responseCount": 42, # Output only. The number of attempts which have received a response.
},
],
}</pre>
@@ -2140,7 +2118,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
@@ -2167,11 +2145,9 @@
task that has already succeeded or permanently 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)
- 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
@@ -2205,7 +2181,7 @@
#
# The task will be pushed to the worker as an HTTP request. If the worker
# or the redirected worker acknowledges the task by returning a successful HTTP
- # response code ([`200` - `299`]), the task will removed from the queue. If
+ # response code ([`200` - `299`]), the task will be removed from the queue. If
# any other HTTP response code is returned or no response is received, the
# task will be retried according to the following:
#
@@ -2218,13 +2194,13 @@
#
# System throttling happens because:
#
- # * Cloud Tasks backoffs on all errors. Normally the backoff specified in
+ # * Cloud Tasks backs off on all errors. Normally the backoff specified in
# rate limits will be used. But if the worker returns
# `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
# errors is high, Cloud Tasks will use a higher backoff rate. The retry
# specified in the `Retry-After` HTTP response header is considered.
#
- # * To prevent traffic spikes and to smooth sudden large traffic spikes,
+ # * To prevent traffic spikes and to smooth sudden increases in traffic,
# dispatches ramp up slowly when the queue is newly created or idle and
# if large numbers of tasks suddenly become available to dispatch (due to
# spikes in create task rates, the queue being unpaused, or many tasks
@@ -2234,7 +2210,36 @@
# A request body is allowed only if the
# HTTP method is POST, PUT, or PATCH. It is an
# error to set body on a task with an incompatible HttpMethod.
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ #
+ # These headers represent a subset of the headers that will accompany the
+ # task's HTTP request. Some HTTP request headers will be ignored or replaced.
+ #
+ # A partial list of headers that will be ignored or replaced is:
+ #
+ # * Host: This will be computed by Cloud Tasks and derived from
+ # HttpRequest.url.
+ # * Content-Length: This will be computed by Cloud Tasks.
+ # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
+ # * X-Google-*: Google use only.
+ # * X-AppEngine-*: Google use only.
+ #
+ # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
+ # `Content-Type` to a media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/octet-stream"` or
+ # `"application/json"`.
+ #
+ # Headers which can have multiple values (according to RFC2616) can be
+ # specified using comma-separated values.
+ #
+ # The size of the headers must be less than 80KB.
+ "a_key": "A String",
+ },
"url": "A String", # Required. The full url path that the request will be sent to.
#
# This string must begin with either "http://" or "https://". Some examples
@@ -2284,36 +2289,7 @@
# caller must have iam.serviceAccounts.actAs permission for the service
# account.
},
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- #
- # These headers represent a subset of the headers that will accompany the
- # task's HTTP request. Some HTTP request headers will be ignored or replaced.
- #
- # A partial list of headers that will be ignored or replaced is:
- #
- # * Host: This will be computed by Cloud Tasks and derived from
- # HttpRequest.url.
- # * Content-Length: This will be computed by Cloud Tasks.
- # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
- # * X-Google-*: Google use only.
- # * X-AppEngine-*: Google use only.
- #
- # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
- # `Content-Type` to a media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/octet-stream"` or
- # `"application/json"`.
- #
- # Headers which can have multiple values (according to RFC2616) can be
- # specified using comma-separated values.
- #
- # The size of the headers must be less than 80KB.
- "a_key": "A String",
- },
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
},
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
@@ -2346,10 +2322,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:
@@ -2382,50 +2358,14 @@
#
# A request body is allowed only if the HTTP method is POST or PUT. It is
# an error to set a body 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 body, 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).
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -2461,7 +2401,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -2508,116 +2448,51 @@
# It can contain a path and query string arguments.
# If the relative URI 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).
- },
- "name": "A String", # Optionally caller-specified in CreateTask.
- #
- # The task name.
- #
- # The task name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
- "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
- #
- # For App Engine queues, this is when the task will be attempted or retried.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
- "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ # 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.
#
- # `schedule_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 worker for this attempt.
+ # Cloud Tasks sets some headers to default values:
#
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
+ # * `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`.
#
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
+ # If the task has a body, 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/tasks/docs/creating-appengine-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",
},
- "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.
},
- "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
- # respond by this deadline then the request is cancelled and the attempt
- # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
- # task according to the RetryConfig.
- #
- # Note that when the request is cancelled, Cloud Tasks will stop listing for
- # the response, but whether the worker stops processing depends on the
- # worker. For example, if the worker is stuck, it may not react to cancelled
- # requests.
- #
- # The default and maximum values depend on the type of request:
- #
- # * For HTTP tasks, the default is 10 minutes. The deadline
- # must be in the interval [15 seconds, 30 minutes].
- #
- # * For App Engine tasks, 0 indicates that the
- # request has the default deadline. The default deadline depends on the
- # [scaling
- # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
- # of the service: 10 minutes for standard apps with automatic scaling, 24
- # hours for standard apps with manual and basic scaling, and 60 minutes for
- # flex apps. If the request deadline is set, it must be in the interval [15
- # seconds, 24 hours 15 seconds]. Regardless of the task's
- # `dispatch_deadline`, the app handler will not run for longer than than
- # the service's timeout. We recommend setting the `dispatch_deadline` to
- # at most a few seconds more than the app handler's timeout. For more
- # information see
- # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
- #
- # `dispatch_deadline` will be truncated to the nearest millisecond. The
- # deadline is an approximate deadline.
- "responseCount": 42, # Output only. The number of attempts which have received a response.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "dispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
"firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
#
# Only dispatch_time will be set.
@@ -2653,6 +2528,104 @@
#
# `dispatch_time` will be truncated to the nearest microsecond.
},
+ "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_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 worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "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.
+ },
+ "name": "A String", # Optionally caller-specified in CreateTask.
+ #
+ # The task name.
+ #
+ # The task name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
+ "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
+ #
+ # For App Engine queues, this is when the task will be attempted or retried.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
+ # respond by this deadline then the request is cancelled and the attempt
+ # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
+ # task according to the RetryConfig.
+ #
+ # Note that when the request is cancelled, Cloud Tasks will stop listing for
+ # the response, but whether the worker stops processing depends on the
+ # worker. For example, if the worker is stuck, it may not react to cancelled
+ # requests.
+ #
+ # The default and maximum values depend on the type of request:
+ #
+ # * For HTTP tasks, the default is 10 minutes. The deadline
+ # must be in the interval [15 seconds, 30 minutes].
+ #
+ # * For App Engine tasks, 0 indicates that the
+ # request has the default deadline. The default deadline depends on the
+ # [scaling
+ # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
+ # of the service: 10 minutes for standard apps with automatic scaling, 24
+ # hours for standard apps with manual and basic scaling, and 60 minutes for
+ # flex apps. If the request deadline is set, it must be in the interval [15
+ # seconds, 24 hours 15 seconds]. Regardless of the task's
+ # `dispatch_deadline`, the app handler will not run for longer than than
+ # the service's timeout. We recommend setting the `dispatch_deadline` to
+ # at most a few seconds more than the app handler's timeout. For more
+ # information see
+ # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
+ #
+ # `dispatch_deadline` will be truncated to the nearest millisecond. The
+ # deadline is an approximate deadline.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "dispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "responseCount": 42, # Output only. The number of attempts which have received a response.
}</pre>
</div>