v2

google.cloud.tasks. v2

Source:

Members

(static, constant) HttpMethod :number

The HTTP method used to deliver the task.

Properties:
Name Type Description
HTTP_METHOD_UNSPECIFIED number

HTTP method unspecified
POST number

HTTP POST
GET number

HTTP GET
HEAD number

HTTP HEAD
PUT number

HTTP PUT
DELETE number

HTTP DELETE
PATCH number

HTTP PATCH
OPTIONS number

HTTP OPTIONS
Source:

(static) State :number

State of the queue.

Properties:
Name Type Description
STATE_UNSPECIFIED number

Unspecified state.
RUNNING number

The queue is running. Tasks can be dispatched.

If the queue was created using Cloud Tasks and the queue has had no activity (method calls or task dispatches) for 30 days, the queue may take a few minutes to re-activate. Some method calls may return NOT_FOUND and tasks may not be dispatched for a few minutes until the queue has been re-activated.
PAUSED number

Tasks are paused by the user. If the queue is paused then Cloud Tasks will stop delivering tasks from it, but more tasks can still be added to it by the user.
DISABLED number

The queue is disabled.

A queue becomes DISABLED when queue.yaml or queue.xml is uploaded which does not contain the queue. You cannot directly disable a queue.

When a queue is disabled, tasks can still be added to a queue but the tasks are not dispatched.

To permanently delete this queue and all of its tasks, call DeleteQueue.
Source:

(static) View :number

The view specifies a subset of Task data.

When a task is returned in a response, 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.

Properties:
Name Type Description
VIEW_UNSPECIFIED number

Unspecified. Defaults to BASIC.
BASIC number

The basic view omits fields which can be large or can contain sensitive data.

This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.
FULL number

All information is returned.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Queue resource.
Source:

Type Definitions

AppEngineHttpRequest

App Engine HTTP request.

The message defines the HTTP request that is sent to an App Engine app when the task is dispatched.

Using AppEngineHttpRequest requires appengine.applications.get Google IAM permission for the project and the following scope:

https://www.googleapis.com/auth/cloud-platform

The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see How Requests are Routed and how routing is affected by dispatch files. Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol.

The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level:

  • If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

The url that the task will be sent to is:

  • url = host + relative_uri

Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with login: admin. Because tasks are not run as any user, they cannot be dispatched to URIs restricted with login: required Task dispatches also do not follow redirects.

