docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html
index 12c0421..54fbe90 100644
--- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html
+++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html
@@ -93,7 +93,7 @@
<code><a href="#lease">lease(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Leases tasks from a pull queue for</p>
<p class="toc_element">
- <code><a href="#list">list(parent, responseView=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent, responseView=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the tasks in a queue.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -129,7 +129,7 @@
{ # Request message for acknowledging a task using
# AcknowledgeTask.
- "scheduleTime": "A String", # Required. The task's current schedule time, available in the
+ "scheduleTime": "A String", # Required. The task's current schedule time, available in the
# schedule_time returned by
# LeaseTasks response or
# RenewLease response. This restriction is
@@ -158,9 +158,9 @@
<div class="method">
<code class="details" id="cancelLease">cancelLease(name, body=None, x__xgafv=None)</code>
- <pre>Cancel a pull task's lease.
+ <pre>Cancel a pull task's lease.
-The worker can use this method to cancel a task's lease by
+The worker can use this method to cancel a task's lease by
setting its schedule_time to now. This will
make the task available to be leased to the next caller of
LeaseTasks.
@@ -173,12 +173,7 @@
{ # Request message for canceling a lease using
# CancelLease.
- "scheduleTime": "A String", # Required. The task's current schedule time, available in the
- # schedule_time returned by
- # LeaseTasks response or
- # RenewLease response. This restriction is
- # to ensure that your worker currently holds the lease.
- "responseView": "A String", # The response_view specifies which subset of the Task will be
+ "responseView": "A String", # The response_view specifies which subset of the Task will be
# returned.
#
# By default response_view is BASIC; not all
@@ -190,6 +185,11 @@
# Authorization for FULL requires
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
# permission on the Task resource.
+ "scheduleTime": "A String", # Required. The task's current schedule time, available in the
+ # schedule_time returned by
+ # LeaseTasks response or
+ # RenewLease response. This restriction is
+ # to ensure that your worker currently holds the lease.
}
x__xgafv: string, V1 error format.
@@ -201,116 +201,7 @@
An object of the form:
{ # A unit of scheduled work.
- "status": { # Status of the task. # Output only. The task status.
- "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
- #
- # Only dispatch_time will be set.
- # The other AttemptStatus information is not retained by Cloud Tasks.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
- "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
- #
- # This field is not calculated for pull tasks.
- },
- "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
- # set only if pull_target is set on the queue.
- #
- # A pull task is a task that has PullMessage set.
- # LeaseTasks to process the task.
- #
- # This proto can only be used for tasks in a queue which has
- # pull_target set.
- "tag": "A String", # The task's tag.
- #
- # Tags allow similar tasks to be processed in a batch. If you label
- # tasks with a tag, your worker can
- # lease tasks with the same tag using
- # filter. For example, if you want to
- # aggregate the events associated with a specific user once a day,
- # you could tag tasks with the user ID.
- #
- # The task's tag can only be set when the
- # task is created.
- #
- # The tag must be less than 500 characters.
- #
- # SDK compatibility: Although the SDK allows tags to be either
- # string or
- # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
- # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
- # encoded, the tag will be empty when the task is returned by Cloud Tasks.
- "payload": "A String", # A data payload consumed by the worker to execute the task.
- },
- "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
+ "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
# be set only if
# app_engine_http_target is set
# on the queue.
@@ -368,24 +259,38 @@
# required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
# Task dispatches also do not follow redirects.
#
- # The task attempt has succeeded if the app's request handler returns an HTTP
+ # The task attempt has succeeded if the app's request handler returns an HTTP
# response code in the range [`200` - `299`]. The task attempt has failed if
- # the app's handler returns a non-2xx response code or Cloud Tasks does
+ # the app's handler returns a non-2xx response code or Cloud Tasks does
# not receive response before the deadline. Failed
# tasks will be retried according to the
# retry configuration. `503` (Service Unavailable) is
# considered an App Engine system error instead of an application error and
- # will cause Cloud Tasks' traffic congestion control to temporarily throttle
- # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
+ # will cause Cloud Tasks' traffic congestion control to temporarily throttle
+ # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
# Requests) response from an app handler does not cause traffic congestion
# control to throttle the queue.
- "relativeUrl": "A String", # The relative URL.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # The relative URL must begin with "/" and must be a valid HTTP relative URL.
+ # 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).
+ "payload": "A String", # Payload.
+ #
+ # The payload will be sent as the HTTP message body. A message
+ # body, and thus a payload, is allowed only if the HTTP method is
+ # POST or PUT. It is an error to set a data payload on a task with
+ # an incompatible HttpMethod.
+ "relativeUrl": "A String", # The relative URL.
+ #
+ # The relative URL must begin with "/" and must be a valid HTTP relative URL.
# It can contain a path and query string arguments.
- # If the relative URL is empty, then the root path "/" will be used.
+ # If the relative URL is empty, then the root path "/" will be used.
# No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
+ "headers": { # HTTP request headers.
#
# This map contains the header field names and values.
# Headers can be set when the
@@ -395,19 +300,19 @@
# Cloud Tasks sets some headers to default values:
#
# * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # `"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
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
# modified `User-Agent`.
#
# If the task has a payload, Cloud
# Tasks sets the following headers:
#
# * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
+ # `"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"`.
+ # 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.
#
@@ -427,9 +332,9 @@
# 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",
+ "a_key": "A String",
},
- "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
+ "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
# app_engine_routing_override
@@ -448,7 +353,7 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -461,7 +366,23 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -471,17 +392,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -489,22 +410,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -522,23 +443,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -555,22 +460,132 @@
# version, and
# instance are the empty string.
},
- "payload": "A String", # Payload.
- #
- # The payload will be sent as the HTTP message body. A message
- # body, and thus a payload, is allowed only if the HTTP method is
- # POST or PUT. It is an error to set a data payload on a task with
- # an incompatible HttpMethod.
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- #
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt fails with
- # error code 405 (Method Not Allowed). See [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the App Engine documentation for your runtime on [How Requests are
- # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
- "name": "A String", # Optionally caller-specified in CreateTask.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
+ "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
+ # set only if pull_target is set on the queue.
+ #
+ # A pull task is a task that has PullMessage set.
+ # LeaseTasks to process the task.
+ #
+ # This proto can only be used for tasks in a queue which has
+ # pull_target set.
+ "payload": "A String", # A data payload consumed by the worker to execute the task.
+ "tag": "A String", # The task's tag.
+ #
+ # Tags allow similar tasks to be processed in a batch. If you label
+ # tasks with a tag, your worker can
+ # lease tasks with the same tag using
+ # filter. For example, if you want to
+ # aggregate the events associated with a specific user once a day,
+ # you could tag tasks with the user ID.
+ #
+ # The task's tag can only be set when the
+ # task is created.
+ #
+ # The tag must be less than 500 characters.
+ #
+ # SDK compatibility: Although the SDK allows tags to be either
+ # string or
+ # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
+ # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
+ # encoded, the tag will be empty when the task is returned by Cloud Tasks.
+ },
+ "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.
+ #
+ # For pull queues, this is the time when the task is available to
+ # be leased; if a task is currently leased, this is the time when
+ # the current lease expires, that is, the time that the task was
+ # leased plus the lease_duration.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "status": { # Status of the task. # Output only. The task status.
+ "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
+ #
+ # Only dispatch_time will be set.
+ # The other AttemptStatus information is not retained by Cloud Tasks.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
+ #
+ # This field is not calculated for pull tasks.
+ "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ },
+ "name": "A String", # Optionally caller-specified in CreateTask.
#
# The task name.
#
@@ -582,7 +597,7 @@
# 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.
+ # * `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/.
@@ -590,21 +605,6 @@
# 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.
- #
- # For pull queues, this is the time when the task is available to
- # be leased; if a task is currently leased, this is the time when
- # the current lease expires, that is, the time that the task was
- # leased plus the lease_duration.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
}</pre>
</div>
@@ -627,19 +627,7 @@
The object takes the form of:
{ # Request message for CreateTask.
- "responseView": "A String", # The response_view specifies which subset of the Task will be
- # returned.
- #
- # By default response_view is BASIC; not all
- # information is retrieved by default because some data, such as
- # payloads, might be desirable to return only when needed because
- # of its large size or because of the sensitivity of data that it
- # contains.
- #
- # 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`.
@@ -654,13 +642,13 @@
# Task De-duplication:
#
# Explicitly specifying a task ID enables task de-duplication. If
- # a task's ID is identical to that of an existing task or a task
+ # a task's ID is identical to that of an existing task or a task
# that was deleted or completed recently then the call will fail
# with ALREADY_EXISTS.
- # If the task's queue was created using Cloud Tasks, then another task with
- # the same name can't be created for ~1hour after the original task was
- # deleted or completed. If the task's queue was created using queue.yaml or
- # queue.xml, then another task with the same name can't be created
+ # If the task's queue was created using Cloud Tasks, then another task with
+ # the same name can't be created for ~1hour after the original task was
+ # deleted or completed. If the task's queue was created using queue.yaml or
+ # queue.xml, then another task with the same name can't be created
# for ~9days after the original task was deleted or completed.
#
# Because there is an extra lookup cost to identify duplicate task
@@ -672,116 +660,7 @@
# task commands. The infrastructure relies on an approximately
# uniform distribution of task ids to store and serve tasks
# efficiently.
- "status": { # Status of the task. # Output only. The task status.
- "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
- #
- # Only dispatch_time will be set.
- # The other AttemptStatus information is not retained by Cloud Tasks.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
- "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
- #
- # This field is not calculated for pull tasks.
- },
- "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
- # set only if pull_target is set on the queue.
- #
- # A pull task is a task that has PullMessage set.
- # LeaseTasks to process the task.
- #
- # This proto can only be used for tasks in a queue which has
- # pull_target set.
- "tag": "A String", # The task's tag.
- #
- # Tags allow similar tasks to be processed in a batch. If you label
- # tasks with a tag, your worker can
- # lease tasks with the same tag using
- # filter. For example, if you want to
- # aggregate the events associated with a specific user once a day,
- # you could tag tasks with the user ID.
- #
- # The task's tag can only be set when the
- # task is created.
- #
- # The tag must be less than 500 characters.
- #
- # SDK compatibility: Although the SDK allows tags to be either
- # string or
- # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
- # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
- # encoded, the tag will be empty when the task is returned by Cloud Tasks.
- "payload": "A String", # A data payload consumed by the worker to execute the task.
- },
- "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
+ "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
# be set only if
# app_engine_http_target is set
# on the queue.
@@ -839,24 +718,38 @@
# required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
# Task dispatches also do not follow redirects.
#
- # The task attempt has succeeded if the app's request handler returns an HTTP
+ # The task attempt has succeeded if the app's request handler returns an HTTP
# response code in the range [`200` - `299`]. The task attempt has failed if
- # the app's handler returns a non-2xx response code or Cloud Tasks does
+ # the app's handler returns a non-2xx response code or Cloud Tasks does
# not receive response before the deadline. Failed
# tasks will be retried according to the
# retry configuration. `503` (Service Unavailable) is
# considered an App Engine system error instead of an application error and
- # will cause Cloud Tasks' traffic congestion control to temporarily throttle
- # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
+ # will cause Cloud Tasks' traffic congestion control to temporarily throttle
+ # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
# Requests) response from an app handler does not cause traffic congestion
# control to throttle the queue.
- "relativeUrl": "A String", # The relative URL.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # The relative URL must begin with "/" and must be a valid HTTP relative URL.
+ # 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).
+ "payload": "A String", # Payload.
+ #
+ # The payload will be sent as the HTTP message body. A message
+ # body, and thus a payload, is allowed only if the HTTP method is
+ # POST or PUT. It is an error to set a data payload on a task with
+ # an incompatible HttpMethod.
+ "relativeUrl": "A String", # The relative URL.
+ #
+ # The relative URL must begin with "/" and must be a valid HTTP relative URL.
# It can contain a path and query string arguments.
- # If the relative URL is empty, then the root path "/" will be used.
+ # If the relative URL is empty, then the root path "/" will be used.
# No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
+ "headers": { # HTTP request headers.
#
# This map contains the header field names and values.
# Headers can be set when the
@@ -866,19 +759,19 @@
# Cloud Tasks sets some headers to default values:
#
# * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # `"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
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
# modified `User-Agent`.
#
# If the task has a payload, Cloud
# Tasks sets the following headers:
#
# * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
+ # `"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"`.
+ # 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.
#
@@ -898,9 +791,9 @@
# 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",
+ "a_key": "A String",
},
- "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
+ "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
# app_engine_routing_override
@@ -919,7 +812,7 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -932,7 +825,23 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -942,17 +851,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -960,22 +869,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -993,23 +902,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -1026,22 +919,132 @@
# version, and
# instance are the empty string.
},
- "payload": "A String", # Payload.
- #
- # The payload will be sent as the HTTP message body. A message
- # body, and thus a payload, is allowed only if the HTTP method is
- # POST or PUT. It is an error to set a data payload on a task with
- # an incompatible HttpMethod.
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- #
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt fails with
- # error code 405 (Method Not Allowed). See [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the App Engine documentation for your runtime on [How Requests are
- # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
- "name": "A String", # Optionally caller-specified in CreateTask.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
+ "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
+ # set only if pull_target is set on the queue.
+ #
+ # A pull task is a task that has PullMessage set.
+ # LeaseTasks to process the task.
+ #
+ # This proto can only be used for tasks in a queue which has
+ # pull_target set.
+ "payload": "A String", # A data payload consumed by the worker to execute the task.
+ "tag": "A String", # The task's tag.
+ #
+ # Tags allow similar tasks to be processed in a batch. If you label
+ # tasks with a tag, your worker can
+ # lease tasks with the same tag using
+ # filter. For example, if you want to
+ # aggregate the events associated with a specific user once a day,
+ # you could tag tasks with the user ID.
+ #
+ # The task's tag can only be set when the
+ # task is created.
+ #
+ # The tag must be less than 500 characters.
+ #
+ # SDK compatibility: Although the SDK allows tags to be either
+ # string or
+ # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
+ # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
+ # encoded, the tag will be empty when the task is returned by Cloud Tasks.
+ },
+ "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.
+ #
+ # For pull queues, this is the time when the task is available to
+ # be leased; if a task is currently leased, this is the time when
+ # the current lease expires, that is, the time that the task was
+ # leased plus the lease_duration.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "status": { # Status of the task. # Output only. The task status.
+ "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
+ #
+ # Only dispatch_time will be set.
+ # The other AttemptStatus information is not retained by Cloud Tasks.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
+ #
+ # This field is not calculated for pull tasks.
+ "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ },
+ "name": "A String", # Optionally caller-specified in CreateTask.
#
# The task name.
#
@@ -1053,7 +1056,7 @@
# 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.
+ # * `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/.
@@ -1061,22 +1064,19 @@
# 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.
- #
- # For pull queues, this is the time when the task is available to
- # be leased; if a task is currently leased, this is the time when
- # the current lease expires, that is, the time that the task was
- # leased plus the lease_duration.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
},
+ "responseView": "A String", # The response_view specifies which subset of the Task will be
+ # returned.
+ #
+ # By default response_view is BASIC; not all
+ # information is retrieved by default because some data, such as
+ # payloads, might be desirable to return only when needed because
+ # of its large size or because of the sensitivity of data that it
+ # contains.
+ #
+ # Authorization for FULL requires
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
+ # permission on the Task resource.
}
x__xgafv: string, V1 error format.
@@ -1088,116 +1088,7 @@
An object of the form:
{ # A unit of scheduled work.
- "status": { # Status of the task. # Output only. The task status.
- "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
- #
- # Only dispatch_time will be set.
- # The other AttemptStatus information is not retained by Cloud Tasks.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
- "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
- #
- # This field is not calculated for pull tasks.
- },
- "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
- # set only if pull_target is set on the queue.
- #
- # A pull task is a task that has PullMessage set.
- # LeaseTasks to process the task.
- #
- # This proto can only be used for tasks in a queue which has
- # pull_target set.
- "tag": "A String", # The task's tag.
- #
- # Tags allow similar tasks to be processed in a batch. If you label
- # tasks with a tag, your worker can
- # lease tasks with the same tag using
- # filter. For example, if you want to
- # aggregate the events associated with a specific user once a day,
- # you could tag tasks with the user ID.
- #
- # The task's tag can only be set when the
- # task is created.
- #
- # The tag must be less than 500 characters.
- #
- # SDK compatibility: Although the SDK allows tags to be either
- # string or
- # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
- # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
- # encoded, the tag will be empty when the task is returned by Cloud Tasks.
- "payload": "A String", # A data payload consumed by the worker to execute the task.
- },
- "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
+ "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
# be set only if
# app_engine_http_target is set
# on the queue.
@@ -1255,24 +1146,38 @@
# required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
# Task dispatches also do not follow redirects.
#
- # The task attempt has succeeded if the app's request handler returns an HTTP
+ # The task attempt has succeeded if the app's request handler returns an HTTP
# response code in the range [`200` - `299`]. The task attempt has failed if
- # the app's handler returns a non-2xx response code or Cloud Tasks does
+ # the app's handler returns a non-2xx response code or Cloud Tasks does
# not receive response before the deadline. Failed
# tasks will be retried according to the
# retry configuration. `503` (Service Unavailable) is
# considered an App Engine system error instead of an application error and
- # will cause Cloud Tasks' traffic congestion control to temporarily throttle
- # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
+ # will cause Cloud Tasks' traffic congestion control to temporarily throttle
+ # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
# Requests) response from an app handler does not cause traffic congestion
# control to throttle the queue.
- "relativeUrl": "A String", # The relative URL.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # The relative URL must begin with "/" and must be a valid HTTP relative URL.
+ # 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).
+ "payload": "A String", # Payload.
+ #
+ # The payload will be sent as the HTTP message body. A message
+ # body, and thus a payload, is allowed only if the HTTP method is
+ # POST or PUT. It is an error to set a data payload on a task with
+ # an incompatible HttpMethod.
+ "relativeUrl": "A String", # The relative URL.
+ #
+ # The relative URL must begin with "/" and must be a valid HTTP relative URL.
# It can contain a path and query string arguments.
- # If the relative URL is empty, then the root path "/" will be used.
+ # If the relative URL is empty, then the root path "/" will be used.
# No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
+ "headers": { # HTTP request headers.
#
# This map contains the header field names and values.
# Headers can be set when the
@@ -1282,19 +1187,19 @@
# Cloud Tasks sets some headers to default values:
#
# * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # `"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
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
# modified `User-Agent`.
#
# If the task has a payload, Cloud
# Tasks sets the following headers:
#
# * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
+ # `"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"`.
+ # 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.
#
@@ -1314,9 +1219,9 @@
# 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",
+ "a_key": "A String",
},
- "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
+ "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
# app_engine_routing_override
@@ -1335,7 +1240,7 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -1348,7 +1253,23 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -1358,17 +1279,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -1376,22 +1297,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -1409,23 +1330,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -1442,22 +1347,132 @@
# version, and
# instance are the empty string.
},
- "payload": "A String", # Payload.
- #
- # The payload will be sent as the HTTP message body. A message
- # body, and thus a payload, is allowed only if the HTTP method is
- # POST or PUT. It is an error to set a data payload on a task with
- # an incompatible HttpMethod.
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- #
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt fails with
- # error code 405 (Method Not Allowed). See [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the App Engine documentation for your runtime on [How Requests are
- # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
- "name": "A String", # Optionally caller-specified in CreateTask.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
+ "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
+ # set only if pull_target is set on the queue.
+ #
+ # A pull task is a task that has PullMessage set.
+ # LeaseTasks to process the task.
+ #
+ # This proto can only be used for tasks in a queue which has
+ # pull_target set.
+ "payload": "A String", # A data payload consumed by the worker to execute the task.
+ "tag": "A String", # The task's tag.
+ #
+ # Tags allow similar tasks to be processed in a batch. If you label
+ # tasks with a tag, your worker can
+ # lease tasks with the same tag using
+ # filter. For example, if you want to
+ # aggregate the events associated with a specific user once a day,
+ # you could tag tasks with the user ID.
+ #
+ # The task's tag can only be set when the
+ # task is created.
+ #
+ # The tag must be less than 500 characters.
+ #
+ # SDK compatibility: Although the SDK allows tags to be either
+ # string or
+ # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
+ # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
+ # encoded, the tag will be empty when the task is returned by Cloud Tasks.
+ },
+ "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.
+ #
+ # For pull queues, this is the time when the task is available to
+ # be leased; if a task is currently leased, this is the time when
+ # the current lease expires, that is, the time that the task was
+ # leased plus the lease_duration.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "status": { # Status of the task. # Output only. The task status.
+ "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
+ #
+ # Only dispatch_time will be set.
+ # The other AttemptStatus information is not retained by Cloud Tasks.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
+ #
+ # This field is not calculated for pull tasks.
+ "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ },
+ "name": "A String", # Optionally caller-specified in CreateTask.
#
# The task name.
#
@@ -1469,7 +1484,7 @@
# 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.
+ # * `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/.
@@ -1477,21 +1492,6 @@
# 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.
- #
- # For pull queues, this is the time when the task is available to
- # be leased; if a task is currently leased, this is the time when
- # the current lease expires, that is, the time that the task was
- # leased plus the lease_duration.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
}</pre>
</div>
@@ -1554,116 +1554,7 @@
An object of the form:
{ # A unit of scheduled work.
- "status": { # Status of the task. # Output only. The task status.
- "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
- #
- # Only dispatch_time will be set.
- # The other AttemptStatus information is not retained by Cloud Tasks.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
- "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
- #
- # This field is not calculated for pull tasks.
- },
- "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
- # set only if pull_target is set on the queue.
- #
- # A pull task is a task that has PullMessage set.
- # LeaseTasks to process the task.
- #
- # This proto can only be used for tasks in a queue which has
- # pull_target set.
- "tag": "A String", # The task's tag.
- #
- # Tags allow similar tasks to be processed in a batch. If you label
- # tasks with a tag, your worker can
- # lease tasks with the same tag using
- # filter. For example, if you want to
- # aggregate the events associated with a specific user once a day,
- # you could tag tasks with the user ID.
- #
- # The task's tag can only be set when the
- # task is created.
- #
- # The tag must be less than 500 characters.
- #
- # SDK compatibility: Although the SDK allows tags to be either
- # string or
- # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
- # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
- # encoded, the tag will be empty when the task is returned by Cloud Tasks.
- "payload": "A String", # A data payload consumed by the worker to execute the task.
- },
- "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
+ "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
# be set only if
# app_engine_http_target is set
# on the queue.
@@ -1721,24 +1612,38 @@
# required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
# Task dispatches also do not follow redirects.
#
- # The task attempt has succeeded if the app's request handler returns an HTTP
+ # The task attempt has succeeded if the app's request handler returns an HTTP
# response code in the range [`200` - `299`]. The task attempt has failed if
- # the app's handler returns a non-2xx response code or Cloud Tasks does
+ # the app's handler returns a non-2xx response code or Cloud Tasks does
# not receive response before the deadline. Failed
# tasks will be retried according to the
# retry configuration. `503` (Service Unavailable) is
# considered an App Engine system error instead of an application error and
- # will cause Cloud Tasks' traffic congestion control to temporarily throttle
- # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
+ # will cause Cloud Tasks' traffic congestion control to temporarily throttle
+ # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
# Requests) response from an app handler does not cause traffic congestion
# control to throttle the queue.
- "relativeUrl": "A String", # The relative URL.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # The relative URL must begin with "/" and must be a valid HTTP relative URL.
+ # 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).
+ "payload": "A String", # Payload.
+ #
+ # The payload will be sent as the HTTP message body. A message
+ # body, and thus a payload, is allowed only if the HTTP method is
+ # POST or PUT. It is an error to set a data payload on a task with
+ # an incompatible HttpMethod.
+ "relativeUrl": "A String", # The relative URL.
+ #
+ # The relative URL must begin with "/" and must be a valid HTTP relative URL.
# It can contain a path and query string arguments.
- # If the relative URL is empty, then the root path "/" will be used.
+ # If the relative URL is empty, then the root path "/" will be used.
# No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
+ "headers": { # HTTP request headers.
#
# This map contains the header field names and values.
# Headers can be set when the
@@ -1748,19 +1653,19 @@
# Cloud Tasks sets some headers to default values:
#
# * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # `"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
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
# modified `User-Agent`.
#
# If the task has a payload, Cloud
# Tasks sets the following headers:
#
# * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
+ # `"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"`.
+ # 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.
#
@@ -1780,9 +1685,9 @@
# 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",
+ "a_key": "A String",
},
- "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
+ "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
# app_engine_routing_override
@@ -1801,7 +1706,7 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -1814,7 +1719,23 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -1824,17 +1745,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -1842,22 +1763,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -1875,23 +1796,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -1908,22 +1813,132 @@
# version, and
# instance are the empty string.
},
- "payload": "A String", # Payload.
- #
- # The payload will be sent as the HTTP message body. A message
- # body, and thus a payload, is allowed only if the HTTP method is
- # POST or PUT. It is an error to set a data payload on a task with
- # an incompatible HttpMethod.
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- #
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt fails with
- # error code 405 (Method Not Allowed). See [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the App Engine documentation for your runtime on [How Requests are
- # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
- "name": "A String", # Optionally caller-specified in CreateTask.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
+ "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
+ # set only if pull_target is set on the queue.
+ #
+ # A pull task is a task that has PullMessage set.
+ # LeaseTasks to process the task.
+ #
+ # This proto can only be used for tasks in a queue which has
+ # pull_target set.
+ "payload": "A String", # A data payload consumed by the worker to execute the task.
+ "tag": "A String", # The task's tag.
+ #
+ # Tags allow similar tasks to be processed in a batch. If you label
+ # tasks with a tag, your worker can
+ # lease tasks with the same tag using
+ # filter. For example, if you want to
+ # aggregate the events associated with a specific user once a day,
+ # you could tag tasks with the user ID.
+ #
+ # The task's tag can only be set when the
+ # task is created.
+ #
+ # The tag must be less than 500 characters.
+ #
+ # SDK compatibility: Although the SDK allows tags to be either
+ # string or
+ # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
+ # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
+ # encoded, the tag will be empty when the task is returned by Cloud Tasks.
+ },
+ "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.
+ #
+ # For pull queues, this is the time when the task is available to
+ # be leased; if a task is currently leased, this is the time when
+ # the current lease expires, that is, the time that the task was
+ # leased plus the lease_duration.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "status": { # Status of the task. # Output only. The task status.
+ "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
+ #
+ # Only dispatch_time will be set.
+ # The other AttemptStatus information is not retained by Cloud Tasks.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
+ #
+ # This field is not calculated for pull tasks.
+ "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ },
+ "name": "A String", # Optionally caller-specified in CreateTask.
#
# The task name.
#
@@ -1935,7 +1950,7 @@
# 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.
+ # * `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/.
@@ -1943,21 +1958,6 @@
# 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.
- #
- # For pull queues, this is the time when the task is available to
- # be leased; if a task is currently leased, this is the time when
- # the current lease expires, that is, the time that the task was
- # leased plus the lease_duration.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
}</pre>
</div>
@@ -1993,7 +1993,7 @@
The object takes the form of:
{ # Request message for leasing tasks using LeaseTasks.
- "filter": "A String", # `filter` can be used to specify a subset of tasks to lease.
+ "filter": "A String", # `filter` can be used to specify a subset of tasks to lease.
#
# When `filter` is set to `tag=<my-tag>` then the
# response will contain only tasks whose
@@ -2006,11 +2006,11 @@
#
# Grammar Syntax:
#
- # * `filter = "tag=" tag | "tag_function=" function`
+ # * `filter = "tag=" tag | "tag_function=" function`
#
# * `tag = string`
#
- # * `function = "oldest_tag()"`
+ # * `function = "oldest_tag()"`
#
# The `oldest_tag()` function returns tasks which have the same tag as the
# oldest task (ordered by schedule time).
@@ -2019,10 +2019,10 @@
# string or
# [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
# only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
- # aren't UTF-8 encoded can't be used in the
- # filter and the task's
+ # aren't UTF-8 encoded can't be used in the
+ # filter and the task's
# tag will be displayed as empty in Cloud Tasks.
- "maxTasks": 42, # The maximum number of tasks to lease.
+ "maxTasks": 42, # The maximum number of tasks to lease.
#
# The system will make a best effort to return as close to as
# `max_tasks` as possible.
@@ -2032,19 +2032,7 @@
# The maximum total size of a lease tasks response is
# 32 MB. If the sum of all task sizes requested reaches this limit,
# fewer tasks than requested are returned.
- "responseView": "A String", # The response_view specifies which subset of the Task will be
- # returned.
- #
- # By default response_view is BASIC; not all
- # information is retrieved by default because some data, such as
- # payloads, might be desirable to return only when needed because
- # of its large size or because of the sensitivity of data that it
- # contains.
- #
- # Authorization for FULL requires
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- # permission on the Task resource.
- "leaseDuration": "A String", # Required. The duration of the lease.
+ "leaseDuration": "A String", # Required. The duration of the lease.
#
# Each task returned in the response will
# have its schedule_time set to the current
@@ -2063,6 +2051,18 @@
#
# The maximum lease duration is 1 week.
# `lease_duration` will be truncated to the nearest second.
+ "responseView": "A String", # The response_view specifies which subset of the Task will be
+ # returned.
+ #
+ # By default response_view is BASIC; not all
+ # information is retrieved by default because some data, such as
+ # payloads, might be desirable to return only when needed because
+ # of its large size or because of the sensitivity of data that it
+ # contains.
+ #
+ # Authorization for FULL requires
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
+ # permission on the Task resource.
}
x__xgafv: string, V1 error format.
@@ -2074,118 +2074,9 @@
An object of the form:
{ # Response message for leasing tasks using LeaseTasks.
- "tasks": [ # The leased tasks.
+ "tasks": [ # The leased tasks.
{ # A unit of scheduled work.
- "status": { # Status of the task. # Output only. The task status.
- "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
- #
- # Only dispatch_time will be set.
- # The other AttemptStatus information is not retained by Cloud Tasks.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
- "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
- #
- # This field is not calculated for pull tasks.
- },
- "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
- # set only if pull_target is set on the queue.
- #
- # A pull task is a task that has PullMessage set.
- # LeaseTasks to process the task.
- #
- # This proto can only be used for tasks in a queue which has
- # pull_target set.
- "tag": "A String", # The task's tag.
- #
- # Tags allow similar tasks to be processed in a batch. If you label
- # tasks with a tag, your worker can
- # lease tasks with the same tag using
- # filter. For example, if you want to
- # aggregate the events associated with a specific user once a day,
- # you could tag tasks with the user ID.
- #
- # The task's tag can only be set when the
- # task is created.
- #
- # The tag must be less than 500 characters.
- #
- # SDK compatibility: Although the SDK allows tags to be either
- # string or
- # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
- # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
- # encoded, the tag will be empty when the task is returned by Cloud Tasks.
- "payload": "A String", # A data payload consumed by the worker to execute the task.
- },
- "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
+ "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
# be set only if
# app_engine_http_target is set
# on the queue.
@@ -2243,24 +2134,38 @@
# required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
# Task dispatches also do not follow redirects.
#
- # The task attempt has succeeded if the app's request handler returns an HTTP
+ # The task attempt has succeeded if the app's request handler returns an HTTP
# response code in the range [`200` - `299`]. The task attempt has failed if
- # the app's handler returns a non-2xx response code or Cloud Tasks does
+ # the app's handler returns a non-2xx response code or Cloud Tasks does
# not receive response before the deadline. Failed
# tasks will be retried according to the
# retry configuration. `503` (Service Unavailable) is
# considered an App Engine system error instead of an application error and
- # will cause Cloud Tasks' traffic congestion control to temporarily throttle
- # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
+ # will cause Cloud Tasks' traffic congestion control to temporarily throttle
+ # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
# Requests) response from an app handler does not cause traffic congestion
# control to throttle the queue.
- "relativeUrl": "A String", # The relative URL.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # The relative URL must begin with "/" and must be a valid HTTP relative URL.
+ # 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).
+ "payload": "A String", # Payload.
+ #
+ # The payload will be sent as the HTTP message body. A message
+ # body, and thus a payload, is allowed only if the HTTP method is
+ # POST or PUT. It is an error to set a data payload on a task with
+ # an incompatible HttpMethod.
+ "relativeUrl": "A String", # The relative URL.
+ #
+ # The relative URL must begin with "/" and must be a valid HTTP relative URL.
# It can contain a path and query string arguments.
- # If the relative URL is empty, then the root path "/" will be used.
+ # If the relative URL is empty, then the root path "/" will be used.
# No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
+ "headers": { # HTTP request headers.
#
# This map contains the header field names and values.
# Headers can be set when the
@@ -2270,19 +2175,19 @@
# Cloud Tasks sets some headers to default values:
#
# * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # `"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
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
# modified `User-Agent`.
#
# If the task has a payload, Cloud
# Tasks sets the following headers:
#
# * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
+ # `"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"`.
+ # 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.
#
@@ -2302,9 +2207,9 @@
# 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",
+ "a_key": "A String",
},
- "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
+ "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
# app_engine_routing_override
@@ -2323,7 +2228,7 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -2336,7 +2241,23 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -2346,17 +2267,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -2364,22 +2285,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -2397,23 +2318,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -2430,22 +2335,132 @@
# version, and
# instance are the empty string.
},
- "payload": "A String", # Payload.
- #
- # The payload will be sent as the HTTP message body. A message
- # body, and thus a payload, is allowed only if the HTTP method is
- # POST or PUT. It is an error to set a data payload on a task with
- # an incompatible HttpMethod.
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- #
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt fails with
- # error code 405 (Method Not Allowed). See [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the App Engine documentation for your runtime on [How Requests are
- # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
- "name": "A String", # Optionally caller-specified in CreateTask.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
+ "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
+ # set only if pull_target is set on the queue.
+ #
+ # A pull task is a task that has PullMessage set.
+ # LeaseTasks to process the task.
+ #
+ # This proto can only be used for tasks in a queue which has
+ # pull_target set.
+ "payload": "A String", # A data payload consumed by the worker to execute the task.
+ "tag": "A String", # The task's tag.
+ #
+ # Tags allow similar tasks to be processed in a batch. If you label
+ # tasks with a tag, your worker can
+ # lease tasks with the same tag using
+ # filter. For example, if you want to
+ # aggregate the events associated with a specific user once a day,
+ # you could tag tasks with the user ID.
+ #
+ # The task's tag can only be set when the
+ # task is created.
+ #
+ # The tag must be less than 500 characters.
+ #
+ # SDK compatibility: Although the SDK allows tags to be either
+ # string or
+ # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
+ # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
+ # encoded, the tag will be empty when the task is returned by Cloud Tasks.
+ },
+ "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.
+ #
+ # For pull queues, this is the time when the task is available to
+ # be leased; if a task is currently leased, this is the time when
+ # the current lease expires, that is, the time that the task was
+ # leased plus the lease_duration.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "status": { # Status of the task. # Output only. The task status.
+ "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
+ #
+ # Only dispatch_time will be set.
+ # The other AttemptStatus information is not retained by Cloud Tasks.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
+ #
+ # This field is not calculated for pull tasks.
+ "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ },
+ "name": "A String", # Optionally caller-specified in CreateTask.
#
# The task name.
#
@@ -2457,7 +2472,7 @@
# 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.
+ # * `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/.
@@ -2465,28 +2480,13 @@
# 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.
- #
- # For pull queues, this is the time when the task is available to
- # be leased; if a task is currently leased, this is the time when
- # the current lease expires, that is, the time that the task was
- # leased plus the lease_duration.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
},
],
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, responseView=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent, responseView=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists the tasks in a queue.
By default, only the BASIC view is retrieved
@@ -2521,10 +2521,6 @@
method.
The page token is valid for only 2 hours.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
pageSize: integer, Maximum page size.
Fewer tasks than requested might be returned, even if more tasks exist; use
@@ -2533,130 +2529,18 @@
The maximum page size is 1000. If unspecified, the page size will be the
maximum.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Response message for listing tasks using ListTasks.
- "nextPageToken": "A String", # A token to retrieve next page of results.
- #
- # To return the next page of results, call
- # ListTasks with this value as the
- # page_token.
- #
- # If the next_page_token is empty, there are no more results.
- "tasks": [ # The list of tasks.
+ "tasks": [ # The list of tasks.
{ # A unit of scheduled work.
- "status": { # Status of the task. # Output only. The task status.
- "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
- #
- # Only dispatch_time will be set.
- # The other AttemptStatus information is not retained by Cloud Tasks.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
- "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
- #
- # This field is not calculated for pull tasks.
- },
- "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
- # set only if pull_target is set on the queue.
- #
- # A pull task is a task that has PullMessage set.
- # LeaseTasks to process the task.
- #
- # This proto can only be used for tasks in a queue which has
- # pull_target set.
- "tag": "A String", # The task's tag.
- #
- # Tags allow similar tasks to be processed in a batch. If you label
- # tasks with a tag, your worker can
- # lease tasks with the same tag using
- # filter. For example, if you want to
- # aggregate the events associated with a specific user once a day,
- # you could tag tasks with the user ID.
- #
- # The task's tag can only be set when the
- # task is created.
- #
- # The tag must be less than 500 characters.
- #
- # SDK compatibility: Although the SDK allows tags to be either
- # string or
- # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
- # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
- # encoded, the tag will be empty when the task is returned by Cloud Tasks.
- "payload": "A String", # A data payload consumed by the worker to execute the task.
- },
- "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
+ "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
# be set only if
# app_engine_http_target is set
# on the queue.
@@ -2714,24 +2598,38 @@
# required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
# Task dispatches also do not follow redirects.
#
- # The task attempt has succeeded if the app's request handler returns an HTTP
+ # The task attempt has succeeded if the app's request handler returns an HTTP
# response code in the range [`200` - `299`]. The task attempt has failed if
- # the app's handler returns a non-2xx response code or Cloud Tasks does
+ # the app's handler returns a non-2xx response code or Cloud Tasks does
# not receive response before the deadline. Failed
# tasks will be retried according to the
# retry configuration. `503` (Service Unavailable) is
# considered an App Engine system error instead of an application error and
- # will cause Cloud Tasks' traffic congestion control to temporarily throttle
- # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
+ # will cause Cloud Tasks' traffic congestion control to temporarily throttle
+ # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
# Requests) response from an app handler does not cause traffic congestion
# control to throttle the queue.
- "relativeUrl": "A String", # The relative URL.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # The relative URL must begin with "/" and must be a valid HTTP relative URL.
+ # 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).
+ "payload": "A String", # Payload.
+ #
+ # The payload will be sent as the HTTP message body. A message
+ # body, and thus a payload, is allowed only if the HTTP method is
+ # POST or PUT. It is an error to set a data payload on a task with
+ # an incompatible HttpMethod.
+ "relativeUrl": "A String", # The relative URL.
+ #
+ # The relative URL must begin with "/" and must be a valid HTTP relative URL.
# It can contain a path and query string arguments.
- # If the relative URL is empty, then the root path "/" will be used.
+ # If the relative URL is empty, then the root path "/" will be used.
# No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
+ "headers": { # HTTP request headers.
#
# This map contains the header field names and values.
# Headers can be set when the
@@ -2741,19 +2639,19 @@
# Cloud Tasks sets some headers to default values:
#
# * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # `"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
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
# modified `User-Agent`.
#
# If the task has a payload, Cloud
# Tasks sets the following headers:
#
# * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
+ # `"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"`.
+ # 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.
#
@@ -2773,9 +2671,9 @@
# 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",
+ "a_key": "A String",
},
- "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
+ "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
# app_engine_routing_override
@@ -2794,7 +2692,7 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -2807,7 +2705,23 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -2817,17 +2731,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -2835,22 +2749,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -2868,23 +2782,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -2901,22 +2799,132 @@
# version, and
# instance are the empty string.
},
- "payload": "A String", # Payload.
- #
- # The payload will be sent as the HTTP message body. A message
- # body, and thus a payload, is allowed only if the HTTP method is
- # POST or PUT. It is an error to set a data payload on a task with
- # an incompatible HttpMethod.
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- #
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt fails with
- # error code 405 (Method Not Allowed). See [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the App Engine documentation for your runtime on [How Requests are
- # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
- "name": "A String", # Optionally caller-specified in CreateTask.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
+ "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
+ # set only if pull_target is set on the queue.
+ #
+ # A pull task is a task that has PullMessage set.
+ # LeaseTasks to process the task.
+ #
+ # This proto can only be used for tasks in a queue which has
+ # pull_target set.
+ "payload": "A String", # A data payload consumed by the worker to execute the task.
+ "tag": "A String", # The task's tag.
+ #
+ # Tags allow similar tasks to be processed in a batch. If you label
+ # tasks with a tag, your worker can
+ # lease tasks with the same tag using
+ # filter. For example, if you want to
+ # aggregate the events associated with a specific user once a day,
+ # you could tag tasks with the user ID.
+ #
+ # The task's tag can only be set when the
+ # task is created.
+ #
+ # The tag must be less than 500 characters.
+ #
+ # SDK compatibility: Although the SDK allows tags to be either
+ # string or
+ # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
+ # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
+ # encoded, the tag will be empty when the task is returned by Cloud Tasks.
+ },
+ "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.
+ #
+ # For pull queues, this is the time when the task is available to
+ # be leased; if a task is currently leased, this is the time when
+ # the current lease expires, that is, the time that the task was
+ # leased plus the lease_duration.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "status": { # Status of the task. # Output only. The task status.
+ "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
+ #
+ # Only dispatch_time will be set.
+ # The other AttemptStatus information is not retained by Cloud Tasks.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
+ #
+ # This field is not calculated for pull tasks.
+ "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ },
+ "name": "A String", # Optionally caller-specified in CreateTask.
#
# The task name.
#
@@ -2928,7 +2936,7 @@
# 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.
+ # * `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/.
@@ -2936,23 +2944,15 @@
# 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.
- #
- # For pull queues, this is the time when the task is available to
- # be leased; if a task is currently leased, this is the time when
- # the current lease expires, that is, the time that the task was
- # leased plus the lease_duration.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
},
],
+ "nextPageToken": "A String", # A token to retrieve next page of results.
+ #
+ # To return the next page of results, call
+ # ListTasks with this value as the
+ # page_token.
+ #
+ # If the next_page_token is empty, there are no more results.
}</pre>
</div>
@@ -2965,7 +2965,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -2976,7 +2976,7 @@
The worker can use this method to extend the lease by a new
duration, starting from now. The new task lease will be
-returned in the task's schedule_time.
+returned in the task's schedule_time.
Args:
name: string, Required. The task name. For example:
@@ -2986,12 +2986,7 @@
{ # Request message for renewing a lease using
# RenewLease.
- "scheduleTime": "A String", # Required. The task's current schedule time, available in the
- # schedule_time returned by
- # LeaseTasks response or
- # RenewLease response. This restriction is
- # to ensure that your worker currently holds the lease.
- "responseView": "A String", # The response_view specifies which subset of the Task will be
+ "responseView": "A String", # The response_view specifies which subset of the Task will be
# returned.
#
# By default response_view is BASIC; not all
@@ -3003,7 +2998,12 @@
# Authorization for FULL requires
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
# permission on the Task resource.
- "leaseDuration": "A String", # Required. The desired new lease duration, starting from now.
+ "scheduleTime": "A String", # Required. The task's current schedule time, available in the
+ # schedule_time returned by
+ # LeaseTasks response or
+ # RenewLease response. This restriction is
+ # to ensure that your worker currently holds the lease.
+ "leaseDuration": "A String", # Required. The desired new lease duration, starting from now.
#
#
# The maximum lease duration is 1 week.
@@ -3019,116 +3019,7 @@
An object of the form:
{ # A unit of scheduled work.
- "status": { # Status of the task. # Output only. The task status.
- "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
- #
- # Only dispatch_time will be set.
- # The other AttemptStatus information is not retained by Cloud Tasks.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
- "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
- #
- # This field is not calculated for pull tasks.
- },
- "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
- # set only if pull_target is set on the queue.
- #
- # A pull task is a task that has PullMessage set.
- # LeaseTasks to process the task.
- #
- # This proto can only be used for tasks in a queue which has
- # pull_target set.
- "tag": "A String", # The task's tag.
- #
- # Tags allow similar tasks to be processed in a batch. If you label
- # tasks with a tag, your worker can
- # lease tasks with the same tag using
- # filter. For example, if you want to
- # aggregate the events associated with a specific user once a day,
- # you could tag tasks with the user ID.
- #
- # The task's tag can only be set when the
- # task is created.
- #
- # The tag must be less than 500 characters.
- #
- # SDK compatibility: Although the SDK allows tags to be either
- # string or
- # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
- # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
- # encoded, the tag will be empty when the task is returned by Cloud Tasks.
- "payload": "A String", # A data payload consumed by the worker to execute the task.
- },
- "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
+ "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
# be set only if
# app_engine_http_target is set
# on the queue.
@@ -3186,24 +3077,38 @@
# required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
# Task dispatches also do not follow redirects.
#
- # The task attempt has succeeded if the app's request handler returns an HTTP
+ # The task attempt has succeeded if the app's request handler returns an HTTP
# response code in the range [`200` - `299`]. The task attempt has failed if
- # the app's handler returns a non-2xx response code or Cloud Tasks does
+ # the app's handler returns a non-2xx response code or Cloud Tasks does
# not receive response before the deadline. Failed
# tasks will be retried according to the
# retry configuration. `503` (Service Unavailable) is
# considered an App Engine system error instead of an application error and
- # will cause Cloud Tasks' traffic congestion control to temporarily throttle
- # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
+ # will cause Cloud Tasks' traffic congestion control to temporarily throttle
+ # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
# Requests) response from an app handler does not cause traffic congestion
# control to throttle the queue.
- "relativeUrl": "A String", # The relative URL.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # The relative URL must begin with "/" and must be a valid HTTP relative URL.
+ # 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).
+ "payload": "A String", # Payload.
+ #
+ # The payload will be sent as the HTTP message body. A message
+ # body, and thus a payload, is allowed only if the HTTP method is
+ # POST or PUT. It is an error to set a data payload on a task with
+ # an incompatible HttpMethod.
+ "relativeUrl": "A String", # The relative URL.
+ #
+ # The relative URL must begin with "/" and must be a valid HTTP relative URL.
# It can contain a path and query string arguments.
- # If the relative URL is empty, then the root path "/" will be used.
+ # If the relative URL is empty, then the root path "/" will be used.
# No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
+ "headers": { # HTTP request headers.
#
# This map contains the header field names and values.
# Headers can be set when the
@@ -3213,19 +3118,19 @@
# Cloud Tasks sets some headers to default values:
#
# * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # `"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
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
# modified `User-Agent`.
#
# If the task has a payload, Cloud
# Tasks sets the following headers:
#
# * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
+ # `"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"`.
+ # 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.
#
@@ -3245,9 +3150,9 @@
# 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",
+ "a_key": "A String",
},
- "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
+ "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
# app_engine_routing_override
@@ -3266,7 +3171,7 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -3279,7 +3184,23 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -3289,17 +3210,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -3307,22 +3228,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -3340,23 +3261,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -3373,22 +3278,132 @@
# version, and
# instance are the empty string.
},
- "payload": "A String", # Payload.
- #
- # The payload will be sent as the HTTP message body. A message
- # body, and thus a payload, is allowed only if the HTTP method is
- # POST or PUT. It is an error to set a data payload on a task with
- # an incompatible HttpMethod.
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- #
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt fails with
- # error code 405 (Method Not Allowed). See [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the App Engine documentation for your runtime on [How Requests are
- # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
- "name": "A String", # Optionally caller-specified in CreateTask.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
+ "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
+ # set only if pull_target is set on the queue.
+ #
+ # A pull task is a task that has PullMessage set.
+ # LeaseTasks to process the task.
+ #
+ # This proto can only be used for tasks in a queue which has
+ # pull_target set.
+ "payload": "A String", # A data payload consumed by the worker to execute the task.
+ "tag": "A String", # The task's tag.
+ #
+ # Tags allow similar tasks to be processed in a batch. If you label
+ # tasks with a tag, your worker can
+ # lease tasks with the same tag using
+ # filter. For example, if you want to
+ # aggregate the events associated with a specific user once a day,
+ # you could tag tasks with the user ID.
+ #
+ # The task's tag can only be set when the
+ # task is created.
+ #
+ # The tag must be less than 500 characters.
+ #
+ # SDK compatibility: Although the SDK allows tags to be either
+ # string or
+ # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
+ # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
+ # encoded, the tag will be empty when the task is returned by Cloud Tasks.
+ },
+ "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.
+ #
+ # For pull queues, this is the time when the task is available to
+ # be leased; if a task is currently leased, this is the time when
+ # the current lease expires, that is, the time that the task was
+ # leased plus the lease_duration.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "status": { # Status of the task. # Output only. The task status.
+ "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
+ #
+ # Only dispatch_time will be set.
+ # The other AttemptStatus information is not retained by Cloud Tasks.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
+ #
+ # This field is not calculated for pull tasks.
+ "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ },
+ "name": "A String", # Optionally caller-specified in CreateTask.
#
# The task name.
#
@@ -3400,7 +3415,7 @@
# 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.
+ # * `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/.
@@ -3408,21 +3423,6 @@
# 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.
- #
- # For pull queues, this is the time when the task is available to
- # be leased; if a task is currently leased, this is the time when
- # the current lease expires, that is, the time that the task was
- # leased plus the lease_duration.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
}</pre>
</div>
@@ -3443,11 +3443,11 @@
contains the status after the task is dispatched but
before the task is received by its target.
-If Cloud Tasks receives a successful response from the task's
-target, then the task will be deleted; otherwise the task's
+If Cloud Tasks receives a successful response from the task's
+target, then the task will be deleted; otherwise the task's
schedule_time will be reset to the time that
RunTask was called plus the retry delay specified
-in the queue's RetryConfig.
+in the queue's RetryConfig.
RunTask returns
NOT_FOUND when it is called on a
@@ -3464,7 +3464,7 @@
{ # Request message for forcing a task to run now using
# RunTask.
- "responseView": "A String", # The response_view specifies which subset of the Task will be
+ "responseView": "A String", # The response_view specifies which subset of the Task will be
# returned.
#
# By default response_view is BASIC; not all
@@ -3487,116 +3487,7 @@
An object of the form:
{ # A unit of scheduled work.
- "status": { # Status of the task. # Output only. The task status.
- "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
- #
- # Only dispatch_time will be set.
- # The other AttemptStatus information is not retained by Cloud Tasks.
- #
- # This field is not calculated for pull tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
- #
- # If the task has not been attempted or the task is currently running
- # then the response status is unset.
- # 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.
- },
- ],
- },
- },
- "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
- "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
- #
- # This field is not calculated for pull tasks.
- },
- "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
- # set only if pull_target is set on the queue.
- #
- # A pull task is a task that has PullMessage set.
- # LeaseTasks to process the task.
- #
- # This proto can only be used for tasks in a queue which has
- # pull_target set.
- "tag": "A String", # The task's tag.
- #
- # Tags allow similar tasks to be processed in a batch. If you label
- # tasks with a tag, your worker can
- # lease tasks with the same tag using
- # filter. For example, if you want to
- # aggregate the events associated with a specific user once a day,
- # you could tag tasks with the user ID.
- #
- # The task's tag can only be set when the
- # task is created.
- #
- # The tag must be less than 500 characters.
- #
- # SDK compatibility: Although the SDK allows tags to be either
- # string or
- # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
- # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
- # encoded, the tag will be empty when the task is returned by Cloud Tasks.
- "payload": "A String", # A data payload consumed by the worker to execute the task.
- },
- "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
+ "appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
# be set only if
# app_engine_http_target is set
# on the queue.
@@ -3654,24 +3545,38 @@
# required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
# Task dispatches also do not follow redirects.
#
- # The task attempt has succeeded if the app's request handler returns an HTTP
+ # The task attempt has succeeded if the app's request handler returns an HTTP
# response code in the range [`200` - `299`]. The task attempt has failed if
- # the app's handler returns a non-2xx response code or Cloud Tasks does
+ # the app's handler returns a non-2xx response code or Cloud Tasks does
# not receive response before the deadline. Failed
# tasks will be retried according to the
# retry configuration. `503` (Service Unavailable) is
# considered an App Engine system error instead of an application error and
- # will cause Cloud Tasks' traffic congestion control to temporarily throttle
- # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
+ # will cause Cloud Tasks' traffic congestion control to temporarily throttle
+ # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
# Requests) response from an app handler does not cause traffic congestion
# control to throttle the queue.
- "relativeUrl": "A String", # The relative URL.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
#
- # The relative URL must begin with "/" and must be a valid HTTP relative URL.
+ # 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).
+ "payload": "A String", # Payload.
+ #
+ # The payload will be sent as the HTTP message body. A message
+ # body, and thus a payload, is allowed only if the HTTP method is
+ # POST or PUT. It is an error to set a data payload on a task with
+ # an incompatible HttpMethod.
+ "relativeUrl": "A String", # The relative URL.
+ #
+ # The relative URL must begin with "/" and must be a valid HTTP relative URL.
# It can contain a path and query string arguments.
- # If the relative URL is empty, then the root path "/" will be used.
+ # If the relative URL is empty, then the root path "/" will be used.
# No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
+ "headers": { # HTTP request headers.
#
# This map contains the header field names and values.
# Headers can be set when the
@@ -3681,19 +3586,19 @@
# Cloud Tasks sets some headers to default values:
#
# * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # `"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
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
# modified `User-Agent`.
#
# If the task has a payload, Cloud
# Tasks sets the following headers:
#
# * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
+ # `"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"`.
+ # 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.
#
@@ -3713,9 +3618,9 @@
# 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",
+ "a_key": "A String",
},
- "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
+ "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
# app_engine_routing_override
@@ -3734,7 +3639,7 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -3747,7 +3652,23 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -3757,17 +3678,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -3775,22 +3696,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -3808,23 +3729,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -3841,22 +3746,132 @@
# version, and
# instance are the empty string.
},
- "payload": "A String", # Payload.
- #
- # The payload will be sent as the HTTP message body. A message
- # body, and thus a payload, is allowed only if the HTTP method is
- # POST or PUT. It is an error to set a data payload on a task with
- # an incompatible HttpMethod.
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- #
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt fails with
- # error code 405 (Method Not Allowed). See [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the App Engine documentation for your runtime on [How Requests are
- # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
},
- "name": "A String", # Optionally caller-specified in CreateTask.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
+ "pullMessage": { # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. Can be
+ # set only if pull_target is set on the queue.
+ #
+ # A pull task is a task that has PullMessage set.
+ # LeaseTasks to process the task.
+ #
+ # This proto can only be used for tasks in a queue which has
+ # pull_target set.
+ "payload": "A String", # A data payload consumed by the worker to execute the task.
+ "tag": "A String", # The task's tag.
+ #
+ # Tags allow similar tasks to be processed in a batch. If you label
+ # tasks with a tag, your worker can
+ # lease tasks with the same tag using
+ # filter. For example, if you want to
+ # aggregate the events associated with a specific user once a day,
+ # you could tag tasks with the user ID.
+ #
+ # The task's tag can only be set when the
+ # task is created.
+ #
+ # The tag must be less than 500 characters.
+ #
+ # SDK compatibility: Although the SDK allows tags to be either
+ # string or
+ # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
+ # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
+ # encoded, the tag will be empty when the task is returned by Cloud Tasks.
+ },
+ "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.
+ #
+ # For pull queues, this is the time when the task is available to
+ # be leased; if a task is currently leased, this is the time when
+ # the current lease expires, that is, the time that the task was
+ # leased plus the lease_duration.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "status": { # Status of the task. # Output only. The task status.
+ "attemptDispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt.
+ #
+ # Only dispatch_time will be set.
+ # The other AttemptStatus information is not retained by Cloud Tasks.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ "attemptResponseCount": 42, # Output only. The number of attempts which have received a response.
+ #
+ # This field is not calculated for pull tasks.
+ "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ #
+ # This field is not calculated for pull tasks.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for this attempt.
+ #
+ # If the task has not been attempted or the task is currently running
+ # then the response status is unset.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ },
+ },
+ "name": "A String", # Optionally caller-specified in CreateTask.
#
# The task name.
#
@@ -3868,7 +3883,7 @@
# 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.
+ # * `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/.
@@ -3876,21 +3891,6 @@
# 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.
- #
- # For pull queues, this is the time when the task is available to
- # be leased; if a task is currently leased, this is the time when
- # the current lease expires, that is, the time that the task was
- # leased plus the lease_duration.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
}</pre>
</div>