Package google.cloud.tasks.v2beta2

Index

• CloudTasks (interface)
• AcknowledgeTaskRequest (message)
• AppEngineHttpRequest (message)
• AppEngineHttpTarget (message)
• AppEngineRouting (message)
• AttemptStatus (message)
• BufferTaskRequest (message)
• BufferTaskResponse (message)
• CancelLeaseRequest (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)
• LeaseTasksRequest (message)
• LeaseTasksResponse (message)
• ListQueuesRequest (message)
• ListQueuesResponse (message)
• ListTasksRequest (message)
• ListTasksResponse (message)
• OAuthToken (message)
• OidcToken (message)
• PathOverride (message)
• PauseQueueRequest (message)
• PullMessage (message)
• PullTarget (message)
• PurgeQueueRequest (message)
• QueryOverride (message)
• Queue (message)
• Queue.State (enum)
• QueueStats (message)
• RateLimits (message)
• RenewLeaseRequest (message)
• ResumeQueueRequest (message)
• RetryConfig (message)
• RunTaskRequest (message)
• Task (message)
• Task.View (enum)
• TaskStatus (message)
• UpdateCmekConfigRequest (message)
• UpdateQueueRequest (message)
• UploadQueueYamlRequest (message)
• UriOverride (message)
• UriOverride.Scheme (enum)
• UriOverride.UriOverrideEnforceMode (enum)

CloudTasks

Cloud Tasks allows developers to manage the execution of background work in their applications.

AcknowledgeTask

rpc AcknowledgeTask(AcknowledgeTaskRequest) returns (Empty) Acknowledges a pull task. The worker, that is, the entity that leased this task must call this method to indicate that the work associated with the task has finished. The worker must acknowledge a task within the lease_duration or the lease will expire and the task will become available to be leased again. After the task is acknowledged, it will not be returned by a later LeaseTasks, GetTask, or ListTasks. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

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. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

CancelLease

rpc CancelLease(CancelLeaseRequest) returns (Task) Cancel a pull task's lease. The worker can use this method to cancel a task's lease by setting its schedule_time to now. This will make the task available to be leased to the next caller of LeaseTasks. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

CreateQueue

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. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

CreateTask

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. For App Engine queues, the maximum task size is 100KB. For pull queues, the maximum task size is 1MB. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

DeleteQueue

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. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

DeleteTask

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 completed successfully or permanently failed. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

GetCmekConfig

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. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

GetIamPolicy

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.getIamPolicy Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

GetQueue
rpc GetQueue(GetQueueRequest) returns (Queue) Gets a queue. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

GetTask
rpc GetTask(GetTaskRequest) returns (Task) Gets a task. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

LeaseTasks

rpc LeaseTasks(LeaseTasksRequest) returns (LeaseTasksResponse) Leases tasks from a pull queue for lease_duration. This method is invoked by the worker to obtain a lease. The worker must acknowledge the task via AcknowledgeTask after they have performed the work associated with the task. The payload is intended to store data that the worker needs to perform the work associated with the task. To return the payloads in the response, set response_view to FULL. A maximum of 10 qps of LeaseTasks requests are allowed per queue. RESOURCE_EXHAUSTED is returned when this limit is exceeded. RESOURCE_EXHAUSTED is also returned when max_tasks_dispatched_per_second is exceeded. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

ListQueues
rpc ListQueues(ListQueuesRequest) returns (ListQueuesResponse) Lists queues. Queues are returned in lexicographical order. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

ListTasks

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. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

PauseQueue

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. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

PurgeQueue

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. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

RenewLease

rpc RenewLease(RenewLeaseRequest) returns (Task) Renew the current lease of a pull task. The worker can use this method to extend the lease by a new duration, starting from now. The new task lease will be returned in the task's schedule_time. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

ResumeQueue

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. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

RunTask

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 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. RunTask cannot be called on a pull task. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