The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [200 - 299]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. 503 (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a 429 (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue.

Properties:
Name Type Description
httpMethod number

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 will fail with error code 405 (Method Not Allowed). See Writing a push task request handler and the documentation for the request handlers in the language your app is written in e.g. Python Request Handler.

The number should be among the values of HttpMethod
appEngineRouting Object

Task-level setting for App Engine routing.

  • If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

This object should have the same structure as AppEngineRouting
relativeUri 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 Object.<string, string>

HTTP request headers.

This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas.

Cloud Tasks sets some headers to default values:

  • User-Agent: By default, this header is "AppEngine-Google; (+http://code.google.com/appengine)". This header can be modified, but Cloud Tasks will append "AppEngine-Google; (+http://code.google.com/appengine)" to the modified User-Agent.

If the task has a body, Cloud Tasks sets the following headers:

  • Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-Type to a particular media type when the task is created. For example, Content-Type can be set to "application/json".
  • Content-Length: This is computed by Cloud Tasks. This value is output only. It cannot be changed.

The headers below cannot be set or overridden:

  • Host
  • X-Google-*
  • X-AppEngine-*

In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response.

Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation.
body Buffer

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.
Source:
See:

AppEngineRouting

App Engine Routing.

Defines routing characteristics specific to App Engine - service, version, and instance.

For more information about services, versions, and instances see An Overview of App Engine, Microservices Architecture on Google App Engine, App Engine Standard request routing, and App Engine Flex request routing.

Using AppEngineRouting requires appengine.applications.get Google IAM permission for the project and the following scope:

https://www.googleapis.com/auth/cloud-platform

Properties:
Name Type Description
service string

App service.

By default, the task is sent to the service which is the default service when the task is attempted.

For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
version 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.
instance string

App instance.

By default, the task is sent to an instance which is available when the task is attempted.

Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
host 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 .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.
Source:
See:

Attempt

The status of a task attempt.

Properties:
Name Type Description
scheduleTime Object

Output only. The time that this attempt was scheduled.

schedule_time will be truncated to the nearest microsecond.

This object should have the same structure as Timestamp
dispatchTime Object

Output only. The time that this attempt was dispatched.

dispatch_time will be truncated to the nearest microsecond.

This object should have the same structure as Timestamp
responseTime Object

Output only. The time that this attempt response was received.

response_time will be truncated to the nearest microsecond.

This object should have the same structure as Timestamp
responseStatus Object

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.

This object should have the same structure as Status
Source:
See:

CreateQueueRequest

Request message for CreateQueue.

Properties:
Name Type Description
parent string

Required. The location name in which the queue will be created. For example: projects/PROJECT_ID/locations/LOCATION_ID

The list of allowed locations can be obtained by calling Cloud Tasks' implementation of ListLocations.
queue Object

Required. The queue to create.

Queue's name cannot be the same as an existing queue.

This object should have the same structure as Queue
Source:
See:

CreateTaskRequest

Request message for CreateTask.

Properties:
Name Type Description
parent string

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

The queue must already exist.
task Object

Required. The task to add.

Task names have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response.

If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time.

Task De-duplication:

Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9days after the original task was deleted or executed.

Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.

This object should have the same structure as Task
responseView number

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 permission on the Task resource.

The number should be among the values of View
Source:
See:

DeleteQueueRequest

Request message for DeleteQueue.

Properties:
Name Type Description
name string

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
Source:
See:

DeleteTaskRequest

Request message for deleting a task using DeleteTask.

Properties:
Name Type Description
name string

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
Source:
See:

GetQueueRequest

Request message for GetQueue.

Properties:
Name Type Description
name string

Required. The resource name of the queue. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
Source:
See:

GetTaskRequest

Request message for getting a task using GetTask.

Properties:
Name Type Description
name string

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
responseView number

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 permission on the Task resource.

The number should be among the values of View
Source:
See:

HttpRequest

HTTP request.

The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([200 - 299]), the task will removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following:

  • User-specified throttling: retry configuration, rate limits, and the queue's state.

  • System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed.

System throttling happens because:

  • Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns 429 (Too Many Requests), 503 (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the Retry-After HTTP response header is considered.

  • To prevent traffic spikes and to smooth sudden large traffic spikes, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time).

Properties:
Name Type Description
url 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.
httpMethod number

The HTTP method to use for the request. The default is POST.

The number should be among the values of HttpMethod
headers Object.<string, string>

HTTP request headers.

This map contains the header field names and values. Headers can be set when the task is created.

These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced.

A partial list of headers that will be ignored or replaced is:

  • Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
  • Content-Length: This will be computed by Cloud Tasks.
  • User-Agent: This will be set to "Google-Cloud-Tasks".
  • X-Google-*: Google use only.
  • X-AppEngine-*: Google use only.

Content-Type won't be set by Cloud Tasks. You can explicitly set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json".

Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values.

The size of the headers must be less than 80KB.
body Buffer

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 Object

If specified, an OAuth token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

This object should have the same structure as OAuthToken
oidcToken Object

If specified, an OIDC 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.

This object should have the same structure as OidcToken
Source:
See:

ListQueuesRequest

Request message for ListQueues.

Properties:
Name Type Description
parent string

Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID
filter string

filter can be used to specify a subset of queues. Any Queue field can be used as a filter and several operators as supported. For example: <=, <, >=, >, !=, =, :. The filter syntax is the same as described in Stackdriver's Advanced Logs Filters.

Sample filter "state: PAUSED".

Note that using filters might cause fewer queues than the requested page_size to be returned.
pageSize number

Requested page size.

The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist.
pageToken string

A token identifying the page of results to return.

To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.
Source:
See:

ListQueuesResponse

Response message for ListQueues.

Properties:
Name Type Description
queues Array.<Object>

The list of queues.

This object should have the same structure as Queue
nextPageToken string

A token to retrieve next page of results.

To return the next page of results, call ListQueues with this value as the page_token.

If the next_page_token is empty, there are no more results.

The page token is valid for only 2 hours.
Source:
See:

ListTasksRequest

Request message for listing tasks using ListTasks.

Properties:
Name Type Description
parent string

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
responseView number

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 permission on the Task resource.

The number should be among the values of View
pageSize number

Maximum page size.

Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist.

The maximum page size is 1000. If unspecified, the page size will be the maximum.
pageToken string

A token identifying the page of results to return.

To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method.

The page token is valid for only 2 hours.
Source:
See:

ListTasksResponse

Response message for listing tasks using ListTasks.

Properties:
Name Type Description
tasks Array.<Object>

The list of tasks.

This object should have the same structure as Task
nextPageToken string

A token to retrieve next page of results.

To return the next page of results, call ListTasks with this value as the page_token.

If the next_page_token is empty, there are no more results.
Source:
See:

OAuthToken

Contains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

Properties:
Name Type Description
serviceAccountEmail string

Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
scope string

OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
Source:
See:

OidcToken

Contains information needed for generating an OpenID Connect token. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

Properties:
Name Type Description
serviceAccountEmail string

Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
audience string

Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
Source:
See:

PauseQueueRequest

Request message for PauseQueue.

Properties:
Name Type Description
name string

Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
Source:
See:

PurgeQueueRequest

Request message for PurgeQueue.

Properties:
Name Type Description
name string

Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
Source:
See:

Queue

A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, queue types, and others.

Properties:
Name Type Description
name string

Caller-specified and required in CreateQueue, after which it becomes output only.

The queue name.

The queue name must have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

  • PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
  • LOCATION_ID is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.
  • QUEUE_ID can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.
appEngineRoutingOverride Object

Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected.

If set, app_engine_routing_override is used for all App Engine tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

This object should have the same structure as AppEngineRouting
rateLimits Object

Rate limits for task dispatches.

rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:

  • rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry).
  • retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc).

The queue's actual dispatch rate is the result of:

  • Number of tasks in the queue
  • User-specified throttling: rate_limits, retry_config, and the queue's state.
  • System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.

This object should have the same structure as RateLimits
retryConfig Object

Settings that determine the retry behavior.

  • For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks.
  • For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See App Engine documentation.

This object should have the same structure as RetryConfig
state number

Output only. The state of the queue.

state can only be changed by called PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change state.

The number should be among the values of State
purgeTime Object

Output only. The last time this queue was purged.

All tasks that were created before this time were purged.

A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console.

Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged.

This object should have the same structure as Timestamp
Source:
See:

RateLimits

Rate limits.

This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry.

Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits.

Properties:
Name Type Description
maxDispatchesPerSecond number

The maximum rate at which tasks are dispatched from this queue.

If unspecified when the queue is created, Cloud Tasks will pick the default.

  • The maximum allowed value is 500.

This field has the same meaning as rate in queue.yaml/xml.
maxBurstSize number

Output only. The max burst size.

Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.

The token bucket algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by max_burst_size. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second.

Cloud Tasks will pick the value of max_burst_size based on the value of max_dispatches_per_second.

For queues that were created or updated using queue.yaml/xml, max_burst_size is equal to bucket_size. Since max_burst_size is output only, if UpdateQueue is called on a queue created by queue.yaml/xml, max_burst_size will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated.
maxConcurrentDispatches number

The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.

If unspecified when the queue is created, Cloud Tasks will pick the default.

The maximum allowed value is 5,000.

This field has the same meaning as max_concurrent_requests in queue.yaml/xml.
Source:
See:

ResumeQueueRequest

Request message for ResumeQueue.

Properties:
Name Type Description
name string

Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
Source:
See:

RetryConfig

Retry config.

These settings determine when a failed task attempt is retried.

Properties:
Name Type Description
maxAttempts number

Number of attempts per task.

Cloud Tasks will attempt the task max_attempts times (that is, if the first attempt fails, then there will be max_attempts - 1 retries). Must be >= -1.

If unspecified when the queue is created, Cloud Tasks will pick the default.

-1 indicates unlimited attempts.

This field has the same meaning as task_retry_limit in queue.yaml/xml.
maxRetryDuration Object

If positive, max_retry_duration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once max_retry_duration time has passed and the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted.

If zero, then the task age is unlimited.

If unspecified when the queue is created, Cloud Tasks will pick the default.

max_retry_duration will be truncated to the nearest second.

This field has the same meaning as task_age_limit in queue.yaml/xml.

This object should have the same structure as Duration
minBackoff Object

A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.

If unspecified when the queue is created, Cloud Tasks will pick the default.

min_backoff will be truncated to the nearest second.

This field has the same meaning as min_backoff_seconds in queue.yaml/xml.

This object should have the same structure as Duration
maxBackoff Object

A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.

If unspecified when the queue is created, Cloud Tasks will pick the default.

max_backoff will be truncated to the nearest second.

This field has the same meaning as max_backoff_seconds in queue.yaml/xml.

This object should have the same structure as Duration
maxDoublings number

The time between retries will double max_doublings times.

A task's retry interval starts at min_backoff, then doubles max_doublings times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times.

For example, if min_backoff is 10s, max_backoff is 300s, and max_doublings is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field has the same meaning as max_doublings in queue.yaml/xml.
Source:
See:

RunTaskRequest

Request message for forcing a task to run now using RunTask.

Properties:
Name Type Description
name string

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
responseView number

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 permission on the Task resource.

The number should be among the values of View
Source:
See:

Task

A unit of scheduled work.

Properties:
Name Type Description
name string

Optionally caller-specified in CreateTask.

The task name.

The task name must have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

  • PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
  • LOCATION_ID is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.
  • QUEUE_ID can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.
  • TASK_ID can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
appEngineHttpRequest Object

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

This object should have the same structure as AppEngineHttpRequest
httpRequest Object

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

This object should have the same structure as HttpRequest
scheduleTime Object

The time when the task is scheduled to be attempted or retried.

schedule_time will be truncated to the nearest microsecond.

This object should have the same structure as Timestamp
createTime Object

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

This object should have the same structure as Timestamp
dispatchDeadline Object

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 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.

dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

This object should have the same structure as Duration
dispatchCount number

Output only. The number of attempts dispatched.

This count includes attempts which have been dispatched but haven't received a response.
responseCount number

Output only. The number of attempts which have received a response.
firstAttempt Object

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.

This object should have the same structure as Attempt
lastAttempt Object

Output only. The status of the task's last attempt.

This object should have the same structure as Attempt
view number

Output only. The view specifies which subset of the Task has been returned.

The number should be among the values of View
Source:
See:

UpdateQueueRequest

Request message for UpdateQueue.

Properties:
Name Type Description
queue Object

Required. The queue to create or update.

The queue's name must be specified.

Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue's name cannot be changed.

This object should have the same structure as Queue
updateMask Object

A mask used to specify which fields of the queue are being updated.

If empty, then all fields will be updated.

This object should have the same structure as FieldMask
Source:
See: