Members
(static, constant) HttpMethod :number
The HTTP method used to execute the task.
Properties:
| Name | Type | Description |
|---|---|---|
HTTP_METHOD_UNSPECIFIED |
number |
HTTP method unspecified |
POST |
number |
HTTP POST |
GET |
number |
HTTP GET |
HEAD |
number |
HTTP HEAD |
PUT |
number |
HTTP PUT |
DELETE |
number |
HTTP DELETE |
(static) State :number
State of the queue.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
Unspecified state. |
RUNNING |
number |
The queue is running. Tasks can be dispatched. If the queue was created using Cloud Tasks and the queue has had no activity (method calls or task dispatches) for 30 days, the queue may take a few minutes to re-activate. Some method calls may return NOT_FOUND and tasks may not be dispatched for a few minutes until the queue has been re-activated. |
PAUSED |
number |
Tasks are paused by the user. If the queue is paused then Cloud Tasks will stop delivering tasks from it, but more tasks can still be added to it by the user. When a pull queue is paused, all LeaseTasks calls will return a FAILED_PRECONDITION. |
DISABLED |
number |
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 and
LeaseTasks calls return a
To permanently delete this queue and all of its tasks, call DeleteQueue. |
(static) View :number
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.
Properties:
| Name | Type | Description |
|---|---|---|
VIEW_UNSPECIFIED |
number |
Unspecified. Defaults to BASIC. |
BASIC |
number |
The basic view omits fields which can be large or can contain sensitive data. This view does not include the (payload in AppEngineHttpRequest and payload in PullMessage). These payloads are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it. |
FULL |
number |
All information is returned. Authorization for FULL requires
|
Type Definitions
AcknowledgeTaskRequest
Request message for acknowledging a task using AcknowledgeTask.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Required. The task name. For example:
|
scheduleTime |
Object |
Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease. This object should have the same structure as Timestamp |
- Source:
- See:
AppEngineHttpRequest
App Engine HTTP request.
The message defines the HTTP request that is sent to an App Engine app when the task is dispatched.
This proto can only be used for tasks in a queue which has app_engine_http_target set.
Using AppEngineHttpRequest requires
appengine.applications.get
Google IAM permission for the project
and the following scope:
https://www.googleapis.com/auth/cloud-platform
The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see How Requests are Routed and how routing is affected by dispatch files. Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol.
The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level:
- If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
The url that the task will be sent to is:
url =host+relative_url
Tasks can be dispatched to secure app handlers, unsecure app handlers, and
URIs restricted with
login: admin.
Because tasks are not run as any user, they cannot be dispatched to URIs
restricted with
login: required
Task dispatches also do not follow redirects.
The task attempt has succeeded if the app's request handler returns an HTTP
response code in the range [200 - 299]. The task attempt has failed if
the app's handler returns a non-2xx response code or Cloud Tasks does
not receive response before the deadline. 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.
Properties:
| Name | Type | Description |
|---|---|---|
httpMethod |
number |
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 and the documentation for the request handlers in the language your app is written in e.g. Python Request Handler. The number should be among the values of HttpMethod |
appEngineRouting |
Object |
Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. This object should have the same structure as AppEngineRouting |
relativeUrl |
string |
The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. |
headers |
Object.<string, string> |
HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values:
If the task has a payload, Cloud Tasks sets the following headers:
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 Task. For more information, see the CreateTask documentation. |
payload |
Buffer |
Payload. The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod. |
- Source:
- See:
AppEngineHttpTarget
App Engine HTTP target.
The task will be delivered to the App Engine application hostname specified by its AppEngineHttpTarget and AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains how the task's host URL is constructed.
Using AppEngineHttpTarget requires
appengine.applications.get
Google IAM permission for the project
and the following scope:
https://www.googleapis.com/auth/cloud-platform
Properties:
| Name | Type | Description |
|---|---|---|
appEngineRoutingOverride |
Object |
Overrides for the task-level app_engine_routing. If set, This object should have the same structure as AppEngineRouting |
- Source:
- See:
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.
Properties:
| Name | Type | Description |
|---|---|---|
service |
string |
App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. |
version |
string |
App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. |
instance |
string |
App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing. |
host |
string |
Output only. The host that the task is sent to. For more information, see How Requests are Routed. The host is constructed as:
If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted. |
- Source:
- See:
AttemptStatus
The status of a task attempt.
Properties:
| Name | Type | Description |
|---|---|---|
scheduleTime |
Object |
Output only. The time that this attempt was scheduled.
This object should have the same structure as Timestamp |
dispatchTime |
Object |
Output only. The time that this attempt was dispatched.
This object should have the same structure as Timestamp |
responseTime |
Object |
Output only. The time that this attempt response was received.
This object should have the same structure as Timestamp |
responseStatus |
Object |
Output only. The response from the target for this attempt. If the task has not been attempted or the task is currently running then the response status is unset. This object should have the same structure as Status |
- Source:
- See:
CancelLeaseRequest
Request message for canceling a lease using CancelLease.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Required. The task name. For example:
|
scheduleTime |
Object |
Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease. This object should have the same structure as Timestamp |
responseView |
number |
The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires
The number should be among the values of View |
- Source:
- See:
CreateQueueRequest
Request message for CreateQueue.
Properties:
| Name | Type | Description |
|---|---|---|
parent |
string |
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 ListLocations. |
queue |
Object |
Required. The queue to create. Queue's name cannot be the same as an existing queue. This object should have the same structure as Queue |
- Source:
- See:
CreateTaskRequest
Request message for CreateTask.
Properties:
| Name | Type | Description |
|---|---|---|
parent |
string |
Required. The queue name. For example:
The queue must already exist. |
task |
Object |
Required. The task to add. Task names have the following format:
If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. 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 completed. 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 completed. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. This object should have the same structure as Task |
responseView |
number |
The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires
The number should be among the values of View |
- Source:
- See:
DeleteQueueRequest
Request message for DeleteQueue.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Required. The queue name. For example:
|
- Source:
- See:
DeleteTaskRequest
Request message for deleting a task using DeleteTask.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Required. The task name. For example:
|
- Source:
- See:
GetQueueRequest
Request message for GetQueue.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Required. The resource name of the queue. For example:
|
- Source:
- See:
GetTaskRequest
Request message for getting a task using GetTask.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Required. The task name. For example:
|
responseView |
number |
The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires
The number should be among the values of View |
- Source:
- See:
LeaseTasksRequest
Request message for leasing tasks using LeaseTasks.
Properties:
| Name | Type | Description |
|---|---|---|
parent |
string |
Required. The queue name. For example:
|
maxTasks |
number |
The maximum number of tasks to lease. The system will make a best effort to return as close to as
The largest that The maximum total size of a lease tasks response is 32 MB. If the sum of all task sizes requested reaches this limit, fewer tasks than requested are returned. |
leaseDuration |
Object |
Required. The duration of the lease. Each task returned in the response will
have its schedule_time set to the current
time plus the After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later LeaseTasks call so that another worker can retry it. The maximum lease duration is 1 week.
This object should have the same structure as Duration |
responseView |
number |
The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires
The number should be among the values of View |
filter |
string |
When When Grammar Syntax:
The SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren't UTF-8 encoded can't be used in the filter and the task's tag will be displayed as empty in Cloud Tasks. |
- Source:
- See:
LeaseTasksResponse
Response message for leasing tasks using LeaseTasks.
Properties:
| Name | Type | Description |
|---|---|---|
tasks |
Array.<Object> |
The leased tasks. This object should have the same structure as Task |
- Source:
- See:
ListQueuesRequest
Request message for ListQueues.
Properties:
| Name | Type | Description |
|---|---|---|
parent |
string |
Required. The location name.
For example: |
filter |
string |
Sample filter "app_engine_http_target: *". Note that using filters might cause fewer queues than the requested_page size to be returned. |
pageSize |
number |
Requested page size. The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist. |
pageToken |
string |
A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages. |
- Source:
- See:
ListQueuesResponse
Response message for ListQueues.
Properties:
| Name | Type | Description |
|---|---|---|
queues |
Array.<Object> |
The list of queues. This object should have the same structure as Queue |
nextPageToken |
string |
A token to retrieve next page of results. To return the next page of results, call ListQueues with this value as the page_token. If the next_page_token is empty, there are no more results. The page token is valid for only 2 hours. |
- Source:
- See:
ListTasksRequest
Request message for listing tasks using ListTasks.
Properties:
| Name | Type | Description |
|---|---|---|
parent |
string |
Required. The queue name. For example:
|
responseView |
number |
The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires
The number should be among the values of View |
pageSize |
number |
Maximum page size. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. The maximum page size is 1000. If unspecified, the page size will be the maximum. |
pageToken |
string |
A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours. |
- Source:
- See:
ListTasksResponse
Response message for listing tasks using ListTasks.
Properties:
| Name | Type | Description |
|---|---|---|
tasks |
Array.<Object> |
The list of tasks. This object should have the same structure as Task |
nextPageToken |
string |
A token to retrieve next page of results. To return the next page of results, call ListTasks with this value as the page_token. If the next_page_token is empty, there are no more results. |
- Source:
- See:
PauseQueueRequest
Request message for PauseQueue.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Required. The queue name. For example:
|
- Source:
- See:
PullMessage
The pull message contains data that can be used by the caller of LeaseTasks to process the task.
This proto can only be used for tasks in a queue which has pull_target set.
Properties:
| Name | Type | Description |
|---|---|---|
payload |
Buffer |
A data payload consumed by the worker to execute the task. |
tag |
string |
The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. |
- Source:
- See:
PullTarget
Pull target.
- Source:
- See:
PurgeQueueRequest
Request message for PurgeQueue.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Required. The queue name. For example:
|
- Source:
- See:
Queue
A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, target types, and others.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format:
|
appEngineHttpTarget |
Object |
App Engine HTTP target. An App Engine queue is a queue that has an AppEngineHttpTarget. This object should have the same structure as AppEngineHttpTarget |
pullTarget |
Object |
Pull target. A pull queue is a queue that has a PullTarget. This object should have the same structure as PullTarget |
rateLimits |
Object |
Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts however they control how tasks are attempted in different ways:
This object should have the same structure as RateLimits |
retryConfig |
Object |
Settings that determine the retry behavior.
This object should have the same structure as RetryConfig |
state |
number |
Output only. The state of the queue.
The number should be among the values of State |
purgeTime |
Object |
Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console. Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. This object should have the same structure as Timestamp |
- Source:
- See:
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.
Properties:
| Name | Type | Description |
|---|---|---|
maxTasksDispatchedPerSecond |
number |
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. |
maxBurstSize |
number |
Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The token bucket
algorithm is used to control the rate of task dispatches. Each
queue has a token bucket that holds tokens, up to the maximum
specified by Cloud Tasks will pick the value of For App Engine queues that were created or updated using
|
maxConcurrentTasks |
number |
The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field is output only for
pull queues and always -1, which indicates no limit. No other
queue types can have This field has the same meaning as max_concurrent_requests in queue.yaml/xml. |
- Source:
- See:
RenewLeaseRequest
Request message for renewing a lease using RenewLease.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Required. The task name. For example:
|
scheduleTime |
Object |
Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease. This object should have the same structure as Timestamp |
leaseDuration |
Object |
Required. The desired new lease duration, starting from now. The maximum lease duration is 1 week.
This object should have the same structure as Duration |
responseView |
number |
The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires
The number should be among the values of View |
- Source:
- See:
ResumeQueueRequest
Request message for ResumeQueue.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Required. The queue name. For example:
|
- Source:
- See:
RetryConfig
Retry config.
These settings determine how a failed task attempt is retried.
Properties:
| Name | Type | Description |
|---|---|---|
maxAttempts |
number |
The maximum number of attempts for a task. Cloud Tasks will attempt the task |
unlimitedAttempts |
boolean |
If true, then the number of attempts is unlimited. |
maxRetryDuration |
Object |
If positive, If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues.
This field has the same meaning as task_age_limit in queue.yaml/xml. This object should have the same structure as Duration |
minBackoff |
Object |
A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues.
This field has the same meaning as min_backoff_seconds in queue.yaml/xml. This object should have the same structure as Duration |
maxBackoff |
Object |
A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues.
This field has the same meaning as max_backoff_seconds in queue.yaml/xml. This object should have the same structure as Duration |
maxDoublings |
number |
The time between retries will double A task's retry interval starts at
min_backoff, then doubles
For example, if min_backoff is 10s,
max_backoff is 300s, and
If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as max_doublings in queue.yaml/xml. |
- Source:
- See:
RunTaskRequest
Request message for forcing a task to run now using RunTask.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Required. The task name. For example:
|
responseView |
number |
The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires
The number should be among the values of View |
- Source:
- See:
Task
A unit of scheduled work.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Optionally caller-specified in CreateTask. The task name. The task name must have the following format:
|
appEngineHttpRequest |
Object |
App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set. This object should have the same structure as AppEngineHttpRequest |
pullMessage |
Object |
LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set. This object should have the same structure as PullMessage |
scheduleTime |
Object |
The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration.
This object should have the same structure as Timestamp |
createTime |
Object |
Output only. The time that the task was created.
This object should have the same structure as Timestamp |
status |
Object |
Output only. The task status. This object should have the same structure as TaskStatus |
view |
number |
Output only. The view specifies which subset of the Task has been returned. The number should be among the values of View |
- Source:
- See:
TaskStatus
Status of the task.
Properties:
| Name | Type | Description |
|---|---|---|
attemptDispatchCount |
number |
Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. |
attemptResponseCount |
number |
Output only. The number of attempts which have received a response. This field is not calculated for pull tasks. |
firstAttemptStatus |
Object |
Output only. The status of the task's first attempt. Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks. This object should have the same structure as AttemptStatus |
lastAttemptStatus |
Object |
Output only. The status of the task's last attempt. This field is not calculated for pull tasks. This object should have the same structure as AttemptStatus |
- Source:
- See:
UpdateQueueRequest
Request message for UpdateQueue.
Properties:
| Name | Type | Description |
|---|---|---|
queue |
Object |
Required. The queue to create or update. The queue's name must be specified. Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue's name cannot be changed. This object should have the same structure as Queue |
updateMask |
Object |
A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated. This object should have the same structure as FieldMask |