SetIamPolicy

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.setIamPolicy Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

TestIamPermissions

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. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

UpdateCmekConfig

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. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

UpdateQueue

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. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

UploadQueueYaml

rpc UploadQueueYaml(UploadQueueYamlRequest) returns (Empty) Update queue list by uploading a queue.yaml file. The queue.yaml file is supplied in the request body as a YAML encoded string. This method was added to support gcloud clients versions before 322.0.0. New clients should use CreateQueue instead of this method. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-tasks For more information, see the Authentication Overview.

AcknowledgeTaskRequest

Request message for acknowledging a task using AcknowledgeTask.

Fields
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.acknowledge
schedule_time	Timestamp Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease.

AppEngineHttpRequest

App Engine HTTP request.

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

This proto can only be used for tasks in a queue which has app_engine_http_target set.

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 set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

The url that the task will be sent to is:

• url = host + relative_url

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][Task.dispatch_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.

Fields
http_method	HttpMethod 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	AppEngineRouting Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
relative_url	string The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
headers	map<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 payload, Cloud Tasks sets the following headers: Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-Type to a particular media type when the task is created. For example, Content-Type can be set to "application/json". Content-Length: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: Host X-Google-* X-AppEngine-* In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. 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.
payload	bytes Payload. The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod.

AppEngineHttpTarget

App Engine HTTP target.

The task will be delivered to the App Engine application hostname specified by its AppEngineHttpTarget and AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains how the task's host URL is constructed.

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

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

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

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.

Fields
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. For more information, see How Requests are Routed. The host is constructed as: host = [application_domain_name] | [service] + '.' + [application_domain_name] | [version] + '.' + [application_domain_name] | [version_dot_service]+ '.' + [application_domain_name] | [instance] + '.' + [application_domain_name] | [instance_dot_service] + '.' + [application_domain_name] | [instance_dot_version] + '.' + [application_domain_name] | [instance_dot_version_dot_service] + '.' + [application_domain_name] application_domain_name = The domain name of the app, for example .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. service = service version = version version_dot_service = version + '.' + service instance = instance instance_dot_service = instance + '.' + service instance_dot_version = instance + '.' + version instance_dot_version_dot_service = instance + '.' + version + '.' + service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted.

AttemptStatus

The status of a task attempt.

Fields
schedule_time	Timestamp Output only. The time that this attempt was scheduled. schedule_time will be truncated to the nearest microsecond.
dispatch_time	Timestamp Output only. The time that this attempt was dispatched. dispatch_time will be truncated to the nearest microsecond.
response_time	Timestamp Output only. The time that this attempt response was received. response_time will be truncated to the nearest microsecond.
response_status	Status Output only. The response from the target for this attempt. If the task has not been attempted or the task is currently running then the response status is unset.

BufferTaskRequest

Request message for BufferTask.

Fields
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.create
task_id	string Optional. Task ID for the task being created. If not provided, a random task ID is assigned to the task.
body	HttpBody Optional. Body of the HTTP request. The body can take any generic value. The value is written to the [HttpRequest][payload] of the [Task].

BufferTaskResponse

Response message for BufferTask.

Fields
task	Task The created task.

CancelLeaseRequest

Request message for canceling a lease using CancelLease.

Fields
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.cancelLease
schedule_time	Timestamp Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease.
response_view	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.

CmekConfig

Describes the customer-managed encryption key (CMEK) configuration associated with a project and location.

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

CreateQueueRequest

Request message for CreateQueue.

Fields
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.create
queue	Queue Required. The queue to create. Queue's name cannot be the same as an existing queue.

CreateTaskRequest

Request message for CreateTask.

Fields
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.create
task	Task 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 completed 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	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.

DeleteQueueRequest

Request message for DeleteQueue.

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

DeleteTaskRequest

Request message for deleting a task using DeleteTask.

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

GetCmekConfigRequest

Request message for GetCmekConfig.

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

GetQueueRequest

Request message for GetQueue.

Fields
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.get
read_mask	FieldMask Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.

GetTaskRequest

Request message for getting a task using GetTask.

Fields
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.get
response_view	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.

HttpMethod

The HTTP method used to execute the task.

Enums
HTTP_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. An HTTP request embodies a url, an http method, headers, body and authorization for the http task.

Fields
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	HttpMethod The HTTP method to use for the request. The default is POST.
headers	map<string, string> HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or 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: Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. 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	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.
Union field authorization_header. The mode for generating an Authorization header for HTTP requests. If specified, all Authorization headers in the HttpRequest.headers field will be overridden. authorization_header can be only one of the following:
oauth_token	OAuthToken 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	OidcToken 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.

HttpTarget

HTTP target.

When specified as a [Queue][target_type], all the tasks with [HttpRequest] will be overridden according to the target.

Fields
uri_override	UriOverride Uri override. When specified, overrides the execution Uri for all the tasks in the queue.
http_method	HttpMethod 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.
header_overrides[]	HeaderOverride HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or 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: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * 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-CloudTasks". * 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. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.
Union field authorization_header. The mode for generating an Authorization header for HTTP requests. If specified, all Authorization headers in the HttpRequest.headers field are overridden. authorization_header can be only one of the following:
oauth_token	OAuthToken If specified, an OAuth token is generated and attached as an 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	OidcToken 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.

Header

Defines a header message. A header can have a key and a value.

Fields
key	string The key of the header.
value	string The value of the header.

HeaderOverride

Wraps the Header object.

Fields
header	Header Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.

LeaseTasksRequest

Request message for leasing tasks using LeaseTasks.

Fields
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.lease
max_tasks	int32 The maximum number of tasks to lease. The system will make a best effort to return as close to as max_tasks as possible. The largest that max_tasks can be is 1000. The maximum total size of a lease tasks response is 32 MB. If the sum of all task sizes requested reaches this limit, fewer tasks than requested are returned.
lease_duration	Duration Required. The duration of the lease. Each task returned in the response will have its schedule_time set to the current time plus the lease_duration. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time. After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later LeaseTasks call so that another worker can retry it. The maximum lease duration is 1 week. lease_duration will be truncated to the nearest second.
response_view	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.
filter	string filter can be used to specify a subset of tasks to lease. When filter is set to tag=<my-tag> then the response will contain only tasks whose tag is equal to <my-tag>. <my-tag> must be less than 500 characters. When filter is set to tag_function=oldest_tag(), only tasks which have the same tag as the task with the oldest schedule_time will be returned. Grammar Syntax: filter = "tag=" tag | "tag_function=" function tag = string function = "oldest_tag()" The oldest_tag() function returns tasks which have the same tag as the oldest task (ordered by schedule time). SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren't UTF-8 encoded can't be used in the filter and the task's tag will be displayed as empty in Cloud Tasks.

LeaseTasksResponse

Response message for leasing tasks using LeaseTasks.

Fields
tasks[]	Task The leased tasks.

ListQueuesRequest

Request message for ListQueues.

Fields
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.list
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 "app_engine_http_target: *". 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.
read_mask	FieldMask Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.

ListQueuesResponse

Response message for ListQueues.

Fields
queues[]	Queue 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.

ListTasksRequest

Request message for listing tasks using ListTasks.

Fields
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.list
response_view	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.

ListTasksResponse

Response message for listing tasks using ListTasks.

Fields
tasks[]	Task 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.

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.

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

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.

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

PathOverride

PathOverride.

Path message defines path override for HTTP targets.

Fields
path	string The URI path (e.g., /users/1234). Default is an empty string.

PauseQueueRequest

Request message for PauseQueue.

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

PullMessage

The pull message contains data that can be used by the caller of LeaseTasks to process the task.

This proto can only be used for tasks in a queue which has pull_target set.

Fields
payload	bytes A data payload consumed by the worker to execute the task.
tag	string The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks.

PullTarget

This type has no fields.

Pull target.

PurgeQueueRequest

Request message for PurgeQueue.

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

QueryOverride

QueryOverride.

Query message defines query override for HTTP targets.

Fields
query_params	string The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.

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, target types, and others.

Fields
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.
rate_limits	RateLimits Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts however they control how tasks are attempted 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).
retry_config	RetryConfig 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.
state	State 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.
purge_time	Timestamp 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.
task_ttl	Duration The maximum amount of time that a task will be retained in this queue. Queues created by Cloud Tasks have a default task_ttl of 31 days. After a task has lived for task_ttl, the task will be deleted regardless of whether it was dispatched or not. The task_ttl for queues created via queue.yaml/xml is equal to the maximum duration because there is a storage quota for these queues. To view the maximum valid duration, see the documentation for Duration.
tombstone_ttl	Duration The task tombstone time to live (TTL). After a task is deleted or completed, the task's tombstone is retained for the length of time specified by tombstone_ttl. The tombstone is used by task de-duplication; another task with the same name can't be created until the tombstone has expired. For more information about task de-duplication, see the documentation for CreateTaskRequest. Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.
stats	QueueStats Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
Union field target_type. Caller-specified and required in CreateQueue[], after which the queue config type becomes output only, though fields within the config are mutable. The queue's target. The target applies to all tasks in the queue. target_type can be only one of the following:
app_engine_http_target	AppEngineHttpTarget App Engine HTTP target. An App Engine queue is a queue that has an AppEngineHttpTarget.
pull_target	PullTarget Pull target. A pull queue is a queue that has a PullTarget.
http_target	HttpTarget An http_target is used to override the target values for HTTP tasks.

