Types for Cloud Tasks API Client#
-
class
google.cloud.tasks_v2beta3.types.
Any
# -
type_url
# Field google.protobuf.Any.type_url
-
value
# Field google.protobuf.Any.value
-
-
class
google.cloud.tasks_v2beta3.types.
AppEngineHttpQueue
# App 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
-
app_engine_routing_override
# Overrides for the [task-level app_engine_routing][google.clo ud.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.AppEngi neHttpRequest.app_engine_routing].
-
app_engine_routing_override
Field google.cloud.tasks.v2beta3.AppEngineHttpQueue.app_engine_routing_override
-
-
class
google.cloud.tasks_v2beta3.types.
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][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 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][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]
Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with
`login: admin
<https://cloud.google.com/appengine/docs/standard/python/config/appref>`_. Because tasks are not run as any user, they cannot be dispatched to URIs restricted with`login: required
<https://cloud.google.com/appengine/docs/standard/python/config/appref>`_ Task dispatches also do not follow redirects.The task attempt has succeeded if the app’s request handler returns an HTTP response code in the range [
200
-299
]. The task attempt has failed if the app’s handler returns a non-2xx response code or Cloud Tasks does not receive response before the [deadline][google.cloud.tasks.v2beta3.Task.dispatch_deadline]. Failed tasks will be retried according to the [retry configuration][Queue.RetryConfig].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, a429
(Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue.-
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 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.
-
app_engine_routing
# Task-level setting for App Engine routing. If set, [app_engi ne_routing_override][google.cloud.tasks.v2beta3.AppEngineHtt pQueue.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.AppEngi neHttpRequest.app_engine_routing].
-
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 [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 modifiedUser-Agent
. If the task has a [body][google.cloud.tasks.v2beta3.AppEngineHttpRequest.body], Cloud Tasks sets the following headers: -Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-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. 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.
-
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 [HttpMethod][google.cloud.tasks.v2beta3.HttpMethod].
-
class
HeadersEntry
# -
key
# Field google.cloud.tasks.v2beta3.AppEngineHttpRequest.HeadersEntry.key
-
value
# Field google.cloud.tasks.v2beta3.AppEngineHttpRequest.HeadersEntry.value
-
-
app_engine_routing
Field google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing
-
body
Field google.cloud.tasks.v2beta3.AppEngineHttpRequest.body
-
headers
Field google.cloud.tasks.v2beta3.AppEngineHttpRequest.headers
-
http_method
Field google.cloud.tasks.v2beta3.AppEngineHttpRequest.http_method
-
relative_uri
Field google.cloud.tasks.v2beta3.AppEngineHttpRequest.relative_uri
-
class
google.cloud.tasks_v2beta3.types.
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.
-
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, [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable into [service][google.cloud.tasks.v2beta3.AppEngi neRouting.service], [version][google.cloud.tasks.v2beta3.AppEn gineRouting.version], and [instance][google.cloud.tasks.v2beta 3.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.AppEng ineRouting.service], [version][google.cloud.tasks.v2beta3.AppE ngineRouting.version], and [instance][google.cloud.tasks.v2bet a3.AppEngineRouting.instance] are the empty string.
-
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, [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable into [service][google.cloud.tasks.v2beta3.AppEngi neRouting.service], [version][google.cloud.tasks.v2beta3.AppEn gineRouting.version], and [instance][google.cloud.tasks.v2beta 3.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.AppEng ineRouting.service], [version][google.cloud.tasks.v2beta3.AppE ngineRouting.version], and [instance][google.cloud.tasks.v2bet a3.AppEngineRouting.instance] are the empty string.
-
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 .appspot.com), and the [se rvice][google.cloud.tasks.v2beta3.AppEngineRouting.service], [ version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and [instance][google.cloud.tasks.v2beta3.AppEngineRouting.ins tance]. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
-
host
Field google.cloud.tasks.v2beta3.AppEngineRouting.host
-
instance
Field google.cloud.tasks.v2beta3.AppEngineRouting.instance
-
service
Field google.cloud.tasks.v2beta3.AppEngineRouting.service
-
version
Field google.cloud.tasks.v2beta3.AppEngineRouting.version
-
-
class
google.cloud.tasks_v2beta3.types.
Attempt
# The status of a task attempt.
-
schedule_time
# Output only. The time that this attempt was scheduled.
schedule_time
will be truncated to the nearest microsecond.
-
dispatch_time
# Output only. The time that this attempt was dispatched.
dispatch_time
will be truncated to the nearest microsecond.
-
response_time
# Output only. The time that this attempt response was received.
response_time
will be truncated to the nearest microsecond.
-
response_status
# Output only. The response from the worker for this attempt. If
response_time
is unset, then the task has not been attempted or is currently running and theresponse_status
field is meaningless.
-
dispatch_time
Field google.cloud.tasks.v2beta3.Attempt.dispatch_time
-
response_status
Field google.cloud.tasks.v2beta3.Attempt.response_status
-
response_time
Field google.cloud.tasks.v2beta3.Attempt.response_time
-
schedule_time
Field google.cloud.tasks.v2beta3.Attempt.schedule_time
-
-
class
google.cloud.tasks_v2beta3.types.
AuditConfigDelta
# One delta entry for AuditConfig. Each individual change (only one exempted_member in each entry) to a AuditConfig will be a separate entry.
-
action
# The action that was performed on an audit configuration in a policy. Required
-
service
# Specifies a service that was configured for Cloud Audit Logging. For example,
storage.googleapis.com
,cloudsql.googleapis.com
.allServices
is a special value that covers all services. Required
-
exempted_member
# A single identity that is exempted from “data access” audit logging for the
service
specified above. Follows the same format of Binding.members.
-
log_type
# Specifies the log_type that was be enabled. ADMIN_ACTIVITY is always enabled, and cannot be configured. Required
-
action
Field google.iam.v1.AuditConfigDelta.action
-
exempted_member
Field google.iam.v1.AuditConfigDelta.exempted_member
-
log_type
Field google.iam.v1.AuditConfigDelta.log_type
-
service
Field google.iam.v1.AuditConfigDelta.service
-
-
class
google.cloud.tasks_v2beta3.types.
Binding
# Associates
members
with arole
.-
role
# Role that is assigned to
members
. For example,roles/viewer
,roles/editor
, orroles/owner
.
-
members
# Specifies the identities requesting access for a Cloud Platform resource.
members
can have the following values: -allUsers
: A special identifier that represents anyone who is on the internet; with or without a Google account. -allAuthenticatedUsers
: A special identifier that represents anyone who is authenticated with a Google account or a service account. -user:{emailid}
: An email address that represents a specific Google account. For example,alice@gmail.com
. -serviceAccount:{emailid}
: An email address that represents a service account. For example,my-other- app@appspot.gserviceaccount.com
. -group:{emailid}
: An email address that represents a Google group. For example,admins@example.com
. -domain:{domain}
: The G Suite domain (primary) that represents all the users of that domain. For example,google.com
orexample.com
.
-
condition
# The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
-
condition
Field google.iam.v1.Binding.condition
-
members
Field google.iam.v1.Binding.members
-
role
Field google.iam.v1.Binding.role
-
-
class
google.cloud.tasks_v2beta3.types.
BindingDelta
# One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.
-
action
# The action that was performed on a Binding. Required
-
role
# Role that is assigned to
members
. For example,roles/viewer
,roles/editor
, orroles/owner
. Required
-
member
# A single identity requesting access for a Cloud Platform resource. Follows the same format of Binding.members. Required
-
condition
# Unimplemented. The condition that is associated with this binding. This field is logged only for Cloud Audit Logging.
-
action
Field google.iam.v1.BindingDelta.action
-
condition
Field google.iam.v1.BindingDelta.condition
-
member
Field google.iam.v1.BindingDelta.member
-
role
Field google.iam.v1.BindingDelta.role
-
-
class
google.cloud.tasks_v2beta3.types.
CreateQueueRequest
# Request message for [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.CreateQueue].
-
parent
# 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.Locati ons.ListLocations].
-
queue
# Required. The queue to create. [Queue’s name][google.cloud.tasks.v2beta3.Queue.name] cannot be the same as an existing queue.
-
parent
Field google.cloud.tasks.v2beta3.CreateQueueRequest.parent
-
queue
Field google.cloud.tasks.v2beta3.CreateQueueRequest.queue
-
-
class
google.cloud.tasks_v2beta3.types.
CreateTaskRequest
# Request message for [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
-
parent
# Required. The queue name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
The queue must already exist.
-
task
# Required. The task to add. Task names have the following format:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUE UE_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 [schedul e_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.
-
response_view
# 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 permission on the [Task][google.cloud.tasks.v2beta3.Task] resource.
-
parent
Field google.cloud.tasks.v2beta3.CreateTaskRequest.parent
-
response_view
Field google.cloud.tasks.v2beta3.CreateTaskRequest.response_view
-
task
Field google.cloud.tasks.v2beta3.CreateTaskRequest.task
-
-
class
google.cloud.tasks_v2beta3.types.
DeleteQueueRequest
# Request message for [DeleteQueue][google.cloud.tasks.v2beta3.CloudTasks.DeleteQueue].
-
name
# Required. The queue name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
-
name
Field google.cloud.tasks.v2beta3.DeleteQueueRequest.name
-
-
class
google.cloud.tasks_v2beta3.types.
DeleteTaskRequest
# Request message for deleting a task using [DeleteTask][google.cloud.tasks.v2beta3.CloudTasks.DeleteTask].
-
name
# Required. The task name. For example:
projects/PROJECT_ID/l ocations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
-
name
Field google.cloud.tasks.v2beta3.DeleteTaskRequest.name
-
-
class
google.cloud.tasks_v2beta3.types.
Duration
# -
nanos
# Field google.protobuf.Duration.nanos
-
seconds
# Field google.protobuf.Duration.seconds
-
-
class
google.cloud.tasks_v2beta3.types.
Empty
#
-
class
google.cloud.tasks_v2beta3.types.
Expr
# -
description
# Field google.type.Expr.description
-
expression
# Field google.type.Expr.expression
-
location
# Field google.type.Expr.location
-
title
# Field google.type.Expr.title
-
-
class
google.cloud.tasks_v2beta3.types.
GetIamPolicyRequest
# Request message for
GetIamPolicy
method.-
resource
# REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
-
options
# OPTIONAL: A
GetPolicyOptions
object for specifying options toGetIamPolicy
. This field is only used by Cloud IAM.
-
options
Field google.iam.v1.GetIamPolicyRequest.options
-
resource
Field google.iam.v1.GetIamPolicyRequest.resource
-
-
class
google.cloud.tasks_v2beta3.types.
GetPolicyOptions
# Encapsulates settings provided to GetIamPolicy.
-
requested_policy_version
# Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned.
-
requested_policy_version
Field google.iam.v1.GetPolicyOptions.requested_policy_version
-
-
class
google.cloud.tasks_v2beta3.types.
GetQueueRequest
# Request message for [GetQueue][google.cloud.tasks.v2beta3.CloudTasks.GetQueue].
-
name
# Required. The resource name of the queue. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
-
name
Field google.cloud.tasks.v2beta3.GetQueueRequest.name
-
-
class
google.cloud.tasks_v2beta3.types.
GetTaskRequest
# Request message for getting a task using [GetTask][google.cloud.tasks.v2beta3.CloudTasks.GetTask].
-
name
# Required. The task name. For example:
projects/PROJECT_ID/l ocations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
-
response_view
# 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 permission on the [Task][google.cloud.tasks.v2beta3.Task] resource.
-
name
Field google.cloud.tasks.v2beta3.GetTaskRequest.name
-
response_view
Field google.cloud.tasks.v2beta3.GetTaskRequest.response_view
-
-
class
google.cloud.tasks_v2beta3.types.
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 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][Queue.RetryConfig], [rate limits][Queue.RateLimits], and the [queue’s state][google.cloud.tasks.v2beta3.Queue.state].
System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue’s effective rate. User-specified settings will not be changed.
System throttling happens because:
Cloud Tasks backoffs on all errors. Normally the backoff specified in [rate limits][Queue.RateLimits] will be used. But if the worker returns
429
(Too Many Requests),503
(Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in theRetry-After
HTTP response header is considered.To prevent traffic spikes and to smooth sudden large traffic spikes, 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).
-
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:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. TheLocation
header response from a redirect response [300
-399
] may be followed. The redirect is not counted as a separate attempt.
-
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 [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. These headers represent a subset of the headers that will accompany the task’s HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: - Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta3.HttpRequest.url]. - Content-Length: This will be computed by Cloud Tasks. - User-Agent: This will be set to
"Google-Cloud-Tasks"
. - X-Google-*: Google use only. - X-AppEngine-*: Google use only.Content-Type
won’t be set by Cloud Tasks. You can explicitly setContent-Type
to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example,Content-Type
can be set to"application/octet-stream"
or"application/json"
. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.
-
body
# HTTP request body. A request body is allowed only if the [HTTP method][google.cloud.tasks.v2beta3.HttpRequest.http_method] is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2beta3.HttpMethod].
The mode for generating an
Authorization
header for HTTP requests. If specified, allAuthorization
headers in the [HttpTarget.headers][] field will be overridden.
-
oauth_token
# If specified, an OAuth token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
-
oidc_token
# If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
-
class
HeadersEntry
# -
key
# Field google.cloud.tasks.v2beta3.HttpRequest.HeadersEntry.key
-
value
# Field google.cloud.tasks.v2beta3.HttpRequest.HeadersEntry.value
-
-
body
Field google.cloud.tasks.v2beta3.HttpRequest.body
-
headers
Field google.cloud.tasks.v2beta3.HttpRequest.headers
-
http_method
Field google.cloud.tasks.v2beta3.HttpRequest.http_method
-
oauth_token
Field google.cloud.tasks.v2beta3.HttpRequest.oauth_token
-
oidc_token
Field google.cloud.tasks.v2beta3.HttpRequest.oidc_token
-
url
Field google.cloud.tasks.v2beta3.HttpRequest.url
-
class
google.cloud.tasks_v2beta3.types.
ListQueuesRequest
# Request message for [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues].
-
parent
# Required. The location name. For example:
projects/PROJECT_ID/locations/LOCATION_ID
-
filter
# 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. 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 [next_page_token][google.cloud.tasks.v2beta3.ListQue uesResponse.next_page_token] in the response to determine if more queues exist.
-
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 [ne xt_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.
-
filter
Field google.cloud.tasks.v2beta3.ListQueuesRequest.filter
-
page_size
Field google.cloud.tasks.v2beta3.ListQueuesRequest.page_size
-
page_token
Field google.cloud.tasks.v2beta3.ListQueuesRequest.page_token
-
parent
Field google.cloud.tasks.v2beta3.ListQueuesRequest.parent
-
-
class
google.cloud.tasks_v2beta3.types.
ListQueuesResponse
# Response message for [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues].
-
queues
# The list of queues.
-
next_page_token
# 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.v2beta 3.ListQueuesRequest.page_token]. If the next_page_token is empty, there are no more results. The page token is valid for only 2 hours.
-
next_page_token
Field google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token
-
queues
Field google.cloud.tasks.v2beta3.ListQueuesResponse.queues
-
-
class
google.cloud.tasks_v2beta3.types.
ListTasksRequest
# Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks].
-
parent
# Required. The queue name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
-
response_view
# 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 permission on the [Task][google.cloud.tasks.v2beta3.Task] resource.
-
page_size
# Maximum page size. Fewer tasks than requested might be returned, even if more tasks exist; use [next_page_token][go ogle.cloud.tasks.v2beta3.ListTasksResponse.next_page_token] in the response to determine if more tasks exist. The maximum page size is 1000. If unspecified, the page size will be the maximum.
-
page_token
# 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 [ne xt_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.
-
page_size
Field google.cloud.tasks.v2beta3.ListTasksRequest.page_size
-
page_token
Field google.cloud.tasks.v2beta3.ListTasksRequest.page_token
-
parent
Field google.cloud.tasks.v2beta3.ListTasksRequest.parent
-
response_view
Field google.cloud.tasks.v2beta3.ListTasksRequest.response_view
-
-
class
google.cloud.tasks_v2beta3.types.
ListTasksResponse
# Response message for listing tasks using [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks].
-
tasks
# The list of tasks.
-
next_page_token
# 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.v2beta 3.ListTasksRequest.page_token]. If the next_page_token is empty, there are no more results.
-
next_page_token
Field google.cloud.tasks.v2beta3.ListTasksResponse.next_page_token
-
tasks
Field google.cloud.tasks.v2beta3.ListTasksResponse.tasks
-
-
class
google.cloud.tasks_v2beta3.types.
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.
-
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.
-
scope
Field google.cloud.tasks.v2beta3.OAuthToken.scope
-
service_account_email
Field google.cloud.tasks.v2beta3.OAuthToken.service_account_email
-
-
class
google.cloud.tasks_v2beta3.types.
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.
-
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.
-
audience
Field google.cloud.tasks.v2beta3.OidcToken.audience
-
service_account_email
Field google.cloud.tasks.v2beta3.OidcToken.service_account_email
-
-
class
google.cloud.tasks_v2beta3.types.
PauseQueueRequest
# Request message for [PauseQueue][google.cloud.tasks.v2beta3.CloudTasks.PauseQueue].
-
name
# Required. The queue name. For example:
projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
-
name
Field google.cloud.tasks.v2beta3.PauseQueueRequest.name
-
-
class
google.cloud.tasks_v2beta3.types.
Policy
# Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
A
Policy
consists of a list ofbindings
. Abinding
binds a list ofmembers
to arole
, where the members can be user accounts, Google groups, Google domains, and service accounts. Arole
is a named list of permissions defined by IAM.JSON Example
{ "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer
For a description of IAM and its features, see the IAM developer’s guide.
-
version
# Deprecated.
-
bindings
# Associates a list of
members
to arole
.bindings
with no members will result in an error.
-
etag
# etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of theetag
in the read-modify-write cycle to perform policy updates in order to avoid race conditions: Anetag
is returned in the response togetIamPolicy
, and systems are expected to put that etag in the request tosetIamPolicy
to ensure that their change will be applied to the same version of the policy. If noetag
is provided in the call tosetIamPolicy
, then the existing policy is overwritten blindly.
-
bindings
Field google.iam.v1.Policy.bindings
-
etag
Field google.iam.v1.Policy.etag
-
version
Field google.iam.v1.Policy.version
-
-
class
google.cloud.tasks_v2beta3.types.
PolicyDelta
# The difference delta between two policies.
-
binding_deltas
# The delta for Bindings between two policies.
-
audit_config_deltas
# The delta for AuditConfigs between two policies.
-
audit_config_deltas
Field google.iam.v1.PolicyDelta.audit_config_deltas
-
binding_deltas
Field google.iam.v1.PolicyDelta.binding_deltas
-
-
class
google.cloud.tasks_v2beta3.types.
PurgeQueueRequest
# Request message for [PurgeQueue][google.cloud.tasks.v2beta3.CloudTasks.PurgeQueue].
-
name
# Required. The queue name. For example:
projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
-
name
Field google.cloud.tasks.v2beta3.PurgeQueueRequest.name
-
-
class
google.cloud.tasks_v2beta3.types.
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.
-
name
# Caller-specified and required in [CreateQueue][google.cloud.ta sks.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 -LOCATION_ID
is the canonical ID for the queue’s location. The list of available locations can be obtained by calling [ListLocatio ns][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.
-
app_engine_http_queue
# [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQ ueue] settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue. [Http tasks][google.cloud.tasks.v2beta3.HttpRequest] are not affected by this proto.
-
rate_limits
# Rate limits for task dispatches. [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits] and [retry_config][google.cloud.tasks.v2beta3.Queue.retry_co nfig] are related because they both control task attempts. However they control task attempts 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.tas ks.v2beta3.Queue.retry_config] controls task retries (the second attempt, third attempt, etc). The queue’s actual dispatch rate is the result of: - Number of tasks in the queue - User-specified throttling: [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits], [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config ], and the [queue’s state][google.cloud.tasks.v2beta3.Queue.state]. - System throttling due to
429
(Too Many Requests) or503
(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
-
retry_config
# Settings that determine the retry behavior. - For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. - For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See App Engine documentation.
-
state
# Output only. The state of the queue.
state
can only be changed by called [PauseQueue][google.cloud.tasks.v2beta3.Clou dTasks.PauseQueue], [ResumeQueue][google.cloud.tasks.v2beta3.C loudTasks.ResumeQueue], or uploading queue.yaml/xml. [U pdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue] cannot be used to changestate
.
-
purge_time
# 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 [PurgeQueu e][google.cloud.tasks.v2beta3.CloudTasks.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.
-
stackdriver_logging_config
# Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
-
app_engine_http_queue
Field google.cloud.tasks.v2beta3.Queue.app_engine_http_queue
-
name
Field google.cloud.tasks.v2beta3.Queue.name
-
purge_time
Field google.cloud.tasks.v2beta3.Queue.purge_time
-
rate_limits
Field google.cloud.tasks.v2beta3.Queue.rate_limits
-
retry_config
Field google.cloud.tasks.v2beta3.Queue.retry_config
-
stackdriver_logging_config
Field google.cloud.tasks.v2beta3.Queue.stackdriver_logging_config
-
state
Field google.cloud.tasks.v2beta3.Queue.state
-
-
class
google.cloud.tasks_v2beta3.types.
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][google.cloud.tasks.v2beta3.CloudTasks.RunTask], will run a task even if the queue has reached its [RateLimits][google.cloud.tasks.v2beta3.RateLimits].
-
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. - 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.
-
max_burst_size
# 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
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_dispatche s_per_second][google.cloud.tasks.v2beta3.RateLimits.max_dis patches_per_second]. Cloud Tasks will pick the value ofmax_burst_size
based on the value of [max_dispatches_per _second][google.cloud.tasks.v2beta3.RateLimits.max_dispatche s_per_second]. For App Engine queues that were created or updated usingqueue.yaml/xml
,max_burst_size
is equal to bucket_size. Sincemax_burst_size
is output only, if [UpdateQueue][google.clo ud.tasks.v2beta3.CloudTasks.UpdateQueue] is called on a queue created byqueue.yaml/xml
,max_burst_size
will be reset based on the value of [max_dispatches_per_second][goo gle.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_secon d], regardless of whether [max_dispatches_per_second][googl e.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_second] is updated.
-
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.
-
max_burst_size
Field google.cloud.tasks.v2beta3.RateLimits.max_burst_size
-
max_concurrent_dispatches
Field google.cloud.tasks.v2beta3.RateLimits.max_concurrent_dispatches
-
max_dispatches_per_second
Field google.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_second
-
-
class
google.cloud.tasks_v2beta3.types.
ResumeQueueRequest
# Request message for [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue].
-
name
# Required. The queue name. For example:
projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
-
name
Field google.cloud.tasks.v2beta3.ResumeQueueRequest.name
-
-
class
google.cloud.tasks_v2beta3.types.
RetryConfig
# Retry config.
These settings determine when a failed task attempt is retried.
-
max_attempts
# Number of attempts per task. Cloud Tasks will attempt the task
max_attempts
times (that is, if the first attempt fails, then there will bemax_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.
-
max_retry_duration
# If positive,
max_retry_duration
specifies the time limit for retrying a failed task, measured from when the task was first attempted. Oncemax_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.
-
min_backoff
# A task will be [scheduled][google.cloud.tasks.v2beta3.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta3.Re tryConfig.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.
-
max_backoff
# A task will be [scheduled][google.cloud.tasks.v2beta3.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta3.Re tryConfig.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.
-
max_doublings
# 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 doublesmax_doublings
times, then increases linearly, and finally retries retries at intervals of [max_backoff][google.cloud.ta sks.v2beta3.RetryConfig.max_backoff] up to [max_attempts][go ogle.cloud.tasks.v2beta3.RetryConfig.max_attempts] times. For example, if [min_backoff][google.cloud.tasks.v2beta3.Retr yConfig.min_backoff] is 10s, [max_backoff][google.cloud.task s.v2beta3.RetryConfig.max_backoff] is 300s, andmax_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.Retr yConfig.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.
-
max_attempts
Field google.cloud.tasks.v2beta3.RetryConfig.max_attempts
-
max_backoff
Field google.cloud.tasks.v2beta3.RetryConfig.max_backoff
-
max_doublings
Field google.cloud.tasks.v2beta3.RetryConfig.max_doublings
-
max_retry_duration
Field google.cloud.tasks.v2beta3.RetryConfig.max_retry_duration
-
min_backoff
Field google.cloud.tasks.v2beta3.RetryConfig.min_backoff
-
-
class
google.cloud.tasks_v2beta3.types.
RunTaskRequest
# Request message for forcing a task to run now using [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask].
-
name
# Required. The task name. For example:
projects/PROJECT_ID/l ocations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
-
response_view
# 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 permission on the [Task][google.cloud.tasks.v2beta3.Task] resource.
-
name
Field google.cloud.tasks.v2beta3.RunTaskRequest.name
-
response_view
Field google.cloud.tasks.v2beta3.RunTaskRequest.response_view
-
-
class
google.cloud.tasks_v2beta3.types.
SetIamPolicyRequest
# Request message for
SetIamPolicy
method.-
resource
# REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
-
policy
# REQUIRED: The complete policy to be applied to the
resource
. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
-
policy
Field google.iam.v1.SetIamPolicyRequest.policy
-
resource
Field google.iam.v1.SetIamPolicyRequest.resource
-
-
class
google.cloud.tasks_v2beta3.types.
StackdriverLoggingConfig
# Configuration options for writing logs to Stackdriver Logging.
-
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.
-
sampling_ratio
Field google.cloud.tasks.v2beta3.StackdriverLoggingConfig.sampling_ratio
-
-
class
google.cloud.tasks_v2beta3.types.
Status
# -
code
# Field google.rpc.Status.code
-
details
# Field google.rpc.Status.details
-
message
# Field google.rpc.Status.message
-
-
class
google.cloud.tasks_v2beta3.types.
Task
# A unit of scheduled work.
-
name
# 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/loc ations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
-PROJECT_ID
can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects -LOCATION_ID
is the canonical ID for the task’s location. The list of available locations can be obtained by calling [ListLocatio ns][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.
-
payload_type
# Required. The message to send to the worker.
-
app_engine_http_request
# HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has [AppEngineHttpRequest][goog le.cloud.tasks.v2beta3.AppEngineHttpRequest] set.
-
http_request
# HTTP request that is sent to the task’s target. An HTTP task is a task that has [HttpRequest][google.cloud.tasks.v2beta3.HttpRequest] set.
-
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.
schedule_time
will be truncated to the nearest microsecond.
-
create_time
# Output only. The time that the task was created.
create_time
will be truncated to the nearest second.
-
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
DEADLINE_EXCEEDED
failure. Cloud Tasks will retry the task according to the [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig]. Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: - For [HTTP tasks][google.cloud.tasks.v2beta3.HttpRequest], the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. - For [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest], 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task’sdispatch_deadline
, the app handler will not run for longer than than the service’s timeout. We recommend setting thedispatch_deadline
to at most a few seconds more than the app handler’s timeout. For more information see Timeouts.dispatch_deadline
will be truncated to the nearest millisecond. The deadline is an approximate deadline.
-
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 [di spatch_time][google.cloud.tasks.v2beta3.Attempt.dispatch_tim e] will be set. The other [Attempt][google.cloud.tasks.v2beta3.Attempt] information is not retained by Cloud Tasks.
-
last_attempt
# Output only. The status of the task’s last attempt.
-
view
# Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] has been returned.
-
app_engine_http_request
Field google.cloud.tasks.v2beta3.Task.app_engine_http_request
-
create_time
Field google.cloud.tasks.v2beta3.Task.create_time
-
dispatch_count
Field google.cloud.tasks.v2beta3.Task.dispatch_count
-
dispatch_deadline
Field google.cloud.tasks.v2beta3.Task.dispatch_deadline
-
first_attempt
Field google.cloud.tasks.v2beta3.Task.first_attempt
-
http_request
Field google.cloud.tasks.v2beta3.Task.http_request
-
last_attempt
Field google.cloud.tasks.v2beta3.Task.last_attempt
-
name
Field google.cloud.tasks.v2beta3.Task.name
-
response_count
Field google.cloud.tasks.v2beta3.Task.response_count
-
schedule_time
Field google.cloud.tasks.v2beta3.Task.schedule_time
-
view
Field google.cloud.tasks.v2beta3.Task.view
-
-
class
google.cloud.tasks_v2beta3.types.
TestIamPermissionsRequest
# Request message for
TestIamPermissions
method.-
resource
# REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
-
permissions
# The set of permissions to check for the
resource
. Permissions with wildcards (such as ‘*’ or ’storage.*’) are not allowed. For more information see IAM Overview.
-
permissions
Field google.iam.v1.TestIamPermissionsRequest.permissions
-
resource
Field google.iam.v1.TestIamPermissionsRequest.resource
-
-
class
google.cloud.tasks_v2beta3.types.
TestIamPermissionsResponse
# Response message for
TestIamPermissions
method.-
permissions
# A subset of
TestPermissionsRequest.permissions
that the caller is allowed.
-
permissions
Field google.iam.v1.TestIamPermissionsResponse.permissions
-
-
class
google.cloud.tasks_v2beta3.types.
Timestamp
# -
nanos
# Field google.protobuf.Timestamp.nanos
-
seconds
# Field google.protobuf.Timestamp.seconds
-
-
class
google.cloud.tasks_v2beta3.types.
UpdateQueueRequest
# Request message for [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue].
-
queue
# 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.
-
update_mask
# A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated.
-
queue
Field google.cloud.tasks.v2beta3.UpdateQueueRequest.queue
-
update_mask
Field google.cloud.tasks.v2beta3.UpdateQueueRequest.update_mask
-