docs: update generated docs (#981)
diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html
index afb78ce..ea60994 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, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, responseView=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>
@@ -270,70 +270,6 @@
# 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.
- "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).
- "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.
- # No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -353,19 +289,22 @@
# 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.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service when the task is attempted.
#
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -443,26 +382,188 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # 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).
},
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
+ "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.
+ # No spaces are allowed, and the maximum length allowed is 2083 characters.
+ "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).
},
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ },
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_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.
+ },
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "name": "A String", # Optionally caller-specified in CreateTask.
+ #
+ # The task name.
+ #
+ # The task name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the task's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"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.
#
@@ -502,109 +603,8 @@
# 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.
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "name": "A String", # Optionally caller-specified in CreateTask.
- #
- # The task name.
- #
- # The task name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the task's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
}</pre>
</div>
@@ -627,6 +627,18 @@
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 names have the following format:
@@ -729,70 +741,6 @@
# 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.
- "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).
- "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.
- # No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -812,19 +760,22 @@
# 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.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service when the task is attempted.
#
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -902,26 +853,188 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # 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).
},
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
+ "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.
+ # No spaces are allowed, and the maximum length allowed is 2083 characters.
+ "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).
},
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ },
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_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.
+ },
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "name": "A String", # Optionally caller-specified in CreateTask.
+ #
+ # The task name.
+ #
+ # The task name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the task's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"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.
#
@@ -961,122 +1074,9 @@
# 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.
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "name": "A String", # Optionally caller-specified in CreateTask.
- #
- # The task name.
- #
- # The task name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the task's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
+ "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.
@@ -1157,70 +1157,6 @@
# 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.
- "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).
- "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.
- # No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -1240,19 +1176,22 @@
# 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.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service when the task is attempted.
#
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -1330,26 +1269,188 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # 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).
},
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
+ "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.
+ # No spaces are allowed, and the maximum length allowed is 2083 characters.
+ "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).
},
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ },
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_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.
+ },
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "name": "A String", # Optionally caller-specified in CreateTask.
+ #
+ # The task name.
+ #
+ # The task name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the task's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"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.
#
@@ -1389,109 +1490,8 @@
# 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.
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "name": "A String", # Optionally caller-specified in CreateTask.
- #
- # The task name.
- #
- # The task name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the task's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
}</pre>
</div>
@@ -1623,70 +1623,6 @@
# 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.
- "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).
- "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.
- # No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -1706,19 +1642,22 @@
# 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.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service when the task is attempted.
#
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -1796,26 +1735,188 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # 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).
},
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
+ "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.
+ # No spaces are allowed, and the maximum length allowed is 2083 characters.
+ "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).
},
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ },
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_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.
+ },
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "name": "A String", # Optionally caller-specified in CreateTask.
+ #
+ # The task name.
+ #
+ # The task name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the task's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"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.
#
@@ -1855,109 +1956,8 @@
# 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.
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "name": "A String", # Optionally caller-specified in CreateTask.
- #
- # The task name.
- #
- # The task name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the task's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
}</pre>
</div>
@@ -2005,6 +2005,35 @@
# 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.
+ #
+ # Each task returned in the response will
+ # have its schedule_time set to the current
+ # time plus the `lease_duration`. The task is leased until its
+ # schedule_time; thus, the task will not be
+ # returned to another LeaseTasks call
+ # before its schedule_time.
+ #
+ #
+ # After the worker has successfully finished the work associated
+ # with the task, the worker must call via
+ # AcknowledgeTask before the
+ # schedule_time. Otherwise the task will be
+ # returned to a later LeaseTasks call so
+ # that another worker can retry it.
+ #
+ # The maximum lease duration is 1 week.
+ # `lease_duration` will be truncated to the nearest second.
+ "maxTasks": 42, # The maximum number of tasks to lease.
+ #
+ # The system will make a best effort to return as close to as
+ # `max_tasks` as possible.
+ #
+ # The largest that `max_tasks` can be is 1000.
+ #
+ # The maximum total size of a lease tasks response is
+ # 32 MB. If the sum of all task sizes requested reaches this limit,
+ # fewer tasks than requested are returned.
"filter": "A String", # `filter` can be used to specify a subset of tasks to lease.
#
# When `filter` is set to `tag=<my-tag>` then the
@@ -2034,35 +2063,6 @@
# aren't UTF-8 encoded can't be used in the
# filter and the task's
# tag will be displayed as empty in Cloud Tasks.
- "maxTasks": 42, # The maximum number of tasks to lease.
- #
- # The system will make a best effort to return as close to as
- # `max_tasks` as possible.
- #
- # The largest that `max_tasks` can be is 1000.
- #
- # The maximum total size of a lease tasks response is
- # 32 MB. If the sum of all task sizes requested reaches this limit,
- # fewer tasks than requested are returned.
- "leaseDuration": "A String", # Required. The duration of the lease.
- #
- # Each task returned in the response will
- # have its schedule_time set to the current
- # time plus the `lease_duration`. The task is leased until its
- # schedule_time; thus, the task will not be
- # returned to another LeaseTasks call
- # before its schedule_time.
- #
- #
- # After the worker has successfully finished the work associated
- # with the task, the worker must call via
- # AcknowledgeTask before the
- # schedule_time. Otherwise the task will be
- # returned to a later LeaseTasks call so
- # that another worker can retry it.
- #
- # The maximum lease duration is 1 week.
- # `lease_duration` will be truncated to the nearest second.
}
x__xgafv: string, V1 error format.
@@ -2145,70 +2145,6 @@
# 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.
- "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).
- "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.
- # No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -2228,19 +2164,22 @@
# 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.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service when the task is attempted.
#
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -2318,26 +2257,188 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # 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).
},
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
+ "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.
+ # No spaces are allowed, and the maximum length allowed is 2083 characters.
+ "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).
},
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ },
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_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.
+ },
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "name": "A String", # Optionally caller-specified in CreateTask.
+ #
+ # The task name.
+ #
+ # The task name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the task's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"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.
#
@@ -2377,116 +2478,15 @@
# 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.
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "name": "A String", # Optionally caller-specified in CreateTask.
- #
- # The task name.
- #
- # The task name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the task's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
+ "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, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, responseView=None, x__xgafv=None)</code>
<pre>Lists the tasks in a queue.
By default, only the BASIC view is retrieved
@@ -2500,6 +2500,23 @@
Args:
parent: string, Required. The queue name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` (required)
+ pageSize: integer, Maximum page size.
+
+Fewer tasks than requested might be returned, even if more tasks exist; use
+next_page_token in the response to
+determine if more tasks exist.
+
+The maximum page size is 1000. If unspecified, the page size will be the
+maximum.
+ pageToken: string, A token identifying the page of results to return.
+
+To request the first page results, page_token must be empty. To
+request the next page of results, page_token must be the value of
+next_page_token returned
+from the previous call to ListTasks
+method.
+
+The page token is valid for only 2 hours.
responseView: string, The response_view specifies which subset of the Task will be
returned.
@@ -2512,23 +2529,6 @@
Authorization for FULL requires
`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
permission on the Task resource.
- pageToken: string, A token identifying the page of results to return.
-
-To request the first page results, page_token must be empty. To
-request the next page of results, page_token must be the value of
-next_page_token returned
-from the previous call to ListTasks
-method.
-
-The page token is valid for only 2 hours.
- pageSize: integer, Maximum page size.
-
-Fewer tasks than requested might be returned, even if more tasks exist; use
-next_page_token in the response to
-determine if more tasks exist.
-
-The maximum page size is 1000. If unspecified, the page size will be the
-maximum.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -2538,6 +2538,13 @@
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.
{ # A unit of scheduled work.
"appEngineHttpRequest": { # App Engine HTTP request. # App Engine HTTP request that is sent to the task's target. Can
@@ -2609,70 +2616,6 @@
# 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.
- "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).
- "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.
- # No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -2692,19 +2635,22 @@
# 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.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service when the task is attempted.
#
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -2782,26 +2728,188 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # 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).
},
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
+ "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.
+ # No spaces are allowed, and the maximum length allowed is 2083 characters.
+ "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).
},
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ },
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_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.
+ },
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "name": "A String", # Optionally caller-specified in CreateTask.
+ #
+ # The task name.
+ #
+ # The task name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the task's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"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.
#
@@ -2841,118 +2949,10 @@
# 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.
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "name": "A String", # Optionally caller-specified in CreateTask.
- #
- # The task name.
- #
- # The task name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the task's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
+ "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>
@@ -2998,16 +2998,16 @@
# 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.
"leaseDuration": "A String", # Required. The desired new lease duration, starting from now.
#
#
# The maximum lease duration is 1 week.
# `lease_duration` will be truncated to the nearest second.
+ "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.
@@ -3088,70 +3088,6 @@
# 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.
- "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).
- "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.
- # No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -3171,19 +3107,22 @@
# 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.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service when the task is attempted.
#
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -3261,26 +3200,188 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # 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).
},
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
+ "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.
+ # No spaces are allowed, and the maximum length allowed is 2083 characters.
+ "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).
},
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ },
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_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.
+ },
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "name": "A String", # Optionally caller-specified in CreateTask.
+ #
+ # The task name.
+ #
+ # The task name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the task's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"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.
#
@@ -3320,109 +3421,8 @@
# 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.
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "name": "A String", # Optionally caller-specified in CreateTask.
- #
- # The task name.
- #
- # The task name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the task's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
}</pre>
</div>
@@ -3556,70 +3556,6 @@
# 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.
- "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).
- "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.
- # No spaces are allowed, and the maximum length allowed is 2083 characters.
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- # Repeated headers are not supported but a header value can contain commas.
- #
- # Cloud Tasks sets some headers to default values:
- #
- # * `User-Agent`: By default, this header is
- # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- # This header can be modified, but Cloud Tasks will append
- # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- # modified `User-Agent`.
- #
- # If the task has a payload, Cloud
- # Tasks sets the following headers:
- #
- # * `Content-Type`: By default, the `Content-Type` header is set to
- # `"application/octet-stream"`. The default can be overridden by explicitly
- # setting `Content-Type` to a particular media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/json"`.
- # * `Content-Length`: This is computed by Cloud Tasks. This value is
- # output only. It cannot be changed.
- #
- # The headers below cannot be set or overridden:
- #
- # * `Host`
- # * `X-Google-*`
- # * `X-AppEngine-*`
- #
- # In addition, Cloud Tasks sets some headers when the task is dispatched,
- # such as headers containing information about the task; see
- # [request
- # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- # These headers are set only when the task is dispatched, so they are not
- # visible when the task is returned in a Cloud Tasks response.
- #
- # Although there is no specific limit for the maximum number of headers or
- # the size, there is a limit on the maximum size of the Task. For more
- # information, see the CreateTask documentation.
- "a_key": "A String",
- },
"appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
# If set,
@@ -3639,19 +3575,22 @@
# 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.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service when the task is attempted.
#
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -3729,26 +3668,188 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # 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).
},
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ # Repeated headers are not supported but a header value can contain commas.
+ #
+ # Cloud Tasks sets some headers to default values:
+ #
+ # * `User-Agent`: By default, this header is
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
+ # This header can be modified, but Cloud Tasks will append
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
+ # modified `User-Agent`.
+ #
+ # If the task has a payload, Cloud
+ # Tasks sets the following headers:
+ #
+ # * `Content-Type`: By default, the `Content-Type` header is set to
+ # `"application/octet-stream"`. The default can be overridden by explicitly
+ # setting `Content-Type` to a particular media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/json"`.
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
+ # output only. It cannot be changed.
+ #
+ # The headers below cannot be set or overridden:
+ #
+ # * `Host`
+ # * `X-Google-*`
+ # * `X-AppEngine-*`
+ #
+ # In addition, Cloud Tasks sets some headers when the task is dispatched,
+ # such as headers containing information about the task; see
+ # [request
+ # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+ # These headers are set only when the task is dispatched, so they are not
+ # visible when the task is returned in a Cloud Tasks response.
+ #
+ # Although there is no specific limit for the maximum number of headers or
+ # the size, there is a limit on the maximum size of the Task. For more
+ # information, see the CreateTask documentation.
+ "a_key": "A String",
+ },
+ "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.
+ # No spaces are allowed, and the maximum length allowed is 2083 characters.
+ "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).
},
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ },
+ "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.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_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.
+ },
+ ],
+ },
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_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.
+ },
+ "createTime": "A String", # Output only. The time that the task was created.
+ #
+ # `create_time` will be truncated to the nearest second.
+ "name": "A String", # Optionally caller-specified in CreateTask.
+ #
+ # The task name.
+ #
+ # The task name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the task's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
"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.
#
@@ -3788,109 +3889,8 @@
# 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.
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "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).
- "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.
- "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.
- },
- ],
- },
- "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.
- },
- "name": "A String", # Optionally caller-specified in CreateTask.
- #
- # The task name.
- #
- # The task name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the task's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), or underscores (_). The maximum length is 500 characters.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
}</pre>
</div>