## Index

- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks` (interface)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpQueue` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Attempt` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BatchCreateTasksMetadata` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BatchCreateTasksMetadata.State` (enum)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BatchCreateTasksRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BatchCreateTasksResponse` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BatchDeleteTasksMetadata` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BatchDeleteTasksMetadata.State` (enum)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BatchDeleteTasksRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BufferTaskRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BufferTaskResponse` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CmekConfig` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CreateQueueRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CreateTaskRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.DeleteQueueRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.DeleteTaskRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.GetCmekConfigRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.GetQueueRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.GetTaskRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpMethod` (enum)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpTarget` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpTarget.Header` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpTarget.HeaderOverride` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListQueuesRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListQueuesResponse` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListTasksRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListTasksResponse` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.OAuthToken` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.OidcToken` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.PathOverride` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.PauseQueueRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.PullMessage` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.PurgeQueueRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.QueryOverride` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.State` (enum)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.Type` (enum)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.QueueStats` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RateLimits` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ResumeQueueRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RunTaskRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.StackdriverLoggingConfig` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View` (enum)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.UpdateCmekConfigRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.UpdateQueueRequest` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.UriOverride` (message)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.UriOverride.Scheme` (enum)
- `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.UriOverride.UriOverrideEnforceMode` (enum)

## CloudTasks

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

| BatchCreateTasks |
|---|
| `` rpc BatchCreateTasks(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BatchCreateTasksRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates a batch of tasks and adds them to a queue. This call is not atomic. All tasks must be for the same queue. A maximum of 100 tasks can be created in a single batch. 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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| BatchDeleteTasks |
|---|
| `` rpc BatchDeleteTasks(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BatchDeleteTasksRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes a batch of tasks. This is a non-atomic operation: if deletion fails for some tasks, it can still succeed for others. The metadata field of google.longrunning.Operation contains details of failed deletions. A maximum of 1000 tasks can be deleted in a batch. 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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| BufferTask |
|---|
| `` rpc BufferTask(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BufferTaskRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BufferTaskResponse`) `` Creates and buffers a new task without the need to explicitly define a Task message. The queue must have `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpTarget`. 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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| CreateQueue |
|---|
| `` rpc CreateQueue(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CreateQueueRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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](https://cloud.google.com/tasks/docs/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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| CreateTask |
|---|
| `` rpc CreateTask(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CreateTaskRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task`) `` Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. - The maximum task size is 100KB. 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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| DeleteQueue |
|---|
| `` rpc DeleteQueue(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.DeleteQueueRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#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](https://cloud.google.com/tasks/docs/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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| DeleteTask |
|---|
| `` rpc DeleteTask(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.DeleteTaskRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#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. 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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetCmekConfig |
|---|
| `` rpc GetCmekConfig(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.GetCmekConfigRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetIamPolicy |
|---|
| `` rpc GetIamPolicy(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.iam.v1#google.iam.v1.GetIamPolicyRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.iam.v1#google.iam.v1.Policy`) `` Gets the access control policy for a `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue`. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following [Google IAM](https://cloud.google.com/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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetQueue |
|---|
| `` rpc GetQueue(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.GetQueueRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetTask |
|---|
| `` rpc GetTask(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.GetTaskRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task`) `` Gets a task. After a task is successfully executed or has exhausted its retry attempts, the task is deleted. A `GetTask` request for a deleted task returns a `NOT_FOUND` error. 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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ListQueues |
|---|
| `` rpc ListQueues(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListQueuesRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ListTasks |
|---|
| `` rpc ListTasks(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListTasksRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListTasksResponse`) `` Lists the tasks in a queue. By default, only the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View.ENUM_VALUES.google.cloud.tasks.v2beta3.Task.View.BASIC` view is retrieved due to performance considerations; `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListTasksRequest.FIELDS.google.cloud.tasks.v2beta3.Task.View.google.cloud.tasks.v2beta3.ListTasksRequest.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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| PauseQueue |
|---|
| `` rpc PauseQueue(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.PauseQueueRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue`) `` Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue`. Tasks can still be added when the queue is paused. A queue is paused if its `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.Queue.State.google.cloud.tasks.v2beta3.Queue.state` is `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.State.ENUM_VALUES.google.cloud.tasks.v2beta3.Queue.State.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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| PurgeQueue |
|---|
| `` rpc PurgeQueue(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.PurgeQueueRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ResumeQueue |
|---|
| `` rpc ResumeQueue(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ResumeQueueRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue`) `` Resume a queue. This method resumes a queue after it has been `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.State.ENUM_VALUES.google.cloud.tasks.v2beta3.Queue.State.PAUSED` or `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.State.ENUM_VALUES.google.cloud.tasks.v2beta3.Queue.State.DISABLED`. The state of a queue is stored in the queue's `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.Queue.State.google.cloud.tasks.v2beta3.Queue.state`; after calling this method it will be set to `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.State.ENUM_VALUES.google.cloud.tasks.v2beta3.Queue.State.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](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling). 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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| RunTask |
|---|
| `` rpc RunTask(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RunTaskRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RateLimits` or is `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.State.ENUM_VALUES.google.cloud.tasks.v2beta3.Queue.State.PAUSED`. This command is meant to be used for manual debugging. For example, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.FIELDS.google.cloud.tasks.v2beta3.Attempt.google.cloud.tasks.v2beta3.Task.first_attempt` 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.FIELDS.google.protobuf.Timestamp.google.cloud.tasks.v2beta3.Task.schedule_time` will be reset to the time that `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.RunTask` was called plus the retry delay specified in the queue's `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig`. `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.RunTask` returns `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.rpc#google.rpc.Code.ENUM_VALUES.google.rpc.Code.NOT_FOUND` when it is called on a task that has already succeeded 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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| SetIamPolicy |
|---|
| `` rpc SetIamPolicy(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.iam.v1#google.iam.v1.SetIamPolicyRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.iam.v1#google.iam.v1.Policy`) `` Sets the access control policy for a `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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](https://cloud.google.com/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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| TestIamPermissions |
|---|
| `` rpc TestIamPermissions(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.iam.v1#google.iam.v1.TestIamPermissionsRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.iam.v1#google.iam.v1.TestIamPermissionsResponse`) `` Returns permissions that a caller has on a `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue`. If the resource does not exist, this will return an empty set of permissions, not a `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.rpc#google.rpc.Code.ENUM_VALUES.google.rpc.Code.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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| UpdateCmekConfig |
|---|
| `` rpc UpdateCmekConfig(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.UpdateCmekConfigRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CmekConfig`) `` Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated 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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| UpdateQueue |
|---|
| `` rpc UpdateQueue(`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.UpdateQueueRequest`) returns (`https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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](https://cloud.google.com/tasks/docs/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](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## AppEngineHttpQueue

App Engine HTTP queue.

The task will be delivered to the App Engine application hostname specified by its `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpQueue` and `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest`. The documentation for `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest` explains how the task's host URL is constructed.

Using `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpQueue` requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope:

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

| Fields ||
|---|---|
| `app_engine_routing_override` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting` Overrides for the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest.FIELDS.google.cloud.tasks.v2beta3.AppEngineRouting.google.cloud.tasks.v2beta3.AppEngineHttpRequest.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest.FIELDS.google.cloud.tasks.v2beta3.AppEngineRouting.google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing`. |

## AppEngineHttpRequest

App Engine HTTP request.

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

Using `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest` requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) 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](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting` used to construct the URL that the task is delivered to can be set at the queue-level or task-level:

- If set, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpQueue.FIELDS.google.cloud.tasks.v2beta3.AppEngineRouting.google.cloud.tasks.v2beta3.AppEngineHttpQueue.app_engine_routing_override` is used for all tasks in the queue, no matter what the setting is for the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest.FIELDS.google.cloud.tasks.v2beta3.AppEngineRouting.google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing`.

The `url` that the task will be sent to is:

- `url =` `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.host` `+` `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineHttpRequest.relative_uri`

Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login:
admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login:
required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.FIELDS.google.protobuf.Duration.google.cloud.tasks.v2beta3.Task.dispatch_deadline`. Failed tasks will be retried according to the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.RetryConfig.google.cloud.tasks.v2beta3.Queue.retry_config`. `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` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the App Engine documentation for your runtime on [How Requests are Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled). |
| `app_engine_routing` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting` Task-level setting for App Engine routing. If set, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpQueue.FIELDS.google.cloud.tasks.v2beta3.AppEngineRouting.google.cloud.tasks.v2beta3.AppEngineHttpQueue.app_engine_routing_override` is used for all tasks in the queue, no matter what the setting is for the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest.FIELDS.google.cloud.tasks.v2beta3.AppEngineRouting.google.cloud.tasks.v2beta3.AppEngineHttpRequest.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. |
| `headers` | `map<string, string>` HTTP request headers. This map contains the header field names and values. Headers can be set when the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.CreateTask`. 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest.FIELDS.bytes.google.cloud.tasks.v2beta3.AppEngineHttpRequest.body`, Cloud Tasks sets the following headers: - `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explicitly setting `Content-Type` to a particular media type when the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.CreateTask`. 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](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task`. For more information, see the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.CreateTask` documentation. |
| `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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpMethod`. |

## 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](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

| 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, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.host` is not parsable into `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.service`, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.version`, and `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.host` is not parsable, then `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.service`, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.version`, and `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.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, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.host` is not parsable into `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.service`, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.version`, and `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.host` is not parsable, then `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.service`, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.version`, and `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.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](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). |
| `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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.service`, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.version`, and `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineRouting.FIELDS.string.google.cloud.tasks.v2beta3.AppEngineRouting.instance`. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). |

## Attempt

The status of a task attempt.

| Fields ||
|---|---|
| `schedule_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond. |
| `dispatch_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond. |
| `response_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond. |
| `response_status` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.rpc#google.rpc.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. |

## BatchCreateTasksMetadata

Metadata message for \[BatchCreateTasks\].

| Fields ||
|---|---|
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` The time when the batch create started. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` The time when the batch create finished. |
| `state` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BatchCreateTasksMetadata.State` Output only. The state of the batch create operation. |
| `failed_requests` | ``map<int32, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.rpc#google.rpc.Status`>`` A map of failed requests, where the key is the index of the request in BatchCreateTasksRequest.requests and the value is the error status. |

## State

The state of the batch create operation.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The default value. This value is used if the state is omitted. |
| `RUNNING` | The batch create is running. |
| `SUCCEEDED` | The batch create has finished. All tasks in the request were successfully created. |
| `PARTIALLY_SUCCEEDED` | The batch create has finished with partial success. The tasks that failed to be created are reported in `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BatchCreateTasksMetadata.FIELDS.repeated.google.cloud.tasks.v2beta3.BatchCreateTasksMetadata.FailedRequestsEntry.google.cloud.tasks.v2beta3.BatchCreateTasksMetadata.failed_requests`. |
| `FAILED` | The batch create has failed. This means the overall batch create operation failed to complete. This can happen due to an internal error preventing the operation from finishing. |
| `CANCELLED` | The batch create was cancelled. |

## BatchCreateTasksRequest

Request message for \[BatchCreateTasks\].

| 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](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `cloudtasks.tasks.create` |
| `requests[]` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CreateTaskRequest` Required. The list of requests to create tasks. The queue specified in parent field of each CreateTaskRequest will be the same. This validation happens on the client side as well as in the handler. BatchCreateTasksRequest.parent will also be the same value as the individual CreateTaskRequest.parent . The maximum number of requests is 100. |
| `request_id` | `string` Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side. |

## BatchCreateTasksResponse

Response message for \[BatchCreateTasks\].

| Fields ||
|---|---|
| `tasks[]` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task` The tasks that were successfully created. |

## BatchDeleteTasksMetadata

Metadata for the long-running operation returned by `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.BatchDeleteTasks`. This message is used to hold metadata information about the batch delete tasks operation; that is, it is put in `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.longrunning#google.longrunning.Operation.FIELDS.google.protobuf.Any.google.longrunning.Operation.metadata`.

| Fields ||
|---|---|
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the batch delete started. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the batch delete finished. |
| `state` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BatchDeleteTasksMetadata.State` Output only. The state of the batch delete operation. |
| `failed_requests` | ``map<int32, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.rpc#google.rpc.Status`>`` Output only. A map of failed requests, where the key is the index of the request in BatchDeleteTasksRequest.names and the value is the error status. |

## State

The state of the batch delete operation. This enum is not frozen and new values may be added in the future.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The default value. This value is used if the state is omitted. |
| `RUNNING` | The batch delete is running. |
| `SUCCEEDED` | The batch delete has finished and all tasks were successfully deleted. |
| `PARTIALLY_SUCCEEDED` | The batch delete has finished with partial success. The tasks that failed to be deleted are reported in `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.BatchDeleteTasksMetadata.FIELDS.repeated.google.cloud.tasks.v2beta3.BatchDeleteTasksMetadata.FailedRequestsEntry.google.cloud.tasks.v2beta3.BatchDeleteTasksMetadata.failed_requests`. When all requests in the batch fail, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.longrunning#google.longrunning.Operation.FIELDS.google.rpc.Status.google.longrunning.Operation.error` will be set with `code` = `google.rpc.Code.ABORTED` and `message` = "None of the requests succeeded, refer to BatchDeleteTasksMetadata.failed_requests for individual error details". |
| `FAILED` | The batch delete has failed. This means the overall batch delete operation failed to complete. This can happen due to an internal error preventing the operation from finishing. |

## BatchDeleteTasksRequest

Request message for deleting a batch of tasks using `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.BatchDeleteTasks`.

| Fields ||
|---|---|
| `parent` | `string` Required. The queue name. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `cloudtasks.tasks.batchDelete` |
| `names[]` | `string` Required. The names of the tasks to delete. A maximum of 1000 tasks can be deleted in a batch. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` |
| `request_id` | `string` Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side. |

## BufferTaskRequest

Request message for `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.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](https://cloud.google.com/iam/docs/) 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` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.api#google.api.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.BufferTask`.

| Fields ||
|---|---|
| `task` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task` The created task. |

## 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations.ListLocations`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `cloudtasks.queues.create` |
| `queue` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue` Required. The queue to create. `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.string.google.cloud.tasks.v2beta3.Queue.name` cannot be the same as an existing queue. |

## CreateTaskRequest

Request message for `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.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](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `cloudtasks.tasks.create` |
| `task` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.FIELDS.string.google.cloud.tasks.v2beta3.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.FIELDS.string.google.cloud.tasks.v2beta3.Task.name`. If `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.FIELDS.google.protobuf.Timestamp.google.cloud.tasks.v2beta3.Task.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.rpc#google.rpc.Code.ENUM_VALUES.google.rpc.Code.ALREADY_EXISTS`. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.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` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View` The response_view specifies which subset of the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task` will be returned. By default response_view is `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View.ENUM_VALUES.google.cloud.tasks.v2beta3.Task.View.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View.ENUM_VALUES.google.cloud.tasks.v2beta3.Task.View.FULL` requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task` resource. |

## DeleteQueueRequest

Request message for `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.DeleteQueue`.

| Fields ||
|---|---|
| `name` | `string` Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `cloudtasks.queues.delete` |

## DeleteTaskRequest

Request message for deleting a task using `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.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](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `cloudtasks.tasks.delete` |

## GetCmekConfigRequest

Request message for `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.GetCmekConfig`.

| Fields ||
|---|---|
| `name` | `string` Required. The config resource name. For example: projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig\` Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `cloudtasks.cmekConfig.get` |

## GetQueueRequest

Request message for `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.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](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `cloudtasks.queues.get` |
| `read_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.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](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `cloudtasks.tasks.get` |
| `response_view` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View` The response_view specifies which subset of the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task` will be returned. By default response_view is `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View.ENUM_VALUES.google.cloud.tasks.v2beta3.Task.View.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View.ENUM_VALUES.google.cloud.tasks.v2beta3.Task.View.FULL` requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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. 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: `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.RetryConfig.google.cloud.tasks.v2beta3.Queue.retry_config`, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.RateLimits.google.cloud.tasks.v2beta3.Queue.rate_limits`, and the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.Queue.State.google.cloud.tasks.v2beta3.Queue.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.RateLimits.google.cloud.tasks.v2beta3.Queue.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).

| 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` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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 the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.CreateTask`. 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 Cloud Tasks. - Host: This will be computed by Cloud Tasks and derived from `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpRequest.FIELDS.string.google.cloud.tasks.v2beta3.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.CreateTask`. 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpRequest.FIELDS.google.cloud.tasks.v2beta3.HttpMethod.google.cloud.tasks.v2beta3.HttpRequest.http_method` is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpMethod`. |
| Union field `authorization_header`. The mode for generating an `Authorization` header for HTTP requests. If specified at the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue` level, all `Authorization` headers in the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpRequest.FIELDS.repeated.google.cloud.tasks.v2beta3.HttpRequest.HeadersEntry.google.cloud.tasks.v2beta3.HttpRequest.headers` field are overridden. `authorization_header` can be only one of the following: ||
| `oauth_token` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.OAuthToken` If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on \*.googleapis.com. |
| `oidc_token` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.OidcToken` If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. |

## HttpTarget

HTTP target.

When specified at the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue` level, all tasks with `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpRequest` are overridden according to the target.

| Fields ||
|---|---|
| `uri_override` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.UriOverride` URI override. When specified, overrides the execution URI for all the tasks in the queue. |
| `http_method` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpMethod` The HTTP method to use for the request. When specified, it overrides `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpRequest.FIELDS.google.cloud.tasks.v2beta3.HttpMethod.google.cloud.tasks.v2beta3.HttpRequest.http_method` for the task. Note that if the value is set to `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpMethod.ENUM_VALUES.google.cloud.tasks.v2beta3.HttpMethod.GET` the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpRequest.FIELDS.bytes.google.cloud.tasks.v2beta3.HttpRequest.body` of the task will be ignored at execution time. |
| `header_overrides[]` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpTarget.HeaderOverride` HTTP target headers. This map contains the header field names and values. Headers will be set when running the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.CreateTask` and/or `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.BufferTask`. These headers represent a subset of the headers that will be configured for 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: \* Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. \* Host: This will be computed by Cloud Tasks and derived from \[HttpRequest.url\]\[google.cloud.tasks.v2beta3.Target.HttpRequest.url\]. \* Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.CreateTask`. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to `"application/json"`. - User-Agent: This will be set to `"Google-Cloud-Tasks"`. 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](https://cloud.google.com/terms/service-terms). |
| Union field `authorization_header`. The mode for generating an `Authorization` header for HTTP requests. If specified, all `Authorization` headers in the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpRequest.FIELDS.repeated.google.cloud.tasks.v2beta3.HttpRequest.HeadersEntry.google.cloud.tasks.v2beta3.HttpRequest.headers` field are overridden. `authorization_header` can be only one of the following: ||
| `oauth_token` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.OAuthToken` If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) 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` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.OidcToken` If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) 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` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpTarget.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](https://cloud.google.com/terms/service-terms). |

## ListQueuesRequest

Request message for `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.ListQueues`.

| Fields ||
|---|---|
| `parent` | `string` Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID` Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `cloudtasks.queues.list` |
| `filter` | `string` `filter` can be used to specify a subset of queues. Any `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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](https://cloud.google.com/logging/docs/view/advanced_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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListQueuesResponse.FIELDS.string.google.cloud.tasks.v2beta3.ListQueuesResponse.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListQueuesResponse.FIELDS.string.google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token` returned from the previous call to `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.ListQueues` method. It is an error to switch the value of the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListQueuesRequest.FIELDS.string.google.cloud.tasks.v2beta3.ListQueuesRequest.filter` while iterating through pages. |
| `read_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.ListQueues`.

| Fields ||
|---|---|
| `queues[]` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.ListQueues` with this value as the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListQueuesRequest.FIELDS.string.google.cloud.tasks.v2beta3.ListQueuesRequest.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.ListTasks`.

| Fields ||
|---|---|
| `parent` | `string` Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `cloudtasks.tasks.list` |
| `response_view` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View` The response_view specifies which subset of the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task` will be returned. By default response_view is `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View.ENUM_VALUES.google.cloud.tasks.v2beta3.Task.View.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View.ENUM_VALUES.google.cloud.tasks.v2beta3.Task.View.FULL` requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task` resource. |
| `page_size` | `int32` Maximum page size. Fewer tasks than requested might be returned, even if more tasks exist; use `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListTasksResponse.FIELDS.string.google.cloud.tasks.v2beta3.ListTasksResponse.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListTasksResponse.FIELDS.string.google.cloud.tasks.v2beta3.ListTasksResponse.next_page_token` returned from the previous call to `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.ListTasks` method. The page token is valid for only 2 hours. |

## ListTasksResponse

Response message for listing tasks using `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.ListTasks`.

| Fields ||
|---|---|
| `tasks[]` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.ListTasks` with this value as the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.ListTasksRequest.FIELDS.string.google.cloud.tasks.v2beta3.ListTasksRequest.page_token`. If the next_page_token is empty, there are no more results. |

## OAuthToken

Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on \*.googleapis.com.

| Fields ||
|---|---|
| `service_account_email` | `string` [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. |
| `scope` | `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](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

| Fields ||
|---|---|
| `service_account_email` | `string` [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. |
| `audience` | `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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.PauseQueue`.

| Fields ||
|---|---|
| `name` | `string` Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `cloudtasks.queues.pause` |

## PullMessage

Pull Message.

This proto can only be used for tasks in a queue which has `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.Queue.Type.google.cloud.tasks.v2beta3.Queue.type` type. It currently exists for backwards compatibility with the App Engine Task Queue SDK. This message type maybe returned with methods `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.ListTasks` and `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.ListTasks`, when the response view is `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View.ENUM_VALUES.google.cloud.tasks.v2beta3.Task.View.FULL`.

| Fields ||
|---|---|
| `payload` | `bytes` A data payload consumed by the worker to execute the task. |
| `tag` | `string` The tasks's tag. The tag is less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), 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. |

## PurgeQueueRequest

Request message for `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.PurgeQueue`.

| Fields ||
|---|---|
| `name` | `string` Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) 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, queue types, and others.

| Fields ||
|---|---|
| `name` | `string` Caller-specified and required in `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.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](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations.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. |
| `http_target` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpTarget` Modifies HTTP target for HTTP tasks. |
| `rate_limits` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RateLimits` Rate limits for task dispatches. `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.RateLimits.google.cloud.tasks.v2beta3.Queue.rate_limits` and `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.RetryConfig.google.cloud.tasks.v2beta3.Queue.retry_config` are related because they both control task attempts. However they control task attempts in different ways: - `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.RateLimits.google.cloud.tasks.v2beta3.Queue.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). - `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.RetryConfig.google.cloud.tasks.v2beta3.Queue.retry_config` controls what happens to a particular task after its first attempt fails. That is, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.RetryConfig.google.cloud.tasks.v2beta3.Queue.retry_config` controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: - Number of tasks in the queue - User-specified throttling: `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.RateLimits.google.cloud.tasks.v2beta3.Queue.rate_limits`, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.RetryConfig.google.cloud.tasks.v2beta3.Queue.retry_config`, and the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.Queue.State.google.cloud.tasks.v2beta3.Queue.state`. - System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. |
| `retry_config` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. - 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](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). |
| `state` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.State` Output only. The state of the queue. `state` can only be changed by called `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.PauseQueue`, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue`, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue` cannot be used to change `state`. |
| `purge_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The last time this queue was purged. All tasks that were `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.FIELDS.google.protobuf.Timestamp.google.cloud.tasks.v2beta3.Task.create_time` before this time were purged. A queue can be purged using `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.PurgeQueue`, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. |
| `task_ttl` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` The maximum amount of time that a task will be retained in this queue. After a task has lived for `task_ttl`, the task will be deleted regardless of whether it was dispatched or not. The minimum value is 10 days. The maximum value is 10 years. 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](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). Queues created by Cloud Tasks have a default `task_ttl` of 31 days. . Queues created by queue.yaml/xml have a fixed `task_ttl` of the maximum duration, because there is a [storage quota](https://docs.cloud.google.com/appengine/docs/standard/quotas#Task_Queue) for these queues. |
| `tombstone_ttl` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` The task tombstone time to live (TTL). After a task is deleted or executed, 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CreateTaskRequest.FIELDS.google.cloud.tasks.v2beta3.Task.google.cloud.tasks.v2beta3.CreateTaskRequest.task`. The minimum value is 1 hour. The maximum value is 9 days. 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](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour. |
| `stackdriver_logging_config` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.StackdriverLoggingConfig` Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. |
| `type` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.Type` Immutable. The type of a queue (push or pull). `Queue.type` is an immutable property of the queue that is set at the queue creation time. When left unspecified, the default value of `PUSH` is selected. |
| `stats` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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 `queue_type`. `queue_type` can be only one of the following: ||
| `app_engine_http_queue` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpQueue` `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpQueue` settings apply only to `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest` in this queue. `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpRequest` are not affected by this proto. |

## 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.rpc#google.rpc.Code.ENUM_VALUES.google.rpc.Code.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](https://cloud.google.com/appengine/docs/python/config/queueref) or [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.DeleteQueue`. |

## Type

The type of the queue.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Default value. |
| `PULL` | A pull queue. |
| `PUSH` | A push queue. |

## 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` | `https://protobuf.dev/reference/protobuf/google.protobuf#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, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.RunTask`, will run a task even if the queue has reached its `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RateLimits`.

| Fields ||
|---|---|
| `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. For `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpQueue`, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). |
| `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](https://wikipedia.org/wiki/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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RateLimits.FIELDS.double.google.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_second`. The default value of `max_burst_size` is picked by Cloud Tasks based on the value of `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RateLimits.FIELDS.double.google.cloud.tasks.v2beta3.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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). If `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue` is called on a queue without explicitly setting a value for `max_burst_size`, `max_burst_size` value will get updated if `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue` is updating `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RateLimits.FIELDS.double.google.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_second`. |
| `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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). |

## ResumeQueueRequest

Request message for `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue`.

| Fields ||
|---|---|
| `name` | `string` Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `cloudtasks.queues.resume` |

## RetryConfig

Retry config.

These settings determine when a failed task attempt is retried.

| Fields ||
|---|---|
| `max_attempts` | `int32` Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. 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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). |
| `max_retry_duration` | `https://protobuf.dev/reference/protobuf/google.protobuf#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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig.FIELDS.int32.google.cloud.tasks.v2beta3.RetryConfig.max_attempts` times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. 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](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). |
| `min_backoff` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` A task will be `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.FIELDS.google.protobuf.Timestamp.google.cloud.tasks.v2beta3.Task.schedule_time` for retry between `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig.FIELDS.google.protobuf.Duration.google.cloud.tasks.v2beta3.RetryConfig.min_backoff` and `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig.FIELDS.google.protobuf.Duration.google.cloud.tasks.v2beta3.RetryConfig.max_backoff` duration after it fails, if the queue's `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig` specifies that the task should be retried. 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](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). |
| `max_backoff` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` A task will be `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.FIELDS.google.protobuf.Timestamp.google.cloud.tasks.v2beta3.Task.schedule_time` for retry between `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig.FIELDS.google.protobuf.Duration.google.cloud.tasks.v2beta3.RetryConfig.min_backoff` and `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig.FIELDS.google.protobuf.Duration.google.cloud.tasks.v2beta3.RetryConfig.max_backoff` duration after it fails, if the queue's `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig` specifies that the task should be retried. 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](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). |
| `max_doublings` | `int32` The time between retries will double `max_doublings` times. A task's retry interval starts at `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig.FIELDS.google.protobuf.Duration.google.cloud.tasks.v2beta3.RetryConfig.min_backoff`, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig.FIELDS.google.protobuf.Duration.google.cloud.tasks.v2beta3.RetryConfig.max_backoff` up to `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig.FIELDS.int32.google.cloud.tasks.v2beta3.RetryConfig.max_attempts` times. For example, if `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig.FIELDS.google.protobuf.Duration.google.cloud.tasks.v2beta3.RetryConfig.min_backoff` is 10s, `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig.FIELDS.google.protobuf.Duration.google.cloud.tasks.v2beta3.RetryConfig.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig.FIELDS.google.protobuf.Duration.google.cloud.tasks.v2beta3.RetryConfig.max_backoff` until the task has been attempted `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig.FIELDS.int32.google.cloud.tasks.v2beta3.RetryConfig.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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). |

## RunTaskRequest

Request message for forcing a task to run now using `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.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](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `cloudtasks.tasks.run` |
| `response_view` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View` The response_view specifies which subset of the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task` will be returned. By default response_view is `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View.ENUM_VALUES.google.cloud.tasks.v2beta3.Task.View.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View.ENUM_VALUES.google.cloud.tasks.v2beta3.Task.View.FULL` requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task` resource. |

## StackdriverLoggingConfig

Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/).

| Fields ||
|---|---|
| `sampling_ratio` | `double` Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). 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. |

## Task

A unit of scheduled work.

| Fields ||
|---|---|
| `name` | `string` Optionally caller-specified in `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.CreateTask`. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` - `PROJECT_ID` can contain letters (\[A-Za-z\]), numbers (\[0-9\]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations.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` | `https://protobuf.dev/reference/protobuf/google.protobuf#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. `schedule_time` will be truncated to the nearest microsecond. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time that the task was created. `create_time` will be truncated to the nearest second. |
| `dispatch_deadline` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpRequest`, the default is 10 minutes. The deadline must be in the interval \[15 seconds, 30 minutes\]. - For `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest`, 0 indicates that the request has the default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval \[15 seconds, 24 hours 15 seconds\]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). 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](https://protobuf.dev/reference/protobuf/google.protobuf/#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` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Attempt` Output only. The status of the task's first attempt. Only `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Attempt.FIELDS.google.protobuf.Timestamp.google.cloud.tasks.v2beta3.Attempt.dispatch_time` will be set. The other `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Attempt` information is not retained by Cloud Tasks. |
| `last_attempt` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Attempt` Output only. The status of the task's last attempt. |
| `view` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View` Output only. The view specifies which subset of the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task` has been returned. |
| `retry_config` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.RetryConfig` Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. |
| Union field `payload_type`. Required. The message to send to the worker. `payload_type` can be only one of the following: ||
| `app_engine_http_request` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest` HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest` set. |
| `http_request` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpRequest` HTTP request that is sent to the task's target. An HTTP task is a task that has `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.HttpRequest` set. |
| `pull_message` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.PullMessage` Pull Message contained in a task in a `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.google.cloud.tasks.v2beta3.Queue.Type.google.cloud.tasks.v2beta3.Queue.type` queue type. This payload type cannot be explicitly set through Cloud Tasks API. Its purpose, currently is to provide backward compatibility with App Engine Task Queue [pull](https://cloud.google.com/appengine/docs/standard/java/taskqueue/pull/) queues to provide a way to inspect contents of pull tasks through the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.GetTask`. |

## View

The view specifies a subset of `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.AppEngineHttpRequest.FIELDS.bytes.google.cloud.tasks.v2beta3.AppEngineHttpRequest.body`. 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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Task.View.ENUM_VALUES.google.cloud.tasks.v2beta3.Task.View.FULL` requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue` resource. |

## UpdateCmekConfigRequest

Request message for `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.UpdateCmekConfig`.

| Fields ||
|---|---|
| `cmek_config` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CmekConfig` Required. The config to update. Its name attribute distinguishes it. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `cmekConfig`: - `cloudtasks.cmekConfig.update` |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` List of fields to be updated in this request. |

## UpdateQueueRequest

Request message for `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue`.

| Fields ||
|---|---|
| `queue` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue` Required. The queue to create or update. The queue's `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.string.google.cloud.tasks.v2beta3.Queue.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 `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.Queue.FIELDS.string.google.cloud.tasks.v2beta3.Queue.name` cannot be changed. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `queue`: - `cloudtasks.queues.update` |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated. |

## 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` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.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` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.UriOverride.UriOverrideEnforceMode` URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS. |
| `scheme` | `https://docs.cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2beta3#google.cloud.tasks.v2beta3.UriOverride.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 "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". 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.example.com" will change to "http://www.example.com". |
| `HTTPS` | Convert the scheme to HTTPS, e.g., "http://www.example.com" will change to "https://www.example.com". |

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