CloudTasks (interface)AppEngineHttpRequest (message)AppEngineRouting (message)Attempt (message)BufferTaskRequest (message)BufferTaskResponse (message)CmekConfig (message)CreateQueueRequest (message)CreateTaskRequest (message)DeleteQueueRequest (message)DeleteTaskRequest (message)GetCmekConfigRequest (message)GetQueueRequest (message)GetTaskRequest (message)HttpMethod (enum)HttpRequest (message)HttpTarget (message)HttpTarget.Header (message)HttpTarget.HeaderOverride (message)ListQueuesRequest (message)ListQueuesResponse (message)ListTasksRequest (message)ListTasksResponse (message)OAuthToken (message)OidcToken (message)PathOverride (message)PauseQueueRequest (message)PurgeQueueRequest (message)QueryOverride (message)Queue (message)Queue.State (enum)RateLimits (message)ResumeQueueRequest (message)RetryConfig (message)RunTaskRequest (message)StackdriverLoggingConfig (message)Task (message)Task.View (enum)UpdateCmekConfigRequest (message)UpdateQueueRequest (message)UriOverride (message)UriOverride.Scheme (enum)UriOverride.UriOverrideEnforceMode (enum)Cloud Tasks allows developers to manage the execution of background work in their applications.
BufferTask rpc BufferTask(BufferTaskRequest) returns (BufferTaskResponse)
Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. To create the task with a custom ID, use the following format and set TASK_ID to your desired ID: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer To create the task with an automatically generated ID, use the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc CreateQueue(CreateQueueRequest) returns (Queue)
Creates a queue.
Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not.
WARNING: Using this method may have unintended side effects if you are using an App Engine queue.yaml or queue.xml file to manage your queues. Read Overview of Queue Management and queue.yaml before using this method.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc CreateTask(CreateTaskRequest) returns (Task)
Creates a task and adds it to a queue.
Tasks cannot be updated after creation; there is no UpdateTask command.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc DeleteQueue(DeleteQueueRequest) returns (Empty)
Deletes a queue.
This command will delete the queue even if it has tasks in it.
Note: If you delete a queue, you may be prevented from creating a new queue with the same name as the deleted queue for a tombstone window of up to 3 days. During this window, the CreateQueue operation may appear to recreate the queue, but this can be misleading. If you attempt to create a queue with the same name as one that is in the tombstone window, run GetQueue to confirm that the queue creation was successful. If GetQueue returns 200 response code, your queue was successfully created with the name of the previously deleted queue. Otherwise, your queue did not successfully recreate.
WARNING: Using this method may have unintended side effects if you are using an App Engine queue.yaml or queue.xml file to manage your queues. Read Overview of Queue Management and queue.yaml before using this method.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc DeleteTask(DeleteTaskRequest) returns (Empty)
Deletes a task.
A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc GetCmekConfig(GetCmekConfigRequest) returns (CmekConfig)
Gets the CMEK config.
Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc GetIamPolicy(GetIamPolicyRequest) returns (Policy)
Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set.
Authorization requires the following Google IAM permission on the specified resource parent:
cloudtasks.queues.getIamPolicyRequires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc GetQueue(GetQueueRequest) returns (Queue)
Gets a queue.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc GetTask(GetTaskRequest) returns (Task)
Gets a task.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc ListQueues(ListQueuesRequest) returns (ListQueuesResponse)
Lists queues.
Queues are returned in lexicographical order.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)
Lists the tasks in a queue.
By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned.
The tasks may be returned in any order. The ordering may change at any time.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc PauseQueue(PauseQueueRequest) returns (Queue)
Pauses the queue.
If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc PurgeQueue(PurgeQueueRequest) returns (Queue)
Purges a queue by deleting all of its tasks.
All tasks created before this method is called are permanently deleted.
Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc ResumeQueue(ResumeQueueRequest) returns (Queue)
Resume a queue.
This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING.
WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in Managing Cloud Tasks Scaling Risks.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc RunTask(RunTaskRequest) returns (Task)
Forces a task to run now.
When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED.
This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now.
The dispatched task is returned. That is, the task that is returned contains the [status][Task.status] after the task is dispatched but before the task is received by its target.
If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig.
RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc SetIamPolicy(SetIamPolicyRequest) returns (Policy)
Sets the access control policy for a Queue. Replaces any existing policy.
Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console.
Authorization requires the following Google IAM permission on the specified resource parent:
cloudtasks.queues.setIamPolicyRequires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc TestIamPermissions(TestIamPermissionsRequest) returns (TestIamPermissionsResponse)
Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc UpdateCmekConfig(UpdateCmekConfigRequest) returns (CmekConfig)
Creates or Updates a CMEK config.
Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
rpc UpdateQueue(UpdateQueueRequest) returns (Queue)
Updates a queue.
This method creates the queue if it does not exist and updates the queue if it does exist.
Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not.
WARNING: Using this method may have unintended side effects if you are using an App Engine queue.yaml or queue.xml file to manage your queues. Read Overview of Queue Management and queue.yaml before using this method.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-tasksFor more information, see the Authentication Overview.
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:
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_uriTasks 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.
http_method
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 and the App Engine documentation for your runtime on How Requests are Handled.
app_engine_routing
Task-level setting for App Engine routing.
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.relative_uri
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.
body
bytes
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.
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
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.
AttemptThe status of a task attempt.
Fieldsschedule_time
Output only. The time that this attempt was scheduled.
schedule_time will be truncated to the nearest microsecond.
dispatch_time
Output only. The time that this attempt was dispatched.
dispatch_time will be truncated to the nearest microsecond.
response_time
Output only. The time that this attempt response was received.
response_time will be truncated to the nearest microsecond.
response_status
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.
Request message for BufferTask.
queue
string
Required. The parent queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
The queue must already exist.
Authorization requires the following IAM permission on the specified resource queue:
cloudtasks.tasks.createtask_id
string
Optional. Task ID for the task being created. If not provided, Cloud Tasks generates an ID for the task.
body
Optional. Body of the HTTP request.
The body can take any generic value. The value is written to the [HttpRequest][payload] of the [Task].
BufferTaskResponseResponse message for BufferTask.
task
The created task.
CmekConfigDescribes the customer-managed encryption key (CMEK) configuration associated with a project and location.
Fieldsname
string
Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
kms_key
string
Resource name of the Cloud KMS key, of the form projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.
Request message for CreateQueue.
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.
Authorization requires the following IAM permission on the specified resource parent:
cloudtasks.queues.createqueue
Required. The queue to create.
Queue's name cannot be the same as an existing queue.
Request message for CreateTask.
parent
string
Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
The queue must already exist.
Authorization requires the following IAM permission on the specified resource parent:
cloudtasks.tasks.createtask
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. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again.
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.
response_view
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.
Request message for DeleteQueue.
name
string
Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
Authorization requires the following IAM permission on the specified resource name:
cloudtasks.queues.deleteRequest message for deleting a task using DeleteTask.
name
string
Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
Authorization requires the following IAM permission on the specified resource name:
cloudtasks.tasks.deleteRequest message for GetCmekConfig.
name
string
Required. The config. For example: projects/PROJECT_ID/locations/LOCATION_ID/CmekConfig`
Authorization requires the following IAM permission on the specified resource name:
cloudtasks.cmekConfig.getRequest message for GetQueue.
name
string
Required. The resource name of the queue. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
Authorization requires the following IAM permission on the specified resource name:
cloudtasks.queues.getRequest message for getting a task using GetTask.
name
string
Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
Authorization requires the following IAM permission on the specified resource name:
cloudtasks.tasks.getresponse_view
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 HTTP method used to deliver the task.
EnumsHTTP_METHOD_UNSPECIFIED HTTP method unspecified POST HTTP POST GET HTTP GET HEAD HTTP HEAD PUT HTTP PUT DELETE HTTP DELETE PATCH HTTP PATCH OPTIONS HTTP OPTIONS 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 be removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following:
User-specified throttling: retry configuration, rate limits, and the queue's state.
System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed.
System throttling happens because:
Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns 429 (Too Many Requests), 503 (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the Retry-After HTTP response header is considered.
To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time).
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.
http_method
The HTTP method to use for the request. The default is POST.
body
bytes
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.
oauth_token
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.
oidc_token
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.
HttpTargetHTTP target.
When specified as a [Queue][target_type], all the tasks with [HttpRequest] will be overridden according to the target.
Fieldsuri_override
URI override.
When specified, overrides the execution URI for all the tasks in the queue.
http_method
The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task. Note that if the value is set to [HttpMethod][GET] the [HttpRequest][body] of the task will be ignored at execution time.
oauth_token
If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request.
This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override.
oidc_token
If specified, an OIDC token is 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. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override.
ListQueuesRequestRequest message for ListQueues.
parent
string
Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID
Authorization requires the following IAM permission on the specified resource parent:
cloudtasks.queues.listfilter
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.
page_size
int32
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.
page_token
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.
Response message for ListQueues.
queues[]
The list of queues.
next_page_token
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.
ListTasksRequestRequest message for listing tasks using ListTasks.
parent
string
Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
Authorization requires the following IAM permission on the specified resource parent:
cloudtasks.tasks.listresponse_view
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.
page_size
int32
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.
page_token
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.
ListTasksResponseResponse message for listing tasks using ListTasks.
tasks[]
The list of tasks.
next_page_token
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.
OAuthTokenContains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
Fieldsservice_account_email
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.
OidcTokenContains 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.
Fieldsservice_account_email
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.
PathOverridePathOverride.
Path message defines path override for HTTP targets.
Fieldspath
string
The URI path (e.g., /users/1234). Default is an empty string.
PauseQueueRequestRequest message for PauseQueue.
name
string
Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
Authorization requires the following IAM permission on the specified resource name:
cloudtasks.queues.pauseRequest message for PurgeQueue.
name
string
Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
Authorization requires the following IAM permission on the specified resource name:
cloudtasks.queues.purgeQueryOverride.
Query message defines query override for HTTP targets.
Fieldsquery_params
string
The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
QueueA 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.
Fieldsname
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 projectsLOCATION_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.app_engine_routing_override
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.
http_target
Modifies HTTP target for HTTP tasks.
rate_limits
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:
rate_limits, retry_config, and the queue's state.429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.retry_config
Settings that determine the retry behavior.
state
Output only. The state of the queue.
state can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change state.
purge_time
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.
stackdriver_logging_config
Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
StateState of the queue.
EnumsSTATE_UNSPECIFIED Unspecified state. RUNNING
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 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
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.
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.
max_dispatches_per_second
double
The maximum rate at which tasks are dispatched from this queue.
If unspecified when the queue is created, Cloud Tasks will pick the default.
This field has the same meaning as rate in queue.yaml/xml.
max_burst_size
int32
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.
max_concurrent_dispatches
int32
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.
ResumeQueueRequestRequest message for ResumeQueue.
name
string
Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
Authorization requires the following IAM permission on the specified resource name:
cloudtasks.queues.resumeRetry config.
These settings determine when a failed task attempt is retried.
Fieldsmax_attempts
int32
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.
max_retry_duration
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.
The value must be given as a string that indicates the length of time (in seconds) followed by s (for "seconds"). For the maximum possible value or the format, see the documentation for Duration. max_retry_duration will be truncated to the nearest second.
This field has the same meaning as task_age_limit in queue.yaml/xml.
min_backoff
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.
The value must be given as a string that indicates the length of time (in seconds) followed by s (for "seconds"). For more information on the format, see the documentation for Duration. min_backoff will be truncated to the nearest second.
This field has the same meaning as min_backoff_seconds in queue.yaml/xml.
max_backoff
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.
The value must be given as a string that indicates the length of time (in seconds) followed by s (for "seconds"). For more information on the format, see the documentation for Duration. max_backoff will be truncated to the nearest second.
This field has the same meaning as max_backoff_seconds in queue.yaml/xml.
max_doublings
int32
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 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.
RunTaskRequestRequest message for forcing a task to run now using RunTask.
name
string
Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
Authorization requires the following IAM permission on the specified resource name:
cloudtasks.tasks.runresponse_view
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.
Configuration options for writing logs to Stackdriver Logging.
Fieldssampling_ratio
double
Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
TaskA unit of scheduled work.
Fieldsname
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 projectsLOCATION_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.schedule_time
The time when the task is scheduled to be attempted or retried.
schedule_time will be truncated to the nearest microsecond.
create_time
Output only. The time that the task was created.
create_time will be truncated to the nearest second.
dispatch_deadline
The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. Cloud Tasks will retry the task according to the RetryConfig.
Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests.
The default and maximum values depend on the type of request:
For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].
For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type 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.
The value must be given as a string that indicates the length of time (in seconds) followed by s (for "seconds"). For more information on the format, see the documentation for Duration. dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.
dispatch_count
int32
Output only. The number of attempts dispatched.
This count includes attempts which have been dispatched but haven't received a response.
response_count
int32
Output only. The number of attempts which have received a response.
first_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.
last_attempt
Output only. The status of the task's last attempt.
view
Output only. The view specifies which subset of the Task has been returned.
message_type. Required. The message to send to the worker. message_type can be only one of the following: app_engine_http_request
HTTP request that is sent to the App Engine app handler.
An App Engine task is a task that has AppEngineHttpRequest set.
http_request
HTTP request that is sent to the worker.
An HTTP task is a task that has HttpRequest set.
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.
EnumsVIEW_UNSPECIFIED Unspecified. Defaults to BASIC. BASIC
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
All information is returned.
Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Queue resource.
Request message for UpdateCmekConfig.
cmek_config
Required. The config to update. Its name attribute distinguishes it.
Authorization requires the following IAM permission on the specified resource cmekConfig:
cloudtasks.cmekConfig.updateupdate_mask
List of fields to be updated in this request.
UpdateQueueRequestRequest message for UpdateQueue.
queue
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.
Authorization requires the following IAM permission on the specified resource queue:
cloudtasks.queues.updateupdate_mask
A mask used to specify which fields of the queue are being updated.
If empty, then all fields will be updated.
UriOverrideURI Override.
When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.
Fieldspath_override
URI path.
When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
query_override
URI query.
When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
uri_override_enforce_mode
URI Override Enforce Mode
When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
scheme
Scheme override.
When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
host
string
Host override.
When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com," and host value is set to "example.net", the overridden URI will be changed to "https://example.net." Host value cannot be an empty string (INVALID_ARGUMENT).
port
int64
Port override.
When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
SchemeThe Scheme for an HTTP request. By default, it is HTTPS.
UriOverrideEnforceModeUriOverrideEnforceMode defines when the URI override is enforced.
EnumsURI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED UriOverrideEnforceMode Unspecified. Defaults to ALWAYS. IF_NOT_EXISTS In the IF_NOT_EXISTS mode, queue-level configuration is only applied where task-level configuration does not exist. ALWAYS In the ALWAYS mode, queue-level configuration overrides all task-level configuration
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4