Index
CloudTasks(interface)AppEngineHttpQueue(message)AppEngineHttpRequest(message)AppEngineRouting(message)Attempt(message)BufferTaskRequest(message)BufferTaskResponse(message)CmekConfig(message)CreateQueueRequest(message)CreateTaskRequest(message)DeleteQueueRequest(message)DeleteTaskRequest(message)GetCmekConfigRequest(message)GetQueueRequest(message)GetTaskRequest(message)HttpMethod(enum)HttpRequest(message)HttpTarget(message)HttpTarget.Header(message)HttpTarget.HeaderOverride(message)ListQueuesRequest(message)ListQueuesResponse(message)ListTasksRequest(message)ListTasksResponse(message)OAuthToken(message)OidcToken(message)PathOverride(message)PauseQueueRequest(message)PullMessage(message)PurgeQueueRequest(message)QueryOverride(message)Queue(message)Queue.State(enum)Queue.Type(enum)QueueStats(message)RateLimits(message)ResumeQueueRequest(message)RetryConfig(message)RunTaskRequest(message)StackdriverLoggingConfig(message)Task(message)Task.View(enum)UpdateCmekConfigRequest(message)UpdateQueueRequest(message)UriOverride(message)UriOverride.Scheme(enum)UriOverride.UriOverrideEnforceMode(enum)
CloudTasks
Cloud Tasks allows developers to manage the execution of background work in their applications.
| BufferTask |
|---|
|
Creates and buffers a new task without the need to explicitly define a Task message. The queue must have
|
| CreateQueue |
|---|
|
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
|
| CreateTask |
|---|
|
Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command.
|
| DeleteQueue |
|---|
|
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
|
| DeleteTask |
|---|
|
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.
|
| GetCmekConfig |
|---|
|
Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.
|
| GetIamPolicy |
|---|
|
Gets the access control policy for a Authorization requires the following Google IAM permission on the specified resource parent:
|
| GetQueue |
|---|
|
Gets a queue.
|
| GetTask |
|---|
|
Gets a task.
|
| ListQueues |
|---|
|
Lists queues. Queues are returned in lexicographical order.
|
| ListTasks |
|---|
|
Lists the tasks in a queue. By default, only the The tasks may be returned in any order. The ordering may change at any time.
|
| PauseQueue |
|---|
|
Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via
|
| PurgeQueue |
|---|
|
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.
|
| ResumeQueue |
|---|
|
Resume a queue. This method resumes a queue after it has been 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.
|
| RunTask |
|---|
|
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 This command is meant to be used for manual debugging. For example, 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
|
| SetIamPolicy |
|---|
|
Sets the access control policy for a Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console. Authorization requires the following Google IAM permission on the specified resource parent:
|
| TestIamPermissions |
|---|
|
Returns permissions that a caller has on a 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.
|
| UpdateCmekConfig |
|---|
|
Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.
|
| UpdateQueue |
|---|
|
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
|
AppEngineHttpQueue
App Engine HTTP queue.
The task will be delivered to the App Engine application hostname specified by its AppEngineHttpQueue and AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains how the task's host URL is constructed.
Using AppEngineHttpQueue requires appengine.applications.get Google IAM permission for the project and the following scope:
https://www.googleapis.com/auth/cloud-platform
| Fields | |
|---|---|
app_engine_routing_override |
Overrides for the If set, |
AppEngineHttpRequest
App Engine HTTP request.
The message defines the HTTP request that is sent to an App Engine app when the task is dispatched.
Using AppEngineHttpRequest requires appengine.applications.get Google IAM permission for the project and the following scope:
https://www.googleapis.com/auth/cloud-platform
The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see How Requests are Routed and how routing is affected by dispatch files. Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol.
The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level:
- If set,
app_engine_routing_overrideis used for all tasks in the queue, no matter what the setting is for thetask-level app_engine_routing.
The url that the task will be sent to is:
url =host+relative_uri
Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with login:
admin. Because tasks are not run as any user, they cannot be dispatched to URIs restricted with login:
required Task dispatches also do not follow redirects.
The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [200 - 299]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. 503 (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a 429 (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue.
| Fields | |
|---|---|
http_method |
The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled. |
app_engine_routing |
Task-level setting for App Engine routing. If set, |
relative_uri |
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 |
HTTP request headers. This map contains the header field names and values. Headers can be set when the Cloud Tasks sets some headers to default values:
If the task has a
The headers below cannot be set or overridden:
In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the |
body |
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 |
AppEngineRouting
App Engine Routing.
Defines routing characteristics specific to App Engine - service, version, and instance.
For more information about services, versions, and instances see An Overview of App Engine, Microservices Architecture on Google App Engine, App Engine Standard request routing, and App Engine Flex request routing.
| Fields | |
|---|---|
service |
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, |
version |
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, |
instance |
App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing. |
host |
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 For more information, see How Requests are Routed. |
Attempt
The status of a task attempt.
| Fields | |
|---|---|
schedule_time |
Output only. The time that this attempt was scheduled.
|
dispatch_time |
Output only. The time that this attempt was dispatched.
|
response_time |
Output only. The time that this attempt response was received.
|
response_status |
Output only. The response from the worker for this attempt. If |
BufferTaskRequest
Request message for BufferTask.
| Fields | |
|---|---|
queue |
Required. The parent queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. Authorization requires the following IAM permission on the specified resource
|
task_id |
Optional. Task ID for the task being created. If not provided, a random task ID is assigned to the task. |
body |
Optional. Body of the HTTP request. The body can take any generic value. The value is written to the [HttpRequest][payload] of the [Task]. |
BufferTaskResponse
Response message for BufferTask.
| Fields | |
|---|---|
task |
The created task. |
CmekConfig
Describes the customer-managed encryption key (CMEK) configuration associated with a project and location.
| Fields | |
|---|---|
name |
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 |
Resource name of the Cloud KMS key, of the form |
CreateQueueRequest
Request message for CreateQueue.
| Fields | |
|---|---|
parent |
Required. The location name in which the queue will be created. For example: The list of allowed locations can be obtained by calling Cloud Tasks' implementation of Authorization requires the following IAM permission on the specified resource
|
queue |
Required. The queue to create.
|
CreateTaskRequest
Request message for CreateTask.
| Fields | |
|---|---|
parent |
Required. The queue name. For example: The queue must already exist. Authorization requires the following IAM permission on the specified resource
|
task |
Required. The task to add. Task names have the following format: If 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 Because there is an extra lookup cost to identify duplicate task names, these |
response_view |
The response_view specifies which subset of the By default response_view is Authorization for |
DeleteQueueRequest
Request message for DeleteQueue.
| Fields | |
|---|---|
name |
Required. The queue name. For example: Authorization requires the following IAM permission on the specified resource
|
DeleteTaskRequest
Request message for deleting a task using DeleteTask.
| Fields | |
|---|---|
name |
Required. The task name. For example: Authorization requires the following IAM permission on the specified resource
|
GetCmekConfigRequest
Request message for GetCmekConfig.
| Fields | |
|---|---|
name |
Required. The config resource name. For example: projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` Authorization requires the following IAM permission on the specified resource
|
GetQueueRequest
Request message for GetQueue.
| Fields | |
|---|---|
name |
Required. The resource name of the queue. For example: Authorization requires the following IAM permission on the specified resource
|
read_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 GetTask.
| Fields | |
|---|---|
name |
Required. The task name. For example: Authorization requires the following IAM permission on the specified resource
|
response_view |
The response_view specifies which subset of the By default response_view is Authorization for |
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:
retry configuration,rate limits, and thequeue's state.System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed.
System throttling happens because:
Cloud Tasks backs off on all errors. Normally the backoff specified in
rate limitswill be used. But if the worker returns429(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 theRetry-AfterHTTP 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 |
Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: The |
http_method |
The HTTP method to use for the request. The default is POST. |
headers |
HTTP request headers. This map contains the header field names and values. Headers can be set when the 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:
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 |
HTTP request body. A request body is allowed only if the |
Union field If specified, all |
|
oauth_token |
If specified, an OAuth token will be generated and attached as an This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. |
oidc_token |
If specified, an OIDC token will be generated and attached as an This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. |
HttpTarget
HTTP target.
When specified as a [Queue][target_type], all the tasks with [HttpRequest] will be overridden according to the target.
| Fields | |
|---|---|
uri_override |
URI override. When specified, overrides the execution URI for all the tasks in the queue. |
http_method |
The HTTP method to use for the request. When specified, it overrides |
header_overrides[] |
HTTP target headers. This map contains the header field names and values. Headers will be set when running the 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.
Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms. |
Union field If specified, all |
|
oauth_token |
If specified, an OAuth token is generated and attached as the This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. |
oidc_token |
If specified, an OIDC token is generated and attached as an 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 |
The Key of the header. |
value |
The Value of the header. |
HeaderOverride
Wraps the Header object.
| Fields | |
|---|---|
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. |
ListQueuesRequest
Request message for ListQueues.
| Fields | |
|---|---|
parent |
Required. The location name. For example: Authorization requires the following IAM permission on the specified resource
|
filter |
Sample filter "state: PAUSED". Note that using filters might cause fewer queues than the requested page_size to be returned. |
page_size |
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 |
page_token |
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 |
read_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 ListQueues.
| Fields | |
|---|---|
queues[] |
The list of queues. |
next_page_token |
A token to retrieve next page of results. To return the next page of results, call If the next_page_token is empty, there are no more results. The page token is valid for only 2 hours. |
ListTasksRequest
Request message for listing tasks using ListTasks.
| Fields | |
|---|---|
parent |
Required. The queue name. For example: Authorization requires the following IAM permission on the specified resource
|
response_view |
The response_view specifies which subset of the By default response_view is Authorization for |
page_size |
Maximum page size. Fewer tasks than requested might be returned, even if more tasks exist; use The maximum page size is 1000. If unspecified, the page size will be the maximum. |
page_token |
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 The page token is valid for only 2 hours. |
ListTasksResponse
Response message for listing tasks using ListTasks.
| Fields | |
|---|---|
tasks[] |
The list of tasks. |
next_page_token |
A token to retrieve next page of results. To return the next page of results, call If the next_page_token is empty, there are no more results. |
OAuthToken
Contains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
| Fields | |
|---|---|
service_account_email |
Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. |
scope |
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. |
OidcToken
Contains information needed for generating an OpenID Connect token. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
| Fields | |
|---|---|
service_account_email |
Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. |
audience |
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 |
The URI path (e.g., /users/1234). Default is an empty string. |
PauseQueueRequest
Request message for PauseQueue.
| Fields | |
|---|---|
name |
Required. The queue name. For example: Authorization requires the following IAM permission on the specified resource
|
PullMessage
Pull Message.
This proto can only be used for tasks in a queue which has PULL type. It currently exists for backwards compatibility with the App Engine Task Queue SDK. This message type maybe returned with methods [list][google.cloud.tasks.v2beta3.CloudTask.ListTasks] and [get][google.cloud.tasks.v2beta3.CloudTask.ListTasks], when the response view is [FULL][google.cloud.tasks.v2beta3.Task.View.Full].
| Fields | |
|---|---|
payload |
A data payload consumed by the worker to execute the task. |
tag |
The tasks's tag. The tag is less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. |
PurgeQueueRequest
Request message for PurgeQueue.
| Fields | |
|---|---|
name |
Required. The queue name. For example: Authorization requires the following IAM permission on the specified resource
|
QueryOverride
QueryOverride.
Query message defines query override for HTTP targets.
| Fields | |
|---|---|
query_params |
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 |
Caller-specified and required in The queue name. The queue name must have the following format:
|
http_target |
Modifies HTTP target for HTTP tasks. |
rate_limits |
Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
|
retry_config |
Settings that determine the retry behavior.
|
state |
Output only. The state of the queue.
|
purge_time |
Output only. The last time this queue was purged. All tasks that were A queue can be purged using Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. |
task_ttl |
The maximum amount of time that a task will be retained in this queue. After a task has lived for 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 Queues created by Cloud Tasks have a default Queues created by queue.yaml/xml have a fixed |
tombstone_ttl |
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 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 Queues created by Cloud Tasks have a default |
stackdriver_logging_config |
Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written. |
type |
Immutable. The type of a queue (push or pull).
|
stats |
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
|
|
app_engine_http_queue |
|
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 |
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 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 |
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 |
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 |
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 |
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 |
Output only. The number of requests that the queue has dispatched but has not received a reply for yet. |
effective_execution_rate |
Output only. The current maximum number of tasks per second executed by the queue. The maximum value of this variable is controlled by the RateLimits of the Queue. However, this value could be less to avoid overloading the endpoints tasks in the queue are targeting. |
RateLimits
Rate limits.
This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry.
Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits.
| Fields | |
|---|---|
max_dispatches_per_second |
The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.
This field has the same meaning as rate in queue.yaml/xml. |
max_burst_size |
The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The token bucket algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by The default value of The maximum value of For App Engine queues that were created or updated using |
max_concurrent_dispatches |
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. |
ResumeQueueRequest
Request message for ResumeQueue.
| Fields | |
|---|---|
name |
Required. The queue name. For example: Authorization requires the following IAM permission on the specified resource
|
RetryConfig
Retry config.
These settings determine when a failed task attempt is retried.
| Fields | |
|---|---|
max_attempts |
Number of attempts per task. Cloud Tasks will attempt the task If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as task_retry_limit in queue.yaml/xml. |
max_retry_duration |
If positive, If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by This field has the same meaning as task_age_limit in queue.yaml/xml. |
min_backoff |
A task will be If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by This field has the same meaning as min_backoff_seconds in queue.yaml/xml. |
max_backoff |
A task will be If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by This field has the same meaning as max_backoff_seconds in queue.yaml/xml. |
max_doublings |
The time between retries will double A task's retry interval starts at For example, if 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. |
RunTaskRequest
Request message for forcing a task to run now using RunTask.
| Fields | |
|---|---|
name |
Required. The task name. For example: Authorization requires the following IAM permission on the specified resource
|
response_view |
The response_view specifies which subset of the By default response_view is Authorization for |
StackdriverLoggingConfig
Configuration options for writing logs to Stackdriver Logging.
| Fields | |
|---|---|
sampling_ratio |
Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. |
Task
A unit of scheduled work.
| Fields | |
|---|---|
name |
Optionally caller-specified in The task name. The task name must have the following format:
|
schedule_time |
The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried.
|
create_time |
Output only. The time that the task was created.
|
dispatch_deadline |
The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a 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:
The value must be given as a string that indicates the length of time (in seconds) followed by |
dispatch_count |
Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. |
response_count |
Output only. The number of attempts which have received a response. |
first_attempt |
Output only. The status of the task's first attempt. Only |
last_attempt |
Output only. The status of the task's last attempt. |
view |
Output only. The view specifies which subset of the |
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 |
HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has |
http_request |
HTTP request that is sent to the task's target. An HTTP task is a task that has |
pull_message |
Pull Message contained in a task in a |
View
The view specifies a subset of Task data.
When a task is returned in a response, not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.
| Enums | |
|---|---|
VIEW_UNSPECIFIED |
Unspecified. Defaults to BASIC. |
BASIC |
The basic view omits fields which can be large or can contain sensitive data. This view does not include the |
FULL |
All information is returned. Authorization for |
UpdateCmekConfigRequest
Request message for UpdateCmekConfig.
| Fields | |
|---|---|
cmek_config |
Required. The config to update. Its name attribute distinguishes it. Authorization requires the following IAM permission on the specified resource
|
update_mask |
List of fields to be updated in this request. |
UpdateQueueRequest
Request message for UpdateQueue.
| Fields | |
|---|---|
queue |
Required. The queue to create or update. The queue's Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue's Authorization requires the following IAM permission on the specified resource
|
update_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 |
URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment. |
query_override |
URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment. |
uri_override_enforce_mode |
URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS. |
scheme |
Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS). |
host |
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 |
Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port. |
Scheme
The Scheme for an HTTP request. By default, it is HTTPS.
| Enums | |
|---|---|
SCHEME_UNSPECIFIED |
Scheme unspecified. Defaults to HTTPS. |
HTTP |
Convert the scheme to HTTP, e.g., https://www.google.ca will change to http://www.google.ca. |
HTTPS |
Convert the scheme to HTTPS, e.g., http://www.google.ca will change to https://www.google.ca. |
UriOverrideEnforceMode
UriOverrideEnforceMode mode is to define enforcing mode for the override modes.
| Enums | |
|---|---|
URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED |
OverrideMode Unspecified. Defaults to ALWAYS. |
IF_NOT_EXISTS |
In the IF_NOT_EXISTS mode, queue-level configuration is only applied where task-level configuration does not exist. |
ALWAYS |
In the ALWAYS mode, queue-level configuration overrides all task-level configuration |