State

State of the queue.

Enums
STATE_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. When a pull queue is paused, all LeaseTasks calls will return a FAILED_PRECONDITION.
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 and LeaseTasks calls return a FAILED_PRECONDITION error. To permanently delete this queue and all of its tasks, call DeleteQueue.

QueueStats

Statistics for a queue.

Fields
tasks_count	int64 Output only. An estimation of the number of tasks in the queue, that is, the tasks in the queue that haven't been executed, the tasks in the queue which the queue has dispatched but has not yet received a reply for, and the failed tasks that the queue is retrying.
oldest_estimated_arrival_time	Timestamp Output only. An estimation of the nearest time in the future where a task in the queue is scheduled to be executed.
executed_last_minute_count	int64 Output only. The number of tasks that the queue has dispatched and received a reply for during the last minute. This variable counts both successful and non-successful executions.
concurrent_dispatches_count	int64 Output only. The number of requests that the queue has dispatched but has not received a reply for yet.
effective_execution_rate	double Output only. The current maximum number of tasks per second executed by the queue. The maximum value of this variable is controlled by the RateLimits of the Queue. However, this value could be less to avoid overloading the endpoints tasks in the queue are targeting.

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.

Fields
max_tasks_dispatched_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. For App Engine queues, the maximum allowed value is 500. This field is output only for pull queues. In addition to the max_tasks_dispatched_per_second limit, a maximum of 10 QPS of LeaseTasks requests are allowed per pull queue. This field has the same meaning as rate in queue.yaml/xml.
max_burst_size	int32 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][RateLimits.max_dispatches_per_second]. The default value of max_burst_size is picked by Cloud Tasks based on the value of [max_dispatches_per_second][RateLimits.max_dispatches_per_second]. The maximum value of max_burst_size is 500. For App Engine queues that were created or updated using queue.yaml/xml, max_burst_size is equal to bucket_size. If UpdateQueue is called on a queue without explicitly setting a value for max_burst_size, max_burst_size value will get updated if UpdateQueue is updating [max_dispatches_per_second][RateLimits.max_dispatches_per_second].
max_concurrent_tasks	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 is output only for pull queues and always -1, which indicates no limit. No other queue types can have max_concurrent_tasks set to -1. This field has the same meaning as max_concurrent_requests in queue.yaml/xml.

