docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
index c41a79f..bcc4c84 100644
--- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
+++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
@@ -110,6 +110,18 @@
The object takes the form of:
{ # Request message for CreateTask.
+ "responseView": "A String", # The response_view specifies which subset of the Task will be
+ # returned.
+ #
+ # By default response_view is BASIC; not all
+ # information is retrieved by default because some data, such as
+ # payloads, might be desirable to return only when needed because
+ # of its large size or because of the sensitivity of data that it
+ # contains.
+ #
+ # Authorization for FULL requires
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
+ # permission on the Task resource.
"task": { # A unit of scheduled work. # Required. The task to add.
#
# Task names have the following format:
@@ -143,108 +155,6 @@
# task commands. The infrastructure relies on an approximately
# uniform distribution of task ids to store and serve tasks
# efficiently.
- "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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- },
- "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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- },
"responseCount": 42, # Output only. The number of attempts which have received a response.
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
@@ -309,6 +219,24 @@
# the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
# Requests) response from an app handler does not cause traffic congestion
# control to throttle the queue.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ #
+ # The app's request handler for the task's target URL must be able to handle
+ # HTTP requests with this http_method, otherwise the task attempt fails with
+ # error code 405 (Method Not Allowed). See [Writing a push task request
+ # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+ # and the App Engine documentation for your runtime on [How Requests are
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
+ "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.
+ "relativeUri": "A String", # The relative URI.
+ #
+ # 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.
"headers": { # HTTP request headers.
#
# This map contains the header field names and values.
@@ -372,33 +300,6 @@
# 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).
"service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
@@ -428,25 +329,34 @@
# 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).
},
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- #
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt fails with
- # error code 405 (Method Not Allowed). See [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the App Engine documentation for your runtime on [How Requests are
- # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
- "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.
- "relativeUri": "A String", # The relative URI.
- #
- # 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.
},
"view": "A String", # Output only. The view specifies which subset of the Task has
# been returned.
@@ -488,42 +398,6 @@
# 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).
- "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.
"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
@@ -573,6 +447,42 @@
# 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.
#
@@ -594,19 +504,109 @@
# 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.
+ },
+ },
},
- "responseView": "A String", # The response_view specifies which subset of the Task will be
- # returned.
- #
- # By default response_view is BASIC; not all
- # information is retrieved by default because some data, such as
- # payloads, might be desirable to return only when needed because
- # of its large size or because of the sensitivity of data that it
- # contains.
- #
- # Authorization for FULL requires
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- # permission on the Task resource.
}
x__xgafv: string, V1 error format.
@@ -618,108 +618,6 @@
An object of the form:
{ # A unit of scheduled work.
- "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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- },
- "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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- },
"responseCount": 42, # Output only. The number of attempts which have received a response.
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
@@ -784,6 +682,24 @@
# the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
# Requests) response from an app handler does not cause traffic congestion
# control to throttle the queue.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ #
+ # The app's request handler for the task's target URL must be able to handle
+ # HTTP requests with this http_method, otherwise the task attempt fails with
+ # error code 405 (Method Not Allowed). See [Writing a push task request
+ # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+ # and the App Engine documentation for your runtime on [How Requests are
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
+ "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.
+ "relativeUri": "A String", # The relative URI.
+ #
+ # 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.
"headers": { # HTTP request headers.
#
# This map contains the header field names and values.
@@ -847,33 +763,6 @@
# 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).
"service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
@@ -903,25 +792,34 @@
# 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).
},
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- #
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt fails with
- # error code 405 (Method Not Allowed). See [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the App Engine documentation for your runtime on [How Requests are
- # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
- "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.
- "relativeUri": "A String", # The relative URI.
- #
- # 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.
},
"view": "A String", # Output only. The view specifies which subset of the Task has
# been returned.
@@ -963,42 +861,6 @@
# 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).
- "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.
"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
@@ -1048,6 +910,42 @@
# 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.
#
@@ -1069,6 +967,108 @@
# 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.
+ },
+ },
}</pre>
</div>
@@ -1131,108 +1131,6 @@
An object of the form:
{ # A unit of scheduled work.
- "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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- },
- "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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- },
"responseCount": 42, # Output only. The number of attempts which have received a response.
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
@@ -1297,6 +1195,24 @@
# the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
# Requests) response from an app handler does not cause traffic congestion
# control to throttle the queue.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ #
+ # The app's request handler for the task's target URL must be able to handle
+ # HTTP requests with this http_method, otherwise the task attempt fails with
+ # error code 405 (Method Not Allowed). See [Writing a push task request
+ # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+ # and the App Engine documentation for your runtime on [How Requests are
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
+ "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.
+ "relativeUri": "A String", # The relative URI.
+ #
+ # 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.
"headers": { # HTTP request headers.
#
# This map contains the header field names and values.
@@ -1360,33 +1276,6 @@
# 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).
"service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
@@ -1416,25 +1305,34 @@
# 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).
},
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- #
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt fails with
- # error code 405 (Method Not Allowed). See [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the App Engine documentation for your runtime on [How Requests are
- # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
- "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.
- "relativeUri": "A String", # The relative URI.
- #
- # 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.
},
"view": "A String", # Output only. The view specifies which subset of the Task has
# been returned.
@@ -1476,42 +1374,6 @@
# 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).
- "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.
"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
@@ -1561,6 +1423,42 @@
# 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.
#
@@ -1582,6 +1480,108 @@
# 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.
+ },
+ },
}</pre>
</div>
@@ -1640,108 +1640,6 @@
{ # Response message for listing tasks using ListTasks.
"tasks": [ # The list of tasks.
{ # A unit of scheduled work.
- "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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- },
- "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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- },
"responseCount": 42, # Output only. The number of attempts which have received a response.
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
@@ -1806,6 +1704,24 @@
# the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
# Requests) response from an app handler does not cause traffic congestion
# control to throttle the queue.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ #
+ # The app's request handler for the task's target URL must be able to handle
+ # HTTP requests with this http_method, otherwise the task attempt fails with
+ # error code 405 (Method Not Allowed). See [Writing a push task request
+ # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+ # and the App Engine documentation for your runtime on [How Requests are
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
+ "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.
+ "relativeUri": "A String", # The relative URI.
+ #
+ # 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.
"headers": { # HTTP request headers.
#
# This map contains the header field names and values.
@@ -1869,33 +1785,6 @@
# 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).
"service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
@@ -1925,25 +1814,34 @@
# 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).
},
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- #
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt fails with
- # error code 405 (Method Not Allowed). See [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the App Engine documentation for your runtime on [How Requests are
- # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
- "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.
- "relativeUri": "A String", # The relative URI.
- #
- # 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.
},
"view": "A String", # Output only. The view specifies which subset of the Task has
# been returned.
@@ -1985,42 +1883,6 @@
# 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).
- "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.
"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
@@ -2070,6 +1932,42 @@
# 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.
#
@@ -2091,6 +1989,108 @@
# 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.
+ },
+ },
},
],
"nextPageToken": "A String", # A token to retrieve next page of results.
@@ -2175,108 +2175,6 @@
An object of the form:
{ # A unit of scheduled work.
- "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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- },
- "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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- },
"responseCount": 42, # Output only. The number of attempts which have received a response.
"appEngineHttpRequest": { # App Engine HTTP request. # HTTP request that is sent to the App Engine app handler.
#
@@ -2341,6 +2239,24 @@
# the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
# Requests) response from an app handler does not cause traffic congestion
# control to throttle the queue.
+ "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+ #
+ # The app's request handler for the task's target URL must be able to handle
+ # HTTP requests with this http_method, otherwise the task attempt fails with
+ # error code 405 (Method Not Allowed). See [Writing a push task request
+ # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+ # and the App Engine documentation for your runtime on [How Requests are
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
+ "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.
+ "relativeUri": "A String", # The relative URI.
+ #
+ # 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.
"headers": { # HTTP request headers.
#
# This map contains the header field names and values.
@@ -2404,33 +2320,6 @@
# 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).
"service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
@@ -2460,25 +2349,34 @@
# 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).
},
- "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
- #
- # The app's request handler for the task's target URL must be able to handle
- # HTTP requests with this http_method, otherwise the task attempt fails with
- # error code 405 (Method Not Allowed). See [Writing a push task request
- # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- # and the App Engine documentation for your runtime on [How Requests are
- # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
- "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.
- "relativeUri": "A String", # The relative URI.
- #
- # 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.
},
"view": "A String", # Output only. The view specifies which subset of the Task has
# been returned.
@@ -2520,42 +2418,6 @@
# 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).
- "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.
"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
@@ -2605,6 +2467,42 @@
# 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.
#
@@ -2626,6 +2524,108 @@
# 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.
+ },
+ },
}</pre>
</div>