docs: update generated docs (#981)
diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
index bcc4c84..eb65be9 100644
--- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
+++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name, responseView=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a task.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, responseView=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, responseView=None, pageSize=None, pageToken=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>
@@ -156,6 +156,254 @@
# uniform distribution of task ids to store and serve tasks
# efficiently.
"responseCount": 42, # Output only. The number of attempts which have received a response.
+ "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "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.
+ },
+ ],
+ },
+ },
+ "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.
+ "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
+ #
+ # For App Engine queues, this is when the task will be attempted or retried.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "httpRequest": { # HTTP request. # HTTP request that is sent to the task's target.
+ #
+ # An HTTP task is a task that has HttpRequest set.
+ #
+ # The task will be pushed to the worker as an HTTP request. If the worker
+ # or the redirected worker acknowledges the task by returning a successful HTTP
+ # response code ([`200` - `299`]), the task will be removed from the queue. If
+ # any other HTTP response code is returned or no response is received, the
+ # task will be retried according to the following:
+ #
+ # * User-specified throttling: retry configuration,
+ # rate limits, and the queue's state.
+ #
+ # * System throttling: To prevent the worker from overloading, Cloud Tasks may
+ # temporarily reduce the queue's effective rate. User-specified settings
+ # will not be changed.
+ #
+ # System throttling happens because:
+ #
+ # * Cloud Tasks backs off on all errors. Normally the backoff specified in
+ # rate limits will be used. But if the worker returns
+ # `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
+ # errors is high, Cloud Tasks will use a higher backoff rate. The retry
+ # specified in the `Retry-After` HTTP response header is considered.
+ #
+ # * To prevent traffic spikes and to smooth sudden increases in traffic,
+ # dispatches ramp up slowly when the queue is newly created or idle and
+ # if large numbers of tasks suddenly become available to dispatch (due to
+ # spikes in create task rates, the queue being unpaused, or many tasks
+ # that are scheduled at the same time).
+ "oidcToken": { # Contains information needed for generating an # If specified, an
+ # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
+ # token will be generated and attached as an `Authorization` header in the
+ # HTTP request.
+ #
+ # This type of authorization can be used for many scenarios, including
+ # calling Cloud Run, or endpoints where you intend to validate the token
+ # yourself.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ # This type of authorization can be used for many scenarios, including
+ # calling Cloud Run, or endpoints where you intend to validate the token
+ # yourself.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating OIDC token.
+ # The service account must be within the same project as the queue. The
+ # caller must have iam.serviceAccounts.actAs permission for the service
+ # account.
+ "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI
+ # specified in target will be used.
+ },
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
+ #
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating OAuth token.
+ # The service account must be within the same project as the queue. The
+ # caller must have iam.serviceAccounts.actAs permission for the service
+ # account.
+ "scope": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
+ },
+ "url": "A String", # Required. The full url path that the request will be sent to.
+ #
+ # This string must begin with either "http://" or "https://". Some examples
+ # are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
+ # encode some characters for safety and compatibility. The maximum allowed
+ # URL length is 2083 characters after encoding.
+ #
+ # The `Location` header response from a redirect response [`300` - `399`]
+ # may be followed. The redirect is not counted as a separate attempt.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ #
+ # These headers represent a subset of the headers that will accompany the
+ # task's HTTP request. Some HTTP request headers will be ignored or replaced.
+ #
+ # A partial list of headers that will be ignored or replaced is:
+ #
+ # * Host: This will be computed by Cloud Tasks and derived from
+ # HttpRequest.url.
+ # * Content-Length: This will be computed by Cloud Tasks.
+ # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
+ # * X-Google-*: Google use only.
+ # * X-AppEngine-*: Google use only.
+ #
+ # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
+ # `Content-Type` to a media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/octet-stream"` or
+ # `"application/json"`.
+ #
+ # Headers which can have multiple values (according to RFC2616) can be
+ # specified using comma-separated values.
+ #
+ # The size of the headers must be less than 80KB.
+ "a_key": "A String",
+ },
+ "body": "A String", # HTTP request body.
+ #
+ # A request body is allowed only if the
+ # HTTP method is POST, PUT, or PATCH. It is an
+ # error to set body on a task with an incompatible HttpMethod.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ },
+ "firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
+ #
+ # Only dispatch_time will be set.
+ # The other Attempt information is not retained by Cloud Tasks.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "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 worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "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.
+ },
+ ],
+ },
+ },
+ "dispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
+ # respond by this deadline then the request is cancelled and the attempt
+ # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
+ # task according to the RetryConfig.
+ #
+ # Note that when the request is cancelled, Cloud Tasks will stop listening
+ # for the response, but whether the worker stops processing depends on the
+ # worker. For example, if the worker is stuck, it may not react to cancelled
+ # requests.
+ #
+ # The default and maximum values depend on the type of request:
+ #
+ # * For HTTP tasks, the default is 10 minutes. The deadline
+ # must be in the interval [15 seconds, 30 minutes].
+ #
+ # * For App Engine tasks, 0 indicates that the
+ # request has the default deadline. The default deadline depends on the
+ # [scaling
+ # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
+ # of the service: 10 minutes for standard apps with automatic scaling, 24
+ # hours for standard apps with manual and basic scaling, and 60 minutes for
+ # flex apps. If the request deadline is set, it must be in the interval [15
+ # seconds, 24 hours 15 seconds]. Regardless of the task's
+ # `dispatch_deadline`, the app handler will not run for longer than than
+ # the service's timeout. We recommend setting the `dispatch_deadline` to
+ # at most a few seconds more than the app handler's timeout. For more
+ # information see
+ # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
+ #
+ # `dispatch_deadline` will be truncated to the nearest millisecond. The
+ # deadline is an approximate deadline.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
# An App Engine task is a task that has AppEngineHttpRequest set.
@@ -219,6 +467,10 @@
# 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.
+ "body": "A String", # HTTP request body.
+ #
+ # A request body is allowed only if the HTTP method is POST or PUT. It is
+ # an error to set a body on a task with an incompatible HttpMethod.
"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
@@ -227,16 +479,82 @@
# 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).
- "body": "A String", # HTTP request body.
+ "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
- # A request body is allowed only if the HTTP method is POST or PUT. It is
- # an error to set a body on a task with an incompatible HttpMethod.
- "relativeUri": "A String", # The relative URI.
+ # If set,
+ # app_engine_routing_override
+ # is used for all tasks in the queue, no matter what the setting is for the
+ # task-level app_engine_routing.
#
- # The relative URI must begin with "/" and must be a valid HTTP relative URI.
- # It can contain a path and query string arguments.
- # If the relative URI is empty, then the root path "/" will be used.
- # No spaces are allowed, and the maximum length allowed is 2083 characters.
+ # Defines routing characteristics specific to App Engine - service, version,
+ # and instance.
+ #
+ # For more information about services, versions, and instances see
+ # [An Overview of App
+ # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
+ # [Microservices Architecture on Google App
+ # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
+ # [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).
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available 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).
+ "service": "A String", # App service.
+ #
+ # By default, the task is sent to the service which is the default
+ # service 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.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ },
"headers": { # HTTP request headers.
#
# This map contains the header field names and values.
@@ -281,330 +599,12 @@
# information, see the CreateTask documentation.
"a_key": "A String",
},
- "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
+ "relativeUri": "A String", # The relative URI.
#
- # If set,
- # app_engine_routing_override
- # is used for all tasks in the queue, no matter what the setting is for the
- # task-level app_engine_routing.
- #
- # Defines routing characteristics specific to App Engine - service, version,
- # and instance.
- #
- # For more information about services, versions, and instances see
- # [An Overview of App
- # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
- # [Microservices Architecture on Google App
- # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
- # [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).
- "service": "A String", # App service.
- #
- # By default, the task is sent to the service which is the default
- # service 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.
- "instance": "A String", # App instance.
- #
- # By default, the task is sent to an instance which is available 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).
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- },
- },
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
- #
- # For App Engine queues, this is when the task will be attempted or retried.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "httpRequest": { # HTTP request. # HTTP request that is sent to the task's target.
- #
- # An HTTP task is a task that has HttpRequest set.
- #
- # The task will be pushed to the worker as an HTTP request. If the worker
- # or the redirected worker acknowledges the task by returning a successful HTTP
- # response code ([`200` - `299`]), the task will be removed from the queue. If
- # any other HTTP response code is returned or no response is received, the
- # task will be retried according to the following:
- #
- # * User-specified throttling: retry configuration,
- # rate limits, and the queue's state.
- #
- # * System throttling: To prevent the worker from overloading, Cloud Tasks may
- # temporarily reduce the queue's effective rate. User-specified settings
- # will not be changed.
- #
- # System throttling happens because:
- #
- # * Cloud Tasks backs off on all errors. Normally the backoff specified in
- # rate limits will be used. But if the worker returns
- # `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
- # errors is high, Cloud Tasks will use a higher backoff rate. The retry
- # specified in the `Retry-After` HTTP response header is considered.
- #
- # * To prevent traffic spikes and to smooth sudden increases in traffic,
- # dispatches ramp up slowly when the queue is newly created or idle and
- # if large numbers of tasks suddenly become available to dispatch (due to
- # spikes in create task rates, the queue being unpaused, or many tasks
- # that are scheduled at the same time).
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # will be generated and attached as an `Authorization` header in the HTTP
- # request.
- #
- # This type of authorization should generally only be used when calling
- # Google APIs hosted on *.googleapis.com.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating OAuth token.
- # The service account must be within the same project as the queue. The
- # caller must have iam.serviceAccounts.actAs permission for the service
- # account.
- },
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- #
- # These headers represent a subset of the headers that will accompany the
- # task's HTTP request. Some HTTP request headers will be ignored or replaced.
- #
- # A partial list of headers that will be ignored or replaced is:
- #
- # * Host: This will be computed by Cloud Tasks and derived from
- # HttpRequest.url.
- # * Content-Length: This will be computed by Cloud Tasks.
- # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
- # * X-Google-*: Google use only.
- # * X-AppEngine-*: Google use only.
- #
- # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
- # `Content-Type` to a media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/octet-stream"` or
- # `"application/json"`.
- #
- # Headers which can have multiple values (according to RFC2616) can be
- # specified using comma-separated values.
- #
- # The size of the headers must be less than 80KB.
- "a_key": "A String",
- },
- "url": "A String", # Required. The full url path that the request will be sent to.
- #
- # This string must begin with either "http://" or "https://". Some examples
- # are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
- # encode some characters for safety and compatibility. The maximum allowed
- # URL length is 2083 characters after encoding.
- #
- # The `Location` header response from a redirect response [`300` - `399`]
- # may be followed. The redirect is not counted as a separate attempt.
- "oidcToken": { # Contains information needed for generating an # If specified, an
- # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
- # token will be generated and attached as an `Authorization` header in the
- # HTTP request.
- #
- # This type of authorization can be used for many scenarios, including
- # calling Cloud Run, or endpoints where you intend to validate the token
- # yourself.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- # This type of authorization can be used for many scenarios, including
- # calling Cloud Run, or endpoints where you intend to validate the token
- # yourself.
- "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI
- # specified in target will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating OIDC token.
- # The service account must be within the same project as the queue. The
- # caller must have iam.serviceAccounts.actAs permission for the service
- # account.
- },
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- "body": "A String", # HTTP request body.
- #
- # A request body is allowed only if the
- # HTTP method is POST, PUT, or PATCH. It is an
- # error to set body on a task with an incompatible HttpMethod.
- },
- "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.
- "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
- # respond by this deadline then the request is cancelled and the attempt
- # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
- # task according to the RetryConfig.
- #
- # Note that when the request is cancelled, Cloud Tasks will stop listing for
- # the response, but whether the worker stops processing depends on the
- # worker. For example, if the worker is stuck, it may not react to cancelled
- # requests.
- #
- # The default and maximum values depend on the type of request:
- #
- # * For HTTP tasks, the default is 10 minutes. The deadline
- # must be in the interval [15 seconds, 30 minutes].
- #
- # * For App Engine tasks, 0 indicates that the
- # request has the default deadline. The default deadline depends on the
- # [scaling
- # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
- # of the service: 10 minutes for standard apps with automatic scaling, 24
- # hours for standard apps with manual and basic scaling, and 60 minutes for
- # flex apps. If the request deadline is set, it must be in the interval [15
- # seconds, 24 hours 15 seconds]. Regardless of the task's
- # `dispatch_deadline`, the app handler will not run for longer than than
- # the service's timeout. We recommend setting the `dispatch_deadline` to
- # at most a few seconds more than the app handler's timeout. For more
- # information see
- # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
- #
- # `dispatch_deadline` will be truncated to the nearest millisecond. The
- # deadline is an approximate deadline.
- "firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
- #
- # Only dispatch_time will be set.
- # The other Attempt information is not retained by Cloud Tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
- #
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- },
- "dispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
- "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
- #
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
+ # The relative URI must begin with "/" and must be a valid HTTP relative URI.
+ # It can contain a path and query string arguments.
+ # If the relative URI is empty, then the root path "/" will be used.
+ # No spaces are allowed, and the maximum length allowed is 2083 characters.
},
},
}
@@ -619,6 +619,254 @@
{ # A unit of scheduled work.
"responseCount": 42, # Output only. The number of attempts which have received a response.
+ "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "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.
+ },
+ ],
+ },
+ },
+ "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.
+ "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
+ #
+ # For App Engine queues, this is when the task will be attempted or retried.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "httpRequest": { # HTTP request. # HTTP request that is sent to the task's target.
+ #
+ # An HTTP task is a task that has HttpRequest set.
+ #
+ # The task will be pushed to the worker as an HTTP request. If the worker
+ # or the redirected worker acknowledges the task by returning a successful HTTP
+ # response code ([`200` - `299`]), the task will be removed from the queue. If
+ # any other HTTP response code is returned or no response is received, the
+ # task will be retried according to the following:
+ #
+ # * User-specified throttling: retry configuration,
+ # rate limits, and the queue's state.
+ #
+ # * System throttling: To prevent the worker from overloading, Cloud Tasks may
+ # temporarily reduce the queue's effective rate. User-specified settings
+ # will not be changed.
+ #
+ # System throttling happens because:
+ #
+ # * Cloud Tasks backs off on all errors. Normally the backoff specified in
+ # rate limits will be used. But if the worker returns
+ # `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
+ # errors is high, Cloud Tasks will use a higher backoff rate. The retry
+ # specified in the `Retry-After` HTTP response header is considered.
+ #
+ # * To prevent traffic spikes and to smooth sudden increases in traffic,
+ # dispatches ramp up slowly when the queue is newly created or idle and
+ # if large numbers of tasks suddenly become available to dispatch (due to
+ # spikes in create task rates, the queue being unpaused, or many tasks
+ # that are scheduled at the same time).
+ "oidcToken": { # Contains information needed for generating an # If specified, an
+ # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
+ # token will be generated and attached as an `Authorization` header in the
+ # HTTP request.
+ #
+ # This type of authorization can be used for many scenarios, including
+ # calling Cloud Run, or endpoints where you intend to validate the token
+ # yourself.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ # This type of authorization can be used for many scenarios, including
+ # calling Cloud Run, or endpoints where you intend to validate the token
+ # yourself.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating OIDC token.
+ # The service account must be within the same project as the queue. The
+ # caller must have iam.serviceAccounts.actAs permission for the service
+ # account.
+ "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI
+ # specified in target will be used.
+ },
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
+ #
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating OAuth token.
+ # The service account must be within the same project as the queue. The
+ # caller must have iam.serviceAccounts.actAs permission for the service
+ # account.
+ "scope": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
+ },
+ "url": "A String", # Required. The full url path that the request will be sent to.
+ #
+ # This string must begin with either "http://" or "https://". Some examples
+ # are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
+ # encode some characters for safety and compatibility. The maximum allowed
+ # URL length is 2083 characters after encoding.
+ #
+ # The `Location` header response from a redirect response [`300` - `399`]
+ # may be followed. The redirect is not counted as a separate attempt.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ #
+ # These headers represent a subset of the headers that will accompany the
+ # task's HTTP request. Some HTTP request headers will be ignored or replaced.
+ #
+ # A partial list of headers that will be ignored or replaced is:
+ #
+ # * Host: This will be computed by Cloud Tasks and derived from
+ # HttpRequest.url.
+ # * Content-Length: This will be computed by Cloud Tasks.
+ # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
+ # * X-Google-*: Google use only.
+ # * X-AppEngine-*: Google use only.
+ #
+ # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
+ # `Content-Type` to a media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/octet-stream"` or
+ # `"application/json"`.
+ #
+ # Headers which can have multiple values (according to RFC2616) can be
+ # specified using comma-separated values.
+ #
+ # The size of the headers must be less than 80KB.
+ "a_key": "A String",
+ },
+ "body": "A String", # HTTP request body.
+ #
+ # A request body is allowed only if the
+ # HTTP method is POST, PUT, or PATCH. It is an
+ # error to set body on a task with an incompatible HttpMethod.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ },
+ "firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
+ #
+ # Only dispatch_time will be set.
+ # The other Attempt information is not retained by Cloud Tasks.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "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 worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "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.
+ },
+ ],
+ },
+ },
+ "dispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
+ # respond by this deadline then the request is cancelled and the attempt
+ # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
+ # task according to the RetryConfig.
+ #
+ # Note that when the request is cancelled, Cloud Tasks will stop listening
+ # for the response, but whether the worker stops processing depends on the
+ # worker. For example, if the worker is stuck, it may not react to cancelled
+ # requests.
+ #
+ # The default and maximum values depend on the type of request:
+ #
+ # * For HTTP tasks, the default is 10 minutes. The deadline
+ # must be in the interval [15 seconds, 30 minutes].
+ #
+ # * For App Engine tasks, 0 indicates that the
+ # request has the default deadline. The default deadline depends on the
+ # [scaling
+ # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
+ # of the service: 10 minutes for standard apps with automatic scaling, 24
+ # hours for standard apps with manual and basic scaling, and 60 minutes for
+ # flex apps. If the request deadline is set, it must be in the interval [15
+ # seconds, 24 hours 15 seconds]. Regardless of the task's
+ # `dispatch_deadline`, the app handler will not run for longer than than
+ # the service's timeout. We recommend setting the `dispatch_deadline` to
+ # at most a few seconds more than the app handler's timeout. For more
+ # information see
+ # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
+ #
+ # `dispatch_deadline` will be truncated to the nearest millisecond. The
+ # deadline is an approximate deadline.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
# An App Engine task is a task that has AppEngineHttpRequest set.
@@ -682,6 +930,10 @@
# 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.
+ "body": "A String", # HTTP request body.
+ #
+ # A request body is allowed only if the HTTP method is POST or PUT. It is
+ # an error to set a body on a task with an incompatible HttpMethod.
"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
@@ -690,16 +942,82 @@
# 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).
- "body": "A String", # HTTP request body.
+ "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
- # A request body is allowed only if the HTTP method is POST or PUT. It is
- # an error to set a body on a task with an incompatible HttpMethod.
- "relativeUri": "A String", # The relative URI.
+ # If set,
+ # app_engine_routing_override
+ # is used for all tasks in the queue, no matter what the setting is for the
+ # task-level app_engine_routing.
#
- # The relative URI must begin with "/" and must be a valid HTTP relative URI.
- # It can contain a path and query string arguments.
- # If the relative URI is empty, then the root path "/" will be used.
- # No spaces are allowed, and the maximum length allowed is 2083 characters.
+ # Defines routing characteristics specific to App Engine - service, version,
+ # and instance.
+ #
+ # For more information about services, versions, and instances see
+ # [An Overview of App
+ # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
+ # [Microservices Architecture on Google App
+ # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
+ # [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).
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available 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).
+ "service": "A String", # App service.
+ #
+ # By default, the task is sent to the service which is the default
+ # service 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.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ },
"headers": { # HTTP request headers.
#
# This map contains the header field names and values.
@@ -744,330 +1062,12 @@
# information, see the CreateTask documentation.
"a_key": "A String",
},
- "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
+ "relativeUri": "A String", # The relative URI.
#
- # If set,
- # app_engine_routing_override
- # is used for all tasks in the queue, no matter what the setting is for the
- # task-level app_engine_routing.
- #
- # Defines routing characteristics specific to App Engine - service, version,
- # and instance.
- #
- # For more information about services, versions, and instances see
- # [An Overview of App
- # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
- # [Microservices Architecture on Google App
- # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
- # [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).
- "service": "A String", # App service.
- #
- # By default, the task is sent to the service which is the default
- # service 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.
- "instance": "A String", # App instance.
- #
- # By default, the task is sent to an instance which is available 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).
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- },
- },
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
- #
- # For App Engine queues, this is when the task will be attempted or retried.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "httpRequest": { # HTTP request. # HTTP request that is sent to the task's target.
- #
- # An HTTP task is a task that has HttpRequest set.
- #
- # The task will be pushed to the worker as an HTTP request. If the worker
- # or the redirected worker acknowledges the task by returning a successful HTTP
- # response code ([`200` - `299`]), the task will be removed from the queue. If
- # any other HTTP response code is returned or no response is received, the
- # task will be retried according to the following:
- #
- # * User-specified throttling: retry configuration,
- # rate limits, and the queue's state.
- #
- # * System throttling: To prevent the worker from overloading, Cloud Tasks may
- # temporarily reduce the queue's effective rate. User-specified settings
- # will not be changed.
- #
- # System throttling happens because:
- #
- # * Cloud Tasks backs off on all errors. Normally the backoff specified in
- # rate limits will be used. But if the worker returns
- # `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
- # errors is high, Cloud Tasks will use a higher backoff rate. The retry
- # specified in the `Retry-After` HTTP response header is considered.
- #
- # * To prevent traffic spikes and to smooth sudden increases in traffic,
- # dispatches ramp up slowly when the queue is newly created or idle and
- # if large numbers of tasks suddenly become available to dispatch (due to
- # spikes in create task rates, the queue being unpaused, or many tasks
- # that are scheduled at the same time).
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # will be generated and attached as an `Authorization` header in the HTTP
- # request.
- #
- # This type of authorization should generally only be used when calling
- # Google APIs hosted on *.googleapis.com.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating OAuth token.
- # The service account must be within the same project as the queue. The
- # caller must have iam.serviceAccounts.actAs permission for the service
- # account.
- },
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- #
- # These headers represent a subset of the headers that will accompany the
- # task's HTTP request. Some HTTP request headers will be ignored or replaced.
- #
- # A partial list of headers that will be ignored or replaced is:
- #
- # * Host: This will be computed by Cloud Tasks and derived from
- # HttpRequest.url.
- # * Content-Length: This will be computed by Cloud Tasks.
- # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
- # * X-Google-*: Google use only.
- # * X-AppEngine-*: Google use only.
- #
- # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
- # `Content-Type` to a media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/octet-stream"` or
- # `"application/json"`.
- #
- # Headers which can have multiple values (according to RFC2616) can be
- # specified using comma-separated values.
- #
- # The size of the headers must be less than 80KB.
- "a_key": "A String",
- },
- "url": "A String", # Required. The full url path that the request will be sent to.
- #
- # This string must begin with either "http://" or "https://". Some examples
- # are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
- # encode some characters for safety and compatibility. The maximum allowed
- # URL length is 2083 characters after encoding.
- #
- # The `Location` header response from a redirect response [`300` - `399`]
- # may be followed. The redirect is not counted as a separate attempt.
- "oidcToken": { # Contains information needed for generating an # If specified, an
- # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
- # token will be generated and attached as an `Authorization` header in the
- # HTTP request.
- #
- # This type of authorization can be used for many scenarios, including
- # calling Cloud Run, or endpoints where you intend to validate the token
- # yourself.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- # This type of authorization can be used for many scenarios, including
- # calling Cloud Run, or endpoints where you intend to validate the token
- # yourself.
- "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI
- # specified in target will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating OIDC token.
- # The service account must be within the same project as the queue. The
- # caller must have iam.serviceAccounts.actAs permission for the service
- # account.
- },
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- "body": "A String", # HTTP request body.
- #
- # A request body is allowed only if the
- # HTTP method is POST, PUT, or PATCH. It is an
- # error to set body on a task with an incompatible HttpMethod.
- },
- "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.
- "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
- # respond by this deadline then the request is cancelled and the attempt
- # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
- # task according to the RetryConfig.
- #
- # Note that when the request is cancelled, Cloud Tasks will stop listing for
- # the response, but whether the worker stops processing depends on the
- # worker. For example, if the worker is stuck, it may not react to cancelled
- # requests.
- #
- # The default and maximum values depend on the type of request:
- #
- # * For HTTP tasks, the default is 10 minutes. The deadline
- # must be in the interval [15 seconds, 30 minutes].
- #
- # * For App Engine tasks, 0 indicates that the
- # request has the default deadline. The default deadline depends on the
- # [scaling
- # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
- # of the service: 10 minutes for standard apps with automatic scaling, 24
- # hours for standard apps with manual and basic scaling, and 60 minutes for
- # flex apps. If the request deadline is set, it must be in the interval [15
- # seconds, 24 hours 15 seconds]. Regardless of the task's
- # `dispatch_deadline`, the app handler will not run for longer than than
- # the service's timeout. We recommend setting the `dispatch_deadline` to
- # at most a few seconds more than the app handler's timeout. For more
- # information see
- # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
- #
- # `dispatch_deadline` will be truncated to the nearest millisecond. The
- # deadline is an approximate deadline.
- "firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
- #
- # Only dispatch_time will be set.
- # The other Attempt information is not retained by Cloud Tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
- #
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- },
- "dispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
- "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
- #
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
+ # The relative URI must begin with "/" and must be a valid HTTP relative URI.
+ # It can contain a path and query string arguments.
+ # If the relative URI is empty, then the root path "/" will be used.
+ # No spaces are allowed, and the maximum length allowed is 2083 characters.
},
}</pre>
</div>
@@ -1132,6 +1132,254 @@
{ # A unit of scheduled work.
"responseCount": 42, # Output only. The number of attempts which have received a response.
+ "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "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.
+ },
+ ],
+ },
+ },
+ "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.
+ "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
+ #
+ # For App Engine queues, this is when the task will be attempted or retried.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "httpRequest": { # HTTP request. # HTTP request that is sent to the task's target.
+ #
+ # An HTTP task is a task that has HttpRequest set.
+ #
+ # The task will be pushed to the worker as an HTTP request. If the worker
+ # or the redirected worker acknowledges the task by returning a successful HTTP
+ # response code ([`200` - `299`]), the task will be removed from the queue. If
+ # any other HTTP response code is returned or no response is received, the
+ # task will be retried according to the following:
+ #
+ # * User-specified throttling: retry configuration,
+ # rate limits, and the queue's state.
+ #
+ # * System throttling: To prevent the worker from overloading, Cloud Tasks may
+ # temporarily reduce the queue's effective rate. User-specified settings
+ # will not be changed.
+ #
+ # System throttling happens because:
+ #
+ # * Cloud Tasks backs off on all errors. Normally the backoff specified in
+ # rate limits will be used. But if the worker returns
+ # `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
+ # errors is high, Cloud Tasks will use a higher backoff rate. The retry
+ # specified in the `Retry-After` HTTP response header is considered.
+ #
+ # * To prevent traffic spikes and to smooth sudden increases in traffic,
+ # dispatches ramp up slowly when the queue is newly created or idle and
+ # if large numbers of tasks suddenly become available to dispatch (due to
+ # spikes in create task rates, the queue being unpaused, or many tasks
+ # that are scheduled at the same time).
+ "oidcToken": { # Contains information needed for generating an # If specified, an
+ # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
+ # token will be generated and attached as an `Authorization` header in the
+ # HTTP request.
+ #
+ # This type of authorization can be used for many scenarios, including
+ # calling Cloud Run, or endpoints where you intend to validate the token
+ # yourself.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ # This type of authorization can be used for many scenarios, including
+ # calling Cloud Run, or endpoints where you intend to validate the token
+ # yourself.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating OIDC token.
+ # The service account must be within the same project as the queue. The
+ # caller must have iam.serviceAccounts.actAs permission for the service
+ # account.
+ "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI
+ # specified in target will be used.
+ },
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
+ #
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating OAuth token.
+ # The service account must be within the same project as the queue. The
+ # caller must have iam.serviceAccounts.actAs permission for the service
+ # account.
+ "scope": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
+ },
+ "url": "A String", # Required. The full url path that the request will be sent to.
+ #
+ # This string must begin with either "http://" or "https://". Some examples
+ # are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
+ # encode some characters for safety and compatibility. The maximum allowed
+ # URL length is 2083 characters after encoding.
+ #
+ # The `Location` header response from a redirect response [`300` - `399`]
+ # may be followed. The redirect is not counted as a separate attempt.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ #
+ # These headers represent a subset of the headers that will accompany the
+ # task's HTTP request. Some HTTP request headers will be ignored or replaced.
+ #
+ # A partial list of headers that will be ignored or replaced is:
+ #
+ # * Host: This will be computed by Cloud Tasks and derived from
+ # HttpRequest.url.
+ # * Content-Length: This will be computed by Cloud Tasks.
+ # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
+ # * X-Google-*: Google use only.
+ # * X-AppEngine-*: Google use only.
+ #
+ # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
+ # `Content-Type` to a media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/octet-stream"` or
+ # `"application/json"`.
+ #
+ # Headers which can have multiple values (according to RFC2616) can be
+ # specified using comma-separated values.
+ #
+ # The size of the headers must be less than 80KB.
+ "a_key": "A String",
+ },
+ "body": "A String", # HTTP request body.
+ #
+ # A request body is allowed only if the
+ # HTTP method is POST, PUT, or PATCH. It is an
+ # error to set body on a task with an incompatible HttpMethod.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ },
+ "firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
+ #
+ # Only dispatch_time will be set.
+ # The other Attempt information is not retained by Cloud Tasks.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "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 worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "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.
+ },
+ ],
+ },
+ },
+ "dispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
+ # respond by this deadline then the request is cancelled and the attempt
+ # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
+ # task according to the RetryConfig.
+ #
+ # Note that when the request is cancelled, Cloud Tasks will stop listening
+ # for the response, but whether the worker stops processing depends on the
+ # worker. For example, if the worker is stuck, it may not react to cancelled
+ # requests.
+ #
+ # The default and maximum values depend on the type of request:
+ #
+ # * For HTTP tasks, the default is 10 minutes. The deadline
+ # must be in the interval [15 seconds, 30 minutes].
+ #
+ # * For App Engine tasks, 0 indicates that the
+ # request has the default deadline. The default deadline depends on the
+ # [scaling
+ # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
+ # of the service: 10 minutes for standard apps with automatic scaling, 24
+ # hours for standard apps with manual and basic scaling, and 60 minutes for
+ # flex apps. If the request deadline is set, it must be in the interval [15
+ # seconds, 24 hours 15 seconds]. Regardless of the task's
+ # `dispatch_deadline`, the app handler will not run for longer than than
+ # the service's timeout. We recommend setting the `dispatch_deadline` to
+ # at most a few seconds more than the app handler's timeout. For more
+ # information see
+ # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
+ #
+ # `dispatch_deadline` will be truncated to the nearest millisecond. The
+ # deadline is an approximate deadline.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
# An App Engine task is a task that has AppEngineHttpRequest set.
@@ -1195,6 +1443,10 @@
# 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.
+ "body": "A String", # HTTP request body.
+ #
+ # A request body is allowed only if the HTTP method is POST or PUT. It is
+ # an error to set a body on a task with an incompatible HttpMethod.
"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
@@ -1203,16 +1455,82 @@
# 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).
- "body": "A String", # HTTP request body.
+ "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
- # A request body is allowed only if the HTTP method is POST or PUT. It is
- # an error to set a body on a task with an incompatible HttpMethod.
- "relativeUri": "A String", # The relative URI.
+ # If set,
+ # app_engine_routing_override
+ # is used for all tasks in the queue, no matter what the setting is for the
+ # task-level app_engine_routing.
#
- # The relative URI must begin with "/" and must be a valid HTTP relative URI.
- # It can contain a path and query string arguments.
- # If the relative URI is empty, then the root path "/" will be used.
- # No spaces are allowed, and the maximum length allowed is 2083 characters.
+ # Defines routing characteristics specific to App Engine - service, version,
+ # and instance.
+ #
+ # For more information about services, versions, and instances see
+ # [An Overview of App
+ # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
+ # [Microservices Architecture on Google App
+ # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
+ # [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).
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available 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).
+ "service": "A String", # App service.
+ #
+ # By default, the task is sent to the service which is the default
+ # service 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.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ },
"headers": { # HTTP request headers.
#
# This map contains the header field names and values.
@@ -1257,336 +1575,18 @@
# information, see the CreateTask documentation.
"a_key": "A String",
},
- "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
+ "relativeUri": "A String", # The relative URI.
#
- # If set,
- # app_engine_routing_override
- # is used for all tasks in the queue, no matter what the setting is for the
- # task-level app_engine_routing.
- #
- # Defines routing characteristics specific to App Engine - service, version,
- # and instance.
- #
- # For more information about services, versions, and instances see
- # [An Overview of App
- # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
- # [Microservices Architecture on Google App
- # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
- # [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).
- "service": "A String", # App service.
- #
- # By default, the task is sent to the service which is the default
- # service 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.
- "instance": "A String", # App instance.
- #
- # By default, the task is sent to an instance which is available 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).
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- },
- },
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
- #
- # For App Engine queues, this is when the task will be attempted or retried.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "httpRequest": { # HTTP request. # HTTP request that is sent to the task's target.
- #
- # An HTTP task is a task that has HttpRequest set.
- #
- # The task will be pushed to the worker as an HTTP request. If the worker
- # or the redirected worker acknowledges the task by returning a successful HTTP
- # response code ([`200` - `299`]), the task will be removed from the queue. If
- # any other HTTP response code is returned or no response is received, the
- # task will be retried according to the following:
- #
- # * User-specified throttling: retry configuration,
- # rate limits, and the queue's state.
- #
- # * System throttling: To prevent the worker from overloading, Cloud Tasks may
- # temporarily reduce the queue's effective rate. User-specified settings
- # will not be changed.
- #
- # System throttling happens because:
- #
- # * Cloud Tasks backs off on all errors. Normally the backoff specified in
- # rate limits will be used. But if the worker returns
- # `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
- # errors is high, Cloud Tasks will use a higher backoff rate. The retry
- # specified in the `Retry-After` HTTP response header is considered.
- #
- # * To prevent traffic spikes and to smooth sudden increases in traffic,
- # dispatches ramp up slowly when the queue is newly created or idle and
- # if large numbers of tasks suddenly become available to dispatch (due to
- # spikes in create task rates, the queue being unpaused, or many tasks
- # that are scheduled at the same time).
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # will be generated and attached as an `Authorization` header in the HTTP
- # request.
- #
- # This type of authorization should generally only be used when calling
- # Google APIs hosted on *.googleapis.com.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating OAuth token.
- # The service account must be within the same project as the queue. The
- # caller must have iam.serviceAccounts.actAs permission for the service
- # account.
- },
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- #
- # These headers represent a subset of the headers that will accompany the
- # task's HTTP request. Some HTTP request headers will be ignored or replaced.
- #
- # A partial list of headers that will be ignored or replaced is:
- #
- # * Host: This will be computed by Cloud Tasks and derived from
- # HttpRequest.url.
- # * Content-Length: This will be computed by Cloud Tasks.
- # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
- # * X-Google-*: Google use only.
- # * X-AppEngine-*: Google use only.
- #
- # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
- # `Content-Type` to a media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/octet-stream"` or
- # `"application/json"`.
- #
- # Headers which can have multiple values (according to RFC2616) can be
- # specified using comma-separated values.
- #
- # The size of the headers must be less than 80KB.
- "a_key": "A String",
- },
- "url": "A String", # Required. The full url path that the request will be sent to.
- #
- # This string must begin with either "http://" or "https://". Some examples
- # are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
- # encode some characters for safety and compatibility. The maximum allowed
- # URL length is 2083 characters after encoding.
- #
- # The `Location` header response from a redirect response [`300` - `399`]
- # may be followed. The redirect is not counted as a separate attempt.
- "oidcToken": { # Contains information needed for generating an # If specified, an
- # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
- # token will be generated and attached as an `Authorization` header in the
- # HTTP request.
- #
- # This type of authorization can be used for many scenarios, including
- # calling Cloud Run, or endpoints where you intend to validate the token
- # yourself.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- # This type of authorization can be used for many scenarios, including
- # calling Cloud Run, or endpoints where you intend to validate the token
- # yourself.
- "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI
- # specified in target will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating OIDC token.
- # The service account must be within the same project as the queue. The
- # caller must have iam.serviceAccounts.actAs permission for the service
- # account.
- },
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- "body": "A String", # HTTP request body.
- #
- # A request body is allowed only if the
- # HTTP method is POST, PUT, or PATCH. It is an
- # error to set body on a task with an incompatible HttpMethod.
- },
- "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.
- "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
- # respond by this deadline then the request is cancelled and the attempt
- # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
- # task according to the RetryConfig.
- #
- # Note that when the request is cancelled, Cloud Tasks will stop listing for
- # the response, but whether the worker stops processing depends on the
- # worker. For example, if the worker is stuck, it may not react to cancelled
- # requests.
- #
- # The default and maximum values depend on the type of request:
- #
- # * For HTTP tasks, the default is 10 minutes. The deadline
- # must be in the interval [15 seconds, 30 minutes].
- #
- # * For App Engine tasks, 0 indicates that the
- # request has the default deadline. The default deadline depends on the
- # [scaling
- # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
- # of the service: 10 minutes for standard apps with automatic scaling, 24
- # hours for standard apps with manual and basic scaling, and 60 minutes for
- # flex apps. If the request deadline is set, it must be in the interval [15
- # seconds, 24 hours 15 seconds]. Regardless of the task's
- # `dispatch_deadline`, the app handler will not run for longer than than
- # the service's timeout. We recommend setting the `dispatch_deadline` to
- # at most a few seconds more than the app handler's timeout. For more
- # information see
- # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
- #
- # `dispatch_deadline` will be truncated to the nearest millisecond. The
- # deadline is an approximate deadline.
- "firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
- #
- # Only dispatch_time will be set.
- # The other Attempt information is not retained by Cloud Tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
- #
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- },
- "dispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
- "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
- #
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
+ # The relative URI must begin with "/" and must be a valid HTTP relative URI.
+ # It can contain a path and query string arguments.
+ # If the relative URI is empty, then the root path "/" will be used.
+ # No spaces are allowed, and the maximum length allowed is 2083 characters.
},
}</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, responseView=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the tasks in a queue.
By default, only the BASIC view is retrieved
@@ -1612,6 +1612,14 @@
Authorization for FULL requires
`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
permission on the Task resource.
+ pageSize: integer, Maximum page size.
+
+Fewer tasks than requested might be returned, even if more tasks exist; use
+next_page_token in the response to
+determine if more tasks exist.
+
+The maximum page size is 1000. If unspecified, the page size will be the
+maximum.
pageToken: string, A token identifying the page of results to return.
To request the first page results, page_token must be empty. To
@@ -1621,14 +1629,6 @@
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
@@ -1638,9 +1638,264 @@
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.
"responseCount": 42, # Output only. The number of attempts which have received a response.
+ "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "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.
+ },
+ ],
+ },
+ },
+ "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.
+ "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
+ #
+ # For App Engine queues, this is when the task will be attempted or retried.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "httpRequest": { # HTTP request. # HTTP request that is sent to the task's target.
+ #
+ # An HTTP task is a task that has HttpRequest set.
+ #
+ # The task will be pushed to the worker as an HTTP request. If the worker
+ # or the redirected worker acknowledges the task by returning a successful HTTP
+ # response code ([`200` - `299`]), the task will be removed from the queue. If
+ # any other HTTP response code is returned or no response is received, the
+ # task will be retried according to the following:
+ #
+ # * User-specified throttling: retry configuration,
+ # rate limits, and the queue's state.
+ #
+ # * System throttling: To prevent the worker from overloading, Cloud Tasks may
+ # temporarily reduce the queue's effective rate. User-specified settings
+ # will not be changed.
+ #
+ # System throttling happens because:
+ #
+ # * Cloud Tasks backs off on all errors. Normally the backoff specified in
+ # rate limits will be used. But if the worker returns
+ # `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
+ # errors is high, Cloud Tasks will use a higher backoff rate. The retry
+ # specified in the `Retry-After` HTTP response header is considered.
+ #
+ # * To prevent traffic spikes and to smooth sudden increases in traffic,
+ # dispatches ramp up slowly when the queue is newly created or idle and
+ # if large numbers of tasks suddenly become available to dispatch (due to
+ # spikes in create task rates, the queue being unpaused, or many tasks
+ # that are scheduled at the same time).
+ "oidcToken": { # Contains information needed for generating an # If specified, an
+ # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
+ # token will be generated and attached as an `Authorization` header in the
+ # HTTP request.
+ #
+ # This type of authorization can be used for many scenarios, including
+ # calling Cloud Run, or endpoints where you intend to validate the token
+ # yourself.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ # This type of authorization can be used for many scenarios, including
+ # calling Cloud Run, or endpoints where you intend to validate the token
+ # yourself.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating OIDC token.
+ # The service account must be within the same project as the queue. The
+ # caller must have iam.serviceAccounts.actAs permission for the service
+ # account.
+ "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI
+ # specified in target will be used.
+ },
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
+ #
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating OAuth token.
+ # The service account must be within the same project as the queue. The
+ # caller must have iam.serviceAccounts.actAs permission for the service
+ # account.
+ "scope": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
+ },
+ "url": "A String", # Required. The full url path that the request will be sent to.
+ #
+ # This string must begin with either "http://" or "https://". Some examples
+ # are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
+ # encode some characters for safety and compatibility. The maximum allowed
+ # URL length is 2083 characters after encoding.
+ #
+ # The `Location` header response from a redirect response [`300` - `399`]
+ # may be followed. The redirect is not counted as a separate attempt.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ #
+ # These headers represent a subset of the headers that will accompany the
+ # task's HTTP request. Some HTTP request headers will be ignored or replaced.
+ #
+ # A partial list of headers that will be ignored or replaced is:
+ #
+ # * Host: This will be computed by Cloud Tasks and derived from
+ # HttpRequest.url.
+ # * Content-Length: This will be computed by Cloud Tasks.
+ # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
+ # * X-Google-*: Google use only.
+ # * X-AppEngine-*: Google use only.
+ #
+ # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
+ # `Content-Type` to a media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/octet-stream"` or
+ # `"application/json"`.
+ #
+ # Headers which can have multiple values (according to RFC2616) can be
+ # specified using comma-separated values.
+ #
+ # The size of the headers must be less than 80KB.
+ "a_key": "A String",
+ },
+ "body": "A String", # HTTP request body.
+ #
+ # A request body is allowed only if the
+ # HTTP method is POST, PUT, or PATCH. It is an
+ # error to set body on a task with an incompatible HttpMethod.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ },
+ "firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
+ #
+ # Only dispatch_time will be set.
+ # The other Attempt information is not retained by Cloud Tasks.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "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 worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "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.
+ },
+ ],
+ },
+ },
+ "dispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
+ # respond by this deadline then the request is cancelled and the attempt
+ # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
+ # task according to the RetryConfig.
+ #
+ # Note that when the request is cancelled, Cloud Tasks will stop listening
+ # for the response, but whether the worker stops processing depends on the
+ # worker. For example, if the worker is stuck, it may not react to cancelled
+ # requests.
+ #
+ # The default and maximum values depend on the type of request:
+ #
+ # * For HTTP tasks, the default is 10 minutes. The deadline
+ # must be in the interval [15 seconds, 30 minutes].
+ #
+ # * For App Engine tasks, 0 indicates that the
+ # request has the default deadline. The default deadline depends on the
+ # [scaling
+ # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
+ # of the service: 10 minutes for standard apps with automatic scaling, 24
+ # hours for standard apps with manual and basic scaling, and 60 minutes for
+ # flex apps. If the request deadline is set, it must be in the interval [15
+ # seconds, 24 hours 15 seconds]. Regardless of the task's
+ # `dispatch_deadline`, the app handler will not run for longer than than
+ # the service's timeout. We recommend setting the `dispatch_deadline` to
+ # at most a few seconds more than the app handler's timeout. For more
+ # information see
+ # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
+ #
+ # `dispatch_deadline` will be truncated to the nearest millisecond. The
+ # deadline is an approximate deadline.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
# An App Engine task is a task that has AppEngineHttpRequest set.
@@ -1704,6 +1959,10 @@
# 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.
+ "body": "A String", # HTTP request body.
+ #
+ # A request body is allowed only if the HTTP method is POST or PUT. It is
+ # an error to set a body on a task with an incompatible HttpMethod.
"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
@@ -1712,16 +1971,82 @@
# 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).
- "body": "A String", # HTTP request body.
+ "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
- # A request body is allowed only if the HTTP method is POST or PUT. It is
- # an error to set a body on a task with an incompatible HttpMethod.
- "relativeUri": "A String", # The relative URI.
+ # If set,
+ # app_engine_routing_override
+ # is used for all tasks in the queue, no matter what the setting is for the
+ # task-level app_engine_routing.
#
- # The relative URI must begin with "/" and must be a valid HTTP relative URI.
- # It can contain a path and query string arguments.
- # If the relative URI is empty, then the root path "/" will be used.
- # No spaces are allowed, and the maximum length allowed is 2083 characters.
+ # Defines routing characteristics specific to App Engine - service, version,
+ # and instance.
+ #
+ # For more information about services, versions, and instances see
+ # [An Overview of App
+ # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
+ # [Microservices Architecture on Google App
+ # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
+ # [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).
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available 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).
+ "service": "A String", # App service.
+ #
+ # By default, the task is sent to the service which is the default
+ # service 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.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ },
"headers": { # HTTP request headers.
#
# This map contains the header field names and values.
@@ -1766,340 +2091,15 @@
# information, see the CreateTask documentation.
"a_key": "A String",
},
- "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
+ "relativeUri": "A String", # The relative URI.
#
- # If set,
- # app_engine_routing_override
- # is used for all tasks in the queue, no matter what the setting is for the
- # task-level app_engine_routing.
- #
- # Defines routing characteristics specific to App Engine - service, version,
- # and instance.
- #
- # For more information about services, versions, and instances see
- # [An Overview of App
- # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
- # [Microservices Architecture on Google App
- # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
- # [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).
- "service": "A String", # App service.
- #
- # By default, the task is sent to the service which is the default
- # service 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.
- "instance": "A String", # App instance.
- #
- # By default, the task is sent to an instance which is available 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).
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- },
- },
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
- #
- # For App Engine queues, this is when the task will be attempted or retried.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "httpRequest": { # HTTP request. # HTTP request that is sent to the task's target.
- #
- # An HTTP task is a task that has HttpRequest set.
- #
- # The task will be pushed to the worker as an HTTP request. If the worker
- # or the redirected worker acknowledges the task by returning a successful HTTP
- # response code ([`200` - `299`]), the task will be removed from the queue. If
- # any other HTTP response code is returned or no response is received, the
- # task will be retried according to the following:
- #
- # * User-specified throttling: retry configuration,
- # rate limits, and the queue's state.
- #
- # * System throttling: To prevent the worker from overloading, Cloud Tasks may
- # temporarily reduce the queue's effective rate. User-specified settings
- # will not be changed.
- #
- # System throttling happens because:
- #
- # * Cloud Tasks backs off on all errors. Normally the backoff specified in
- # rate limits will be used. But if the worker returns
- # `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
- # errors is high, Cloud Tasks will use a higher backoff rate. The retry
- # specified in the `Retry-After` HTTP response header is considered.
- #
- # * To prevent traffic spikes and to smooth sudden increases in traffic,
- # dispatches ramp up slowly when the queue is newly created or idle and
- # if large numbers of tasks suddenly become available to dispatch (due to
- # spikes in create task rates, the queue being unpaused, or many tasks
- # that are scheduled at the same time).
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # will be generated and attached as an `Authorization` header in the HTTP
- # request.
- #
- # This type of authorization should generally only be used when calling
- # Google APIs hosted on *.googleapis.com.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating OAuth token.
- # The service account must be within the same project as the queue. The
- # caller must have iam.serviceAccounts.actAs permission for the service
- # account.
- },
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- #
- # These headers represent a subset of the headers that will accompany the
- # task's HTTP request. Some HTTP request headers will be ignored or replaced.
- #
- # A partial list of headers that will be ignored or replaced is:
- #
- # * Host: This will be computed by Cloud Tasks and derived from
- # HttpRequest.url.
- # * Content-Length: This will be computed by Cloud Tasks.
- # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
- # * X-Google-*: Google use only.
- # * X-AppEngine-*: Google use only.
- #
- # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
- # `Content-Type` to a media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/octet-stream"` or
- # `"application/json"`.
- #
- # Headers which can have multiple values (according to RFC2616) can be
- # specified using comma-separated values.
- #
- # The size of the headers must be less than 80KB.
- "a_key": "A String",
- },
- "url": "A String", # Required. The full url path that the request will be sent to.
- #
- # This string must begin with either "http://" or "https://". Some examples
- # are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
- # encode some characters for safety and compatibility. The maximum allowed
- # URL length is 2083 characters after encoding.
- #
- # The `Location` header response from a redirect response [`300` - `399`]
- # may be followed. The redirect is not counted as a separate attempt.
- "oidcToken": { # Contains information needed for generating an # If specified, an
- # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
- # token will be generated and attached as an `Authorization` header in the
- # HTTP request.
- #
- # This type of authorization can be used for many scenarios, including
- # calling Cloud Run, or endpoints where you intend to validate the token
- # yourself.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- # This type of authorization can be used for many scenarios, including
- # calling Cloud Run, or endpoints where you intend to validate the token
- # yourself.
- "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI
- # specified in target will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating OIDC token.
- # The service account must be within the same project as the queue. The
- # caller must have iam.serviceAccounts.actAs permission for the service
- # account.
- },
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- "body": "A String", # HTTP request body.
- #
- # A request body is allowed only if the
- # HTTP method is POST, PUT, or PATCH. It is an
- # error to set body on a task with an incompatible HttpMethod.
- },
- "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.
- "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
- # respond by this deadline then the request is cancelled and the attempt
- # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
- # task according to the RetryConfig.
- #
- # Note that when the request is cancelled, Cloud Tasks will stop listing for
- # the response, but whether the worker stops processing depends on the
- # worker. For example, if the worker is stuck, it may not react to cancelled
- # requests.
- #
- # The default and maximum values depend on the type of request:
- #
- # * For HTTP tasks, the default is 10 minutes. The deadline
- # must be in the interval [15 seconds, 30 minutes].
- #
- # * For App Engine tasks, 0 indicates that the
- # request has the default deadline. The default deadline depends on the
- # [scaling
- # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
- # of the service: 10 minutes for standard apps with automatic scaling, 24
- # hours for standard apps with manual and basic scaling, and 60 minutes for
- # flex apps. If the request deadline is set, it must be in the interval [15
- # seconds, 24 hours 15 seconds]. Regardless of the task's
- # `dispatch_deadline`, the app handler will not run for longer than than
- # the service's timeout. We recommend setting the `dispatch_deadline` to
- # at most a few seconds more than the app handler's timeout. For more
- # information see
- # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
- #
- # `dispatch_deadline` will be truncated to the nearest millisecond. The
- # deadline is an approximate deadline.
- "firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
- #
- # Only dispatch_time will be set.
- # The other Attempt information is not retained by Cloud Tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
- #
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- },
- "dispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
- "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
- #
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
+ # The relative URI must begin with "/" and must be a valid HTTP relative URI.
+ # It can contain a path and query string arguments.
+ # If the relative URI is empty, then the root path "/" will be used.
+ # No spaces are allowed, and the maximum length allowed is 2083 characters.
},
},
],
- "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>
@@ -2176,6 +2176,254 @@
{ # A unit of scheduled work.
"responseCount": 42, # Output only. The number of attempts which have received a response.
+ "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
+ #
+ # `dispatch_time` will be truncated to the nearest microsecond.
+ "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "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.
+ },
+ ],
+ },
+ },
+ "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.
+ "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
+ #
+ # For App Engine queues, this is when the task will be attempted or retried.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "httpRequest": { # HTTP request. # HTTP request that is sent to the task's target.
+ #
+ # An HTTP task is a task that has HttpRequest set.
+ #
+ # The task will be pushed to the worker as an HTTP request. If the worker
+ # or the redirected worker acknowledges the task by returning a successful HTTP
+ # response code ([`200` - `299`]), the task will be removed from the queue. If
+ # any other HTTP response code is returned or no response is received, the
+ # task will be retried according to the following:
+ #
+ # * User-specified throttling: retry configuration,
+ # rate limits, and the queue's state.
+ #
+ # * System throttling: To prevent the worker from overloading, Cloud Tasks may
+ # temporarily reduce the queue's effective rate. User-specified settings
+ # will not be changed.
+ #
+ # System throttling happens because:
+ #
+ # * Cloud Tasks backs off on all errors. Normally the backoff specified in
+ # rate limits will be used. But if the worker returns
+ # `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
+ # errors is high, Cloud Tasks will use a higher backoff rate. The retry
+ # specified in the `Retry-After` HTTP response header is considered.
+ #
+ # * To prevent traffic spikes and to smooth sudden increases in traffic,
+ # dispatches ramp up slowly when the queue is newly created or idle and
+ # if large numbers of tasks suddenly become available to dispatch (due to
+ # spikes in create task rates, the queue being unpaused, or many tasks
+ # that are scheduled at the same time).
+ "oidcToken": { # Contains information needed for generating an # If specified, an
+ # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
+ # token will be generated and attached as an `Authorization` header in the
+ # HTTP request.
+ #
+ # This type of authorization can be used for many scenarios, including
+ # calling Cloud Run, or endpoints where you intend to validate the token
+ # yourself.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ # This type of authorization can be used for many scenarios, including
+ # calling Cloud Run, or endpoints where you intend to validate the token
+ # yourself.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating OIDC token.
+ # The service account must be within the same project as the queue. The
+ # caller must have iam.serviceAccounts.actAs permission for the service
+ # account.
+ "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI
+ # specified in target will be used.
+ },
+ "oauthToken": { # Contains information needed for generating an # If specified, an
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
+ # will be generated and attached as an `Authorization` header in the HTTP
+ # request.
+ #
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
+ # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+ # This type of authorization should generally only be used when calling Google
+ # APIs hosted on *.googleapis.com.
+ "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating OAuth token.
+ # The service account must be within the same project as the queue. The
+ # caller must have iam.serviceAccounts.actAs permission for the service
+ # account.
+ "scope": "A String", # OAuth scope to be used for generating OAuth access token.
+ # If not specified, "https://www.googleapis.com/auth/cloud-platform"
+ # will be used.
+ },
+ "url": "A String", # Required. The full url path that the request will be sent to.
+ #
+ # This string must begin with either "http://" or "https://". Some examples
+ # are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
+ # encode some characters for safety and compatibility. The maximum allowed
+ # URL length is 2083 characters after encoding.
+ #
+ # The `Location` header response from a redirect response [`300` - `399`]
+ # may be followed. The redirect is not counted as a separate attempt.
+ "headers": { # HTTP request headers.
+ #
+ # This map contains the header field names and values.
+ # Headers can be set when the
+ # task is created.
+ #
+ # These headers represent a subset of the headers that will accompany the
+ # task's HTTP request. Some HTTP request headers will be ignored or replaced.
+ #
+ # A partial list of headers that will be ignored or replaced is:
+ #
+ # * Host: This will be computed by Cloud Tasks and derived from
+ # HttpRequest.url.
+ # * Content-Length: This will be computed by Cloud Tasks.
+ # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
+ # * X-Google-*: Google use only.
+ # * X-AppEngine-*: Google use only.
+ #
+ # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
+ # `Content-Type` to a media type when the
+ # task is created.
+ # For example, `Content-Type` can be set to `"application/octet-stream"` or
+ # `"application/json"`.
+ #
+ # Headers which can have multiple values (according to RFC2616) can be
+ # specified using comma-separated values.
+ #
+ # The size of the headers must be less than 80KB.
+ "a_key": "A String",
+ },
+ "body": "A String", # HTTP request body.
+ #
+ # A request body is allowed only if the
+ # HTTP method is POST, PUT, or PATCH. It is an
+ # error to set body on a task with an incompatible HttpMethod.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ },
+ "firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
+ #
+ # Only dispatch_time will be set.
+ # The other Attempt information is not retained by Cloud Tasks.
+ "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
+ #
+ # `schedule_time` will be truncated to the nearest microsecond.
+ "responseTime": "A String", # Output only. The time that this attempt response was received.
+ #
+ # `response_time` will be truncated to the nearest microsecond.
+ "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 worker for this attempt.
+ #
+ # If `response_time` is unset, then the task has not been attempted or is
+ # currently running and the `response_status` field is meaningless.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "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.
+ },
+ ],
+ },
+ },
+ "dispatchCount": 42, # Output only. The number of attempts dispatched.
+ #
+ # This count includes attempts which have been dispatched but haven't
+ # received a response.
+ "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
+ # respond by this deadline then the request is cancelled and the attempt
+ # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
+ # task according to the RetryConfig.
+ #
+ # Note that when the request is cancelled, Cloud Tasks will stop listening
+ # for the response, but whether the worker stops processing depends on the
+ # worker. For example, if the worker is stuck, it may not react to cancelled
+ # requests.
+ #
+ # The default and maximum values depend on the type of request:
+ #
+ # * For HTTP tasks, the default is 10 minutes. The deadline
+ # must be in the interval [15 seconds, 30 minutes].
+ #
+ # * For App Engine tasks, 0 indicates that the
+ # request has the default deadline. The default deadline depends on the
+ # [scaling
+ # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
+ # of the service: 10 minutes for standard apps with automatic scaling, 24
+ # hours for standard apps with manual and basic scaling, and 60 minutes for
+ # flex apps. If the request deadline is set, it must be in the interval [15
+ # seconds, 24 hours 15 seconds]. Regardless of the task's
+ # `dispatch_deadline`, the app handler will not run for longer than than
+ # the service's timeout. We recommend setting the `dispatch_deadline` to
+ # at most a few seconds more than the app handler's timeout. For more
+ # information see
+ # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
+ #
+ # `dispatch_deadline` will be truncated to the nearest millisecond. The
+ # deadline is an approximate deadline.
+ "view": "A String", # Output only. The view specifies which subset of the Task has
+ # been returned.
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
# An App Engine task is a task that has AppEngineHttpRequest set.
@@ -2239,6 +2487,10 @@
# 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.
+ "body": "A String", # HTTP request body.
+ #
+ # A request body is allowed only if the HTTP method is POST or PUT. It is
+ # an error to set a body on a task with an incompatible HttpMethod.
"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
@@ -2247,16 +2499,82 @@
# 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).
- "body": "A String", # HTTP request body.
+ "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
#
- # A request body is allowed only if the HTTP method is POST or PUT. It is
- # an error to set a body on a task with an incompatible HttpMethod.
- "relativeUri": "A String", # The relative URI.
+ # If set,
+ # app_engine_routing_override
+ # is used for all tasks in the queue, no matter what the setting is for the
+ # task-level app_engine_routing.
#
- # The relative URI must begin with "/" and must be a valid HTTP relative URI.
- # It can contain a path and query string arguments.
- # If the relative URI is empty, then the root path "/" will be used.
- # No spaces are allowed, and the maximum length allowed is 2083 characters.
+ # Defines routing characteristics specific to App Engine - service, version,
+ # and instance.
+ #
+ # For more information about services, versions, and instances see
+ # [An Overview of App
+ # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
+ # [Microservices Architecture on Google App
+ # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
+ # [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).
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available 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).
+ "service": "A String", # App service.
+ #
+ # By default, the task is sent to the service which is the default
+ # service 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.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ },
"headers": { # HTTP request headers.
#
# This map contains the header field names and values.
@@ -2301,330 +2619,12 @@
# information, see the CreateTask documentation.
"a_key": "A String",
},
- "appEngineRouting": { # App Engine Routing. # Task-level setting for App Engine routing.
+ "relativeUri": "A String", # The relative URI.
#
- # If set,
- # app_engine_routing_override
- # is used for all tasks in the queue, no matter what the setting is for the
- # task-level app_engine_routing.
- #
- # Defines routing characteristics specific to App Engine - service, version,
- # and instance.
- #
- # For more information about services, versions, and instances see
- # [An Overview of App
- # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
- # [Microservices Architecture on Google App
- # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
- # [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).
- "service": "A String", # App service.
- #
- # By default, the task is sent to the service which is the default
- # service 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.
- "instance": "A String", # App instance.
- #
- # By default, the task is sent to an instance which is available 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).
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- },
- },
- "view": "A String", # Output only. The view specifies which subset of the Task has
- # been returned.
- "createTime": "A String", # Output only. The time that the task was created.
- #
- # `create_time` will be truncated to the nearest second.
- "scheduleTime": "A String", # The time when the task is scheduled to be attempted.
- #
- # For App Engine queues, this is when the task will be attempted or retried.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "httpRequest": { # HTTP request. # HTTP request that is sent to the task's target.
- #
- # An HTTP task is a task that has HttpRequest set.
- #
- # The task will be pushed to the worker as an HTTP request. If the worker
- # or the redirected worker acknowledges the task by returning a successful HTTP
- # response code ([`200` - `299`]), the task will be removed from the queue. If
- # any other HTTP response code is returned or no response is received, the
- # task will be retried according to the following:
- #
- # * User-specified throttling: retry configuration,
- # rate limits, and the queue's state.
- #
- # * System throttling: To prevent the worker from overloading, Cloud Tasks may
- # temporarily reduce the queue's effective rate. User-specified settings
- # will not be changed.
- #
- # System throttling happens because:
- #
- # * Cloud Tasks backs off on all errors. Normally the backoff specified in
- # rate limits will be used. But if the worker returns
- # `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
- # errors is high, Cloud Tasks will use a higher backoff rate. The retry
- # specified in the `Retry-After` HTTP response header is considered.
- #
- # * To prevent traffic spikes and to smooth sudden increases in traffic,
- # dispatches ramp up slowly when the queue is newly created or idle and
- # if large numbers of tasks suddenly become available to dispatch (due to
- # spikes in create task rates, the queue being unpaused, or many tasks
- # that are scheduled at the same time).
- "oauthToken": { # Contains information needed for generating an # If specified, an
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- # will be generated and attached as an `Authorization` header in the HTTP
- # request.
- #
- # This type of authorization should generally only be used when calling
- # Google APIs hosted on *.googleapis.com.
- # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should generally only be used when calling Google
- # APIs hosted on *.googleapis.com.
- "scope": "A String", # OAuth scope to be used for generating OAuth access token.
- # If not specified, "https://www.googleapis.com/auth/cloud-platform"
- # will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating OAuth token.
- # The service account must be within the same project as the queue. The
- # caller must have iam.serviceAccounts.actAs permission for the service
- # account.
- },
- "headers": { # HTTP request headers.
- #
- # This map contains the header field names and values.
- # Headers can be set when the
- # task is created.
- #
- # These headers represent a subset of the headers that will accompany the
- # task's HTTP request. Some HTTP request headers will be ignored or replaced.
- #
- # A partial list of headers that will be ignored or replaced is:
- #
- # * Host: This will be computed by Cloud Tasks and derived from
- # HttpRequest.url.
- # * Content-Length: This will be computed by Cloud Tasks.
- # * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
- # * X-Google-*: Google use only.
- # * X-AppEngine-*: Google use only.
- #
- # `Content-Type` won't be set by Cloud Tasks. You can explicitly set
- # `Content-Type` to a media type when the
- # task is created.
- # For example, `Content-Type` can be set to `"application/octet-stream"` or
- # `"application/json"`.
- #
- # Headers which can have multiple values (according to RFC2616) can be
- # specified using comma-separated values.
- #
- # The size of the headers must be less than 80KB.
- "a_key": "A String",
- },
- "url": "A String", # Required. The full url path that the request will be sent to.
- #
- # This string must begin with either "http://" or "https://". Some examples
- # are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
- # encode some characters for safety and compatibility. The maximum allowed
- # URL length is 2083 characters after encoding.
- #
- # The `Location` header response from a redirect response [`300` - `399`]
- # may be followed. The redirect is not counted as a separate attempt.
- "oidcToken": { # Contains information needed for generating an # If specified, an
- # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
- # token will be generated and attached as an `Authorization` header in the
- # HTTP request.
- #
- # This type of authorization can be used for many scenarios, including
- # calling Cloud Run, or endpoints where you intend to validate the token
- # yourself.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- # This type of authorization can be used for many scenarios, including
- # calling Cloud Run, or endpoints where you intend to validate the token
- # yourself.
- "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI
- # specified in target will be used.
- "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating OIDC token.
- # The service account must be within the same project as the queue. The
- # caller must have iam.serviceAccounts.actAs permission for the service
- # account.
- },
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- "body": "A String", # HTTP request body.
- #
- # A request body is allowed only if the
- # HTTP method is POST, PUT, or PATCH. It is an
- # error to set body on a task with an incompatible HttpMethod.
- },
- "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.
- "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not
- # respond by this deadline then the request is cancelled and the attempt
- # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
- # task according to the RetryConfig.
- #
- # Note that when the request is cancelled, Cloud Tasks will stop listing for
- # the response, but whether the worker stops processing depends on the
- # worker. For example, if the worker is stuck, it may not react to cancelled
- # requests.
- #
- # The default and maximum values depend on the type of request:
- #
- # * For HTTP tasks, the default is 10 minutes. The deadline
- # must be in the interval [15 seconds, 30 minutes].
- #
- # * For App Engine tasks, 0 indicates that the
- # request has the default deadline. The default deadline depends on the
- # [scaling
- # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
- # of the service: 10 minutes for standard apps with automatic scaling, 24
- # hours for standard apps with manual and basic scaling, and 60 minutes for
- # flex apps. If the request deadline is set, it must be in the interval [15
- # seconds, 24 hours 15 seconds]. Regardless of the task's
- # `dispatch_deadline`, the app handler will not run for longer than than
- # the service's timeout. We recommend setting the `dispatch_deadline` to
- # at most a few seconds more than the app handler's timeout. For more
- # information see
- # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
- #
- # `dispatch_deadline` will be truncated to the nearest millisecond. The
- # deadline is an approximate deadline.
- "firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt.
- #
- # Only dispatch_time will be set.
- # The other Attempt information is not retained by Cloud Tasks.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
- #
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- },
- "dispatchCount": 42, # Output only. The number of attempts dispatched.
- #
- # This count includes attempts which have been dispatched but haven't
- # received a response.
- "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
- "scheduleTime": "A String", # Output only. The time that this attempt was scheduled.
- #
- # `schedule_time` will be truncated to the nearest microsecond.
- "dispatchTime": "A String", # Output only. The time that this attempt was dispatched.
- #
- # `dispatch_time` will be truncated to the nearest microsecond.
- "responseTime": "A String", # Output only. The time that this attempt response was received.
- #
- # `response_time` will be truncated to the nearest microsecond.
- "responseStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the worker for this attempt.
- #
- # If `response_time` is unset, then the task has not been attempted or is
- # currently running and the `response_status` field is meaningless.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
+ # The relative URI must begin with "/" and must be a valid HTTP relative URI.
+ # It can contain a path and query string arguments.
+ # If the relative URI is empty, then the root path "/" will be used.
+ # No spaces are allowed, and the maximum length allowed is 2083 characters.
},
}</pre>
</div>