RenewLeaseRequest

Request message for renewing a lease using RenewLease.

Fields
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.renewLease
schedule_time	Timestamp Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease.
lease_duration	Duration Required. The desired new lease duration, starting from now. The maximum lease duration is 1 week. lease_duration will be truncated to the nearest second.
response_view	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.

ResumeQueueRequest

Request message for ResumeQueue.

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

RetryConfig

Retry config.

These settings determine how a failed task attempt is retried.

Fields
max_retry_duration	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. This field is output only for pull queues. 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	Duration 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. This field is output only for pull queues. 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	Duration 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. This field is output only for pull queues. 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 is output only for pull queues. This field has the same meaning as max_doublings in queue.yaml/xml.
Union field num_attempts. Number of attempts per task. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as task_retry_limit in queue.yaml/xml. num_attempts can be only one of the following:
max_attempts	int32 The maximum number of attempts for a 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 > 0.
unlimited_attempts	bool If true, then the number of attempts is unlimited.

RunTaskRequest

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

Fields
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.run
response_view	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.

Task

A unit of scheduled work.

Fields
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.
schedule_time	Timestamp The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. schedule_time will be truncated to the nearest microsecond.
create_time	Timestamp Output only. The time that the task was created. create_time will be truncated to the nearest second.
status	TaskStatus Output only. The task status.
view	View Output only. The view specifies which subset of the Task has been returned.
Union field payload_type. Required. The task's payload is used by the task's target to process the task. A payload is valid only if it is compatible with the queue's target. payload_type can be only one of the following:
app_engine_http_request	AppEngineHttpRequest App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.
pull_message	PullMessage LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set.
http_request	HttpRequest HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.

View

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.

Enums
VIEW_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 (payload in AppEngineHttpRequest and payload in PullMessage). These payloads 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.

TaskStatus

Status of the task.

Fields
attempt_dispatch_count	int32 Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
attempt_response_count	int32 Output only. The number of attempts which have received a response. This field is not calculated for pull tasks.
first_attempt_status	AttemptStatus Output only. The status of the task's first attempt. Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks.
last_attempt_status	AttemptStatus Output only. The status of the task's last attempt. This field is not calculated for pull tasks.

UpdateCmekConfigRequest

Request message for UpdateCmekConfig.

Fields
cmek_config	CmekConfig Required. The config to update. Its name attribute distinguishes it. Authorization requires the following IAM permission on the specified resource cmekConfig: cloudtasks.cmekConfig.update
update_mask	FieldMask List of fields to be updated in this request.

UpdateQueueRequest

Request message for UpdateQueue.

Fields
queue	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.update
update_mask	FieldMask A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated.

UploadQueueYamlRequest

Request message for UploadQueueYaml.

Fields
app_id	string Required. The App ID is supplied as an HTTP parameter. Unlike internal usage of App ID, it does not include a region prefix. Rather, the App ID represents the Project ID against which to make the request.
http_body	HttpBody The http body contains the queue.yaml file which used to update queue lists

UriOverride

Uri Override.

When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.

Fields
path_override	PathOverride 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	QueryOverride 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	UriOverrideEnforceMode URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
scheme	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.

Scheme

The Scheme for an HTTP request. By default, it is HTTPS.

Enums
SCHEME_UNSPECIFIED	Scheme unspecified. Defaults to HTTPS.
HTTP	Convert the scheme to HTTP, e.g., https://www.google.ca will change to http://www.google.ca.
HTTPS	Convert the scheme to HTTPS, e.g., http://www.google.ca will change to https://www.google.ca.

UriOverrideEnforceMode

UriOverrideEnforceMode mode is to define enforcing mode for the override modes.

Enums
URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED	OverrideMode 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