package google.cloud.tasks.v2beta3
Get desktop application:
View/edit binary Protocol Buffers messages
service CloudTasks
cloudtasks.proto:38Cloud Tasks allows developers to manage the execution of background work in their applications.
rpc CreateQueue (, )
cloudtasks.proto:66Creates 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.
message
cloudtasks.proto:351Request message for [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.CreateQueue].
string parent = 1
Required. The location name in which the queue will be created. For example: `projects/PROJECT_ID/locations/LOCATION_ID` The list of allowed locations can be obtained by calling Cloud Tasks' implementation of [ListLocations][google.cloud.location.Locations.ListLocations].
optional queue = 2
Required. The queue to create. [Queue's name][google.cloud.tasks.v2beta3.Queue.name] cannot be the same as an existing queue.
rpc CreateTask (, )
cloudtasks.proto:234Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * For [App Engine queues][google.cloud.tasks.v2beta3.AppEngineHttpQueue], the maximum task size is 100KB.
message
cloudtasks.proto:507Request message for [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
string parent = 1
Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist.
optional task = 2
Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task [name][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 [response][google.cloud.tasks.v2beta3.Task.name]. If [schedule_time][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 [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS]. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9days after the original task was deleted or executed. Because there is an extra lookup cost to identify duplicate task names, these [CreateTask][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.
Task.View response_view = 3
The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] will be returned. By default response_view is [BASIC][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 [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the [Task][google.cloud.tasks.v2beta3.Task] resource.
rpc DeleteQueue (, )
cloudtasks.proto:106Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. 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.
message
cloudtasks.proto:390Request message for [DeleteQueue][google.cloud.tasks.v2beta3.CloudTasks.DeleteQueue].
string name = 1
Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
rpc DeleteTask (, )
cloudtasks.proto:246Deletes 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.
message
cloudtasks.proto:570Request message for deleting a task using [DeleteTask][google.cloud.tasks.v2beta3.CloudTasks.DeleteTask].
string name = 1
Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
rpc GetIamPolicy (, )
cloudtasks.proto:167Gets the access control policy for a [Queue][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`
rpc GetQueue (, )
cloudtasks.proto:49Gets a queue.
message
cloudtasks.proto:342Request message for [GetQueue][google.cloud.tasks.v2beta3.CloudTasks.GetQueue].
string name = 1
Required. The resource name of the queue. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
rpc GetTask (, )
cloudtasks.proto:222Gets a task.
message
cloudtasks.proto:484Request message for getting a task using [GetTask][google.cloud.tasks.v2beta3.CloudTasks.GetTask].
string name = 1
Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
Task.View response_view = 2
The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] will be returned. By default response_view is [BASIC][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 [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the [Task][google.cloud.tasks.v2beta3.Task] resource.
rpc ListQueues (, )
cloudtasks.proto:42Lists queues. Queues are returned in lexicographical order.
message
cloudtasks.proto:285Request message for [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues].
string parent = 1
Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`
string filter = 2
`filter` can be used to specify a subset of queues. Any [Queue][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.
int32 page_size = 3
Requested page size. The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the [next_page_token][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] in the response to determine if more queues exist.
string page_token = 4
A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of [next_page_token][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] returned from the previous call to [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues] method. It is an error to switch the value of the [filter][google.cloud.tasks.v2beta3.ListQueuesRequest.filter] while iterating through pages.
message
cloudtasks.proto:325Response message for [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues].
repeated queues = 1
The list of queues.
string next_page_token = 2
A token to retrieve next page of results. To return the next page of results, call [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues] with this value as the [page_token][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.
rpc ListTasks (, )
cloudtasks.proto:215Lists the tasks in a queue. By default, only the [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC] view is retrieved due to performance considerations; [response_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.
message
cloudtasks.proto:426Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks].
string parent = 1
Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
Task.View response_view = 2
The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] will be returned. By default response_view is [BASIC][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 [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the [Task][google.cloud.tasks.v2beta3.Task] resource.
int32 page_size = 3
Requested page size. Fewer tasks than requested might be returned. The maximum page size is 1000. If unspecified, the page size will be the maximum. Fewer tasks than requested might be returned, even if more tasks exist; use [next_page_token][google.cloud.tasks.v2beta3.ListTasksResponse.next_page_token] in the response to determine if more tasks exist.
string page_token = 4
A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of [next_page_token][google.cloud.tasks.v2beta3.ListTasksResponse.next_page_token] returned from the previous call to [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks] method. The page token is valid for only 2 hours.
message
cloudtasks.proto:469Response message for listing tasks using [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks].
repeated tasks = 1
The list of tasks.
string next_page_token = 2
A token to retrieve next page of results. To return the next page of results, call [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks] with this value as the [page_token][google.cloud.tasks.v2beta3.ListTasksRequest.page_token]. If the next_page_token is empty, there are no more results.
rpc PauseQueue (, )
cloudtasks.proto:132Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. Tasks can still be added when the queue is paused. A queue is paused if its [state][google.cloud.tasks.v2beta3.Queue.state] is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].
message
cloudtasks.proto:408Request message for [PauseQueue][google.cloud.tasks.v2beta3.CloudTasks.PauseQueue].
string name = 1
Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
rpc PurgeQueue (, )
cloudtasks.proto:118Purges 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.
message
cloudtasks.proto:399Request message for [PurgeQueue][google.cloud.tasks.v2beta3.CloudTasks.PurgeQueue].
string name = 1
Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
rpc ResumeQueue (, )
cloudtasks.proto:151Resume a queue. This method resumes a queue after it has been [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED] or [DISABLED][google.cloud.tasks.v2beta3.Queue.State.DISABLED]. The state of a queue is stored in the queue's [state][google.cloud.tasks.v2beta3.Queue.state]; after calling this method it will be set to [RUNNING][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).
message
cloudtasks.proto:417Request message for [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue].
string name = 1
Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
rpc RunTask (, )
cloudtasks.proto:276Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2beta3.RateLimits] or is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED]. This command is meant to be used for manual debugging. For example, [RunTask][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 [status][Task.status] after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's [schedule_time][google.cloud.tasks.v2beta3.Task.schedule_time] will be reset to the time that [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] was called plus the retry delay specified in the queue's [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig]. [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] returns [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a task that has already succeeded or permanently failed.
message
cloudtasks.proto:580Request message for forcing a task to run now using [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask].
string name = 1
Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
Task.View response_view = 2
The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] will be returned. By default response_view is [BASIC][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 [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the [Task][google.cloud.tasks.v2beta3.Task] resource.
rpc SetIamPolicy (, )
cloudtasks.proto:185Sets the access control policy for a [Queue][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`
Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta3.Queue]. If the resource does not exist, this will return an empty set of permissions, not a [NOT_FOUND][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.
rpc UpdateQueue (, )
cloudtasks.proto:87Updates 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.
message
cloudtasks.proto:371Request message for [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue].
optional queue = 1
Required. The queue to create or update. The queue's [name][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 [name][google.cloud.tasks.v2beta3.Queue.name] cannot be changed.
optional update_mask = 2
A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated.
message
target.proto:41App Engine HTTP queue. The task will be delivered to the App Engine application hostname specified by its [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] and [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest]. The documentation for [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] explains how the task's host URL is constructed. Using [AppEngineHttpQueue][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`
Used in:
optional app_engine_routing_override = 1
Overrides for the [task-level app_engine_routing][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 [task-level app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing].
message
target.proto:94App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has [app_engine_http_queue][google.cloud.tasks.v2beta3.Queue.app_engine_http_queue] set. Using [AppEngineHttpRequest][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). The [AppEngineRouting][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, [app_engine_routing_override][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 [task-level app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing]. The `url` that the task will be sent to is: * `url =` [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] `+` [relative_uri][google.cloud.tasks.v2beta3.AppEngineHttpRequest.relative_uri] The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. `503` is considered an App Engine system error instead of an application error. Requests returning error `503` will be retried regardless of retry configuration and not counted against retry counts. Any other response code or a failure to receive a response before the deadline is a failed attempt.
Used in:
HttpMethod http_method = 1
The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt will fail with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
optional app_engine_routing = 2
Task-level setting for App Engine routing. If set, [app_engine_routing_override][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 [task-level app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing].
string relative_uri = 3
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.
map<string, string> headers = 4
HTTP request headers. This map contains the header field names and values. Headers can be set when the [task is created][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 [body][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 [task is created][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/appengine/docs/python/taskqueue/push/creating-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 [Task][google.cloud.tasks.v2beta3.Task]. For more information, see the [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask] documentation.
bytes body = 5
HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2beta3.HttpMethod].
message
target.proto:188App Engine Routing. Specifies the target URI. Since this target type dispatches tasks to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref) the protocol (for example, HTTP or HTTPS) cannot be explictly specified. Task dispatches do not follow redirects and cannot target URI paths restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) because tasks are not run as any user. 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).
Used in: ,
string service = 1
App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable into [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and [instance][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 [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable, then [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance] are the empty string.
string version = 2
App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable into [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and [instance][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 [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable, then [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance] are the empty string.
string instance = 3
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).
string host = 4
Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example <app-id>.appspot.com), and the [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and [instance][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).
message
task.proto:133The status of a task attempt.
Used in:
optional schedule_time = 1
Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond.
optional dispatch_time = 2
Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond.
optional response_time = 3
Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond.
optional response_status = 4
Output only. The response from the target 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.
The HTTP method used to execute the task.
Used in:
HTTP_METHOD_UNSPECIFIED = 0
HTTP method unspecified
POST = 1
HTTP POST
GET = 2
HTTP GET
HEAD = 3
HTTP HEAD
PUT = 4
HTTP PUT
DELETE = 5
HTTP DELETE
message
queue.proto:34A 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.
Used as response type in: CloudTasks.CreateQueue, CloudTasks.GetQueue, CloudTasks.PauseQueue, CloudTasks.PurgeQueue, CloudTasks.ResumeQueue, CloudTasks.UpdateQueue
Used as field type in: , ,
string name = 1
Caller-specified and required in [CreateQueue][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 [ListLocations][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.
oneof queue_type
Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.CreateQueue][], after which the queue config type becomes output only, though fields within the config are mutable. The queue's type. The type applies to all tasks in the queue.
app_engine_http_queue = 3
App Engine HTTP queue. An App Engine queue is a queue that has an [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] type.
optional rate_limits = 4
Rate limits for task dispatches. [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits] and [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] are related because they both control task attempts however they control how tasks are attempted in different ways: * [rate_limits][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). * [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] controls what happens to particular a task after its first attempt fails. That is, [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] controls task retries (the second attempt, third attempt, etc).
optional retry_config = 5
Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
Queue.State state = 6
Output only. The state of the queue. `state` can only be changed by called [PauseQueue][google.cloud.tasks.v2beta3.CloudTasks.PauseQueue], [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue], or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue] cannot be used to change `state`.
optional purge_time = 7
Output only. The last time this queue was purged. All tasks that were [created][google.cloud.tasks.v2beta3.Task.create_time] before this time were purged. A queue can be purged using [PurgeQueue][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.
State of the queue.
Used in:
STATE_UNSPECIFIED = 0
Unspecified state.
RUNNING = 1
The queue is running. Tasks can be dispatched. If the queue was created using Cloud Tasks and the queue has had no activity (method calls or task dispatches) for 30 days, the queue may take a few minutes to re-activate. Some method calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and tasks may not be dispatched for a few minutes until the queue has been re-activated.
PAUSED = 2
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 = 3
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 [DeleteQueue][google.cloud.tasks.v2beta3.CloudTasks.DeleteQueue].
message
queue.proto:161Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask], will run a task even if the queue has reached its [RateLimits][google.cloud.tasks.v2beta3.RateLimits].
Used in:
double max_dispatches_per_second = 1
The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For [App Engine queues][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).
int32 max_burst_size = 2
Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](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 [max_dispatches_per_second][google.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_second]. Cloud Tasks will pick the value of `max_burst_size` based on the value of [max_dispatches_per_second][google.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_second]. 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). Since `max_burst_size` is output only, if [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue] is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of [max_dispatches_per_second][google.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_second], regardless of whether [max_dispatches_per_second][google.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_second] is updated.
int32 max_concurrent_dispatches = 3
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).
message
queue.proto:230Retry config. These settings determine when a failed task attempt is retried.
Used in:
int32 max_attempts = 1
Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
optional max_retry_duration = 2
If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted [max_attempts][google.cloud.tasks.v2beta3.RetryConfig.max_attempts] times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
optional min_backoff = 3
A task will be [scheduled][google.cloud.tasks.v2beta3.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
optional max_backoff = 4
A task will be [scheduled][google.cloud.tasks.v2beta3.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
int32 max_doublings = 5
The time between retries will double `max_doublings` times. A task's retry interval starts at [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff], then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] up to [max_attempts][google.cloud.tasks.v2beta3.RetryConfig.max_attempts] times. For example, if [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff] is 10s, [max_backoff][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 [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] until the task has been attempted [max_attempts][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).
message
task.proto:32A unit of scheduled work.
Used as response type in: CloudTasks.CreateTask, CloudTasks.GetTask, CloudTasks.RunTask
Used as field type in: ,
string name = 1
Optionally caller-specified in [CreateTask][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 [ListLocations][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.
oneof payload_type
Required. The task's payload is used by the task's target to process the task. A payload is valid only if it is compatible with the queue's target.
app_engine_http_request = 3
App Engine HTTP request that is sent to the task's target. Can be set only if [app_engine_http_queue][google.cloud.tasks.v2beta3.Queue.app_engine_http_queue] is set on the queue. An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] set.
optional schedule_time = 4
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.
optional create_time = 5
Output only. The time that the task was created. `create_time` will be truncated to the nearest second.
int32 dispatch_count = 6
Output only. The number of attempts dispatched. This count includes tasks which have been dispatched but haven't received a response.
int32 response_count = 7
Output only. The number of attempts which have received a response.
optional first_attempt = 8
Output only. The status of the task's first attempt. Only [dispatch_time][google.cloud.tasks.v2beta3.Attempt.dispatch_time] will be set. The other [Attempt][google.cloud.tasks.v2beta3.Attempt] information is not retained by Cloud Tasks.
optional last_attempt = 9
Output only. The status of the task's last attempt.
Task.View view = 10
Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] has been returned.
The view specifies a subset of [Task][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.
Used in: , , , ,
VIEW_UNSPECIFIED = 0
Unspecified. Defaults to BASIC.
BASIC = 1
The basic view omits fields which can be large or can contain sensitive data. This view does not include the [body in AppEngineHttpRequest][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 = 2
All information is returned. Authorization for [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the [Queue][google.cloud.tasks.v2beta3.Queue] resource.