Package-Level Type Names (total 39, in which 36 are exported)
/* sort exporteds by: | */
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.v2.AppEngineHttpRequest] requires
[`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
Google IAM permission for the project
and the following scope:
`https://www.googleapis.com/auth/cloud-platform`
The task will be delivered to the App Engine app which belongs to the same
project as the queue. For more information, see
[How Requests are
Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
and how routing is affected by
[dispatch
files](https://cloud.google.com/appengine/docs/python/config/dispatchref).
Traffic is encrypted during transport and never leaves Google datacenters.
Because this traffic is carried over a communication mechanism internal to
Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS).
The request to the handler, however, will appear to have used the HTTP
protocol.
The [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] used to construct the URL that the task is
delivered to can be set at the queue-level or task-level:
* If [app_engine_routing_override is set on the
queue][Queue.app_engine_routing_override], this value is used for all
tasks in the queue, no matter what the setting is for the [task-level
app_engine_routing][AppEngineHttpRequest.app_engine_routing].
The `url` that the task will be sent to is:
* `url =` [host][google.cloud.tasks.v2.AppEngineRouting.host] `+`
[relative_uri][google.cloud.tasks.v2.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.v2.Task.dispatch_deadline]. Failed
tasks will be retried according to the
[retry configuration][google.cloud.tasks.v2.Queue.retry_config]. `503` (Service Unavailable) is
considered an App Engine system error instead of an application error and
will cause Cloud Tasks' traffic congestion control to temporarily throttle
the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
Requests) response from an app handler does not cause traffic congestion
control to throttle the queue.
Task-level setting for App Engine routing.
* If [app_engine_routing_override is set on the
queue][Queue.app_engine_routing_override], this value is used for all
tasks in the queue, no matter what the setting is for the [task-level
app_engine_routing][AppEngineHttpRequest.app_engine_routing].
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.v2.HttpMethod].
HTTP request headers.
This map contains the header field names and values.
Headers can be set when the
[task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
Repeated headers are not supported but a header value can contain commas.
Cloud Tasks sets some headers to default values:
* `User-Agent`: By default, this header is
`"AppEngine-Google; (+http://code.google.com/appengine)"`.
This header can be modified, but Cloud Tasks will append
`"AppEngine-Google; (+http://code.google.com/appengine)"` to the
modified `User-Agent`.
If the task has a [body][google.cloud.tasks.v2.AppEngineHttpRequest.body], Cloud
Tasks sets the following headers:
* `Content-Type`: By default, the `Content-Type` header is set to
`"application/octet-stream"`. The default can be overridden by explicitly
setting `Content-Type` to a particular media type when the
[task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
For example, `Content-Type` can be set to `"application/json"`.
* `Content-Length`: This is computed by Cloud Tasks. This value is
output only. It cannot be changed.
The headers below cannot be set or overridden:
* `Host`
* `X-Google-*`
* `X-AppEngine-*`
In addition, Cloud Tasks sets some headers when the task is dispatched,
such as headers containing information about the task; see
[request
headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers).
These headers are set only when the task is dispatched, so they are not
visible when the task is returned in a Cloud Tasks response.
Although there is no specific limit for the maximum number of headers or
the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2.Task]. For more
information, see the [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation.
The HTTP method to use for the request. The default is POST.
The app's request handler for the task's target URL must be able to handle
HTTP requests with this http_method, otherwise the task attempt will fail
with error code 405 (Method Not Allowed). See
[Writing a push task request
handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
and the documentation for the request handlers in the language your app is
written in e.g.
[Python Request
Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
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.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use AppEngineHttpRequest.ProtoReflect.Descriptor instead.
(*T) GetAppEngineRouting() *AppEngineRouting(*T) GetBody() []byte(*T) GetHeaders() map[string]string(*T) GetHttpMethod() HttpMethod(*T) GetRelativeUri() string(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*Task).GetAppEngineHttpRequest() *AppEngineHttpRequest
App Engine Routing.
Defines routing characteristics specific to App Engine - service, version,
and instance.
For more information about services, versions, and instances see
[An Overview of App
Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
[Microservices Architecture on Google App
Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
[App Engine Standard request
routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
and [App Engine Flex request
routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
Using [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] 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`
Output only. The host that the task is sent to.
The host is constructed from the domain name of the app associated with
the queue's project ID (for example <app-id>.appspot.com), and the
[service][google.cloud.tasks.v2.AppEngineRouting.service], [version][google.cloud.tasks.v2.AppEngineRouting.version],
and [instance][google.cloud.tasks.v2.AppEngineRouting.instance]. Tasks which were created using
the App Engine SDK might have a custom domain name.
For more information, see
[How Requests are
Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
App instance.
By default, the task is sent to an instance which is available when
the task is attempted.
Requests can only be sent to a specific instance if
[manual scaling is used in App Engine
Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
App Engine Flex does not support instances. For more information, see
[App Engine Standard request
routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
and [App Engine Flex request
routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
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.v2.AppEngineRouting.host] is not parsable
into [service][google.cloud.tasks.v2.AppEngineRouting.service],
[version][google.cloud.tasks.v2.AppEngineRouting.version], and
[instance][google.cloud.tasks.v2.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.v2.AppEngineRouting.host] is not parsable, then
[service][google.cloud.tasks.v2.AppEngineRouting.service],
[version][google.cloud.tasks.v2.AppEngineRouting.version], and
[instance][google.cloud.tasks.v2.AppEngineRouting.instance] are the empty 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][google.cloud.tasks.v2.AppEngineRouting.host] is not parsable
into [service][google.cloud.tasks.v2.AppEngineRouting.service],
[version][google.cloud.tasks.v2.AppEngineRouting.version], and
[instance][google.cloud.tasks.v2.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.v2.AppEngineRouting.host] is not parsable, then
[service][google.cloud.tasks.v2.AppEngineRouting.service],
[version][google.cloud.tasks.v2.AppEngineRouting.version], and
[instance][google.cloud.tasks.v2.AppEngineRouting.instance] are the empty string.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use AppEngineRouting.ProtoReflect.Descriptor instead.
(*T) GetHost() string(*T) GetInstance() string(*T) GetService() string(*T) GetVersion() string(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*AppEngineHttpRequest).GetAppEngineRouting() *AppEngineRouting
func (*Queue).GetAppEngineRoutingOverride() *AppEngineRouting
CloudTasksClient is the client API for CloudTasks service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
Creates a queue.
Queues created with this method allow tasks to live for a maximum of 31
days. After a task is 31 days old, the task will be deleted regardless of whether
it was dispatched or not.
WARNING: Using this method may have unintended side effects if you are
using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
Read
[Overview of Queue Management and
queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
this method.
Creates a task and adds it to a queue.
Tasks cannot be updated after creation; there is no UpdateTask command.
* The maximum task size is 100KB.
Deletes a queue.
This command will delete the queue even if it has tasks in it.
Note: If you delete a queue, a queue with the same name can't be created
for 7 days.
WARNING: Using this method may have unintended side effects if you are
using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
Read
[Overview of Queue Management and
queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
this method.
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.
Gets the access control policy for a [Queue][google.cloud.tasks.v2.Queue].
Returns an empty policy if the resource exists and does not have a policy
set.
Authorization requires the following
[Google IAM](https://cloud.google.com/iam) permission on the specified
resource parent:
* `cloudtasks.queues.getIamPolicy`
Gets a queue.
Gets a task.
Lists queues.
Queues are returned in lexicographical order.
Lists the tasks in a queue.
By default, only the [BASIC][google.cloud.tasks.v2.Task.View.BASIC] view is retrieved
due to performance considerations;
[response_view][google.cloud.tasks.v2.ListTasksRequest.response_view] controls the
subset of information which is returned.
The tasks may be returned in any order. The ordering may change at any
time.
Pauses the queue.
If a queue is paused then the system will stop dispatching tasks
until the queue is resumed via
[ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue]. Tasks can still be added
when the queue is paused. A queue is paused if its
[state][google.cloud.tasks.v2.Queue.state] is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
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.
Resume a queue.
This method resumes a queue after it has been
[PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED] or
[DISABLED][google.cloud.tasks.v2.Queue.State.DISABLED]. The state of a queue is stored
in the queue's [state][google.cloud.tasks.v2.Queue.state]; after calling this method it
will be set to [RUNNING][google.cloud.tasks.v2.Queue.State.RUNNING].
WARNING: Resuming many high-QPS queues at the same time can
lead to target overloading. If you are resuming high-QPS
queues, follow the 500/50/5 pattern described in
[Managing Cloud Tasks Scaling
Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
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 [RateLimits][google.cloud.tasks.v2.RateLimits] or
is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
This command is meant to be used for manual debugging. For
example, [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] can be used to retry a failed
task after a fix has been made or to manually force a task to be
dispatched now.
The dispatched task is returned. That is, the task that is returned
contains the [status][Task.status] after the task is dispatched but
before the task is received by its target.
If Cloud Tasks receives a successful response from the task's
target, then the task will be deleted; otherwise the task's
[schedule_time][google.cloud.tasks.v2.Task.schedule_time] will be reset to the time that
[RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] was called plus the retry delay specified
in the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig].
[RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] returns
[NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
task that has already succeeded or permanently failed.
Sets the access control policy for a [Queue][google.cloud.tasks.v2.Queue]. Replaces any existing
policy.
Note: The Cloud Console does not check queue-level IAM permissions yet.
Project-level permissions are required to use the Cloud Console.
Authorization requires the following
[Google IAM](https://cloud.google.com/iam) permission on the specified
resource parent:
* `cloudtasks.queues.setIamPolicy`
Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2.Queue].
If the resource does not exist, this will return an empty set of
permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
Note: This operation is designed to be used for building permission-aware
UIs and command-line tools, not for authorization checking. This operation
may "fail open" without warning.
Updates a queue.
This method creates the queue if it does not exist and updates
the queue if it does exist.
Queues created with this method allow tasks to live for a maximum of 31
days. After a task is 31 days old, the task will be deleted regardless of whether
it was dispatched or not.
WARNING: Using this method may have unintended side effects if you are
using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
Read
[Overview of Queue Management and
queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
this method.
*cloudTasksClient
T : google.golang.org/genproto/googleapis/iam/v1.IAMPolicyClient
func NewCloudTasksClient(cc grpc.ClientConnInterface) CloudTasksClient
CloudTasksServer is the server API for CloudTasks service.
Creates a queue.
Queues created with this method allow tasks to live for a maximum of 31
days. After a task is 31 days old, the task will be deleted regardless of whether
it was dispatched or not.
WARNING: Using this method may have unintended side effects if you are
using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
Read
[Overview of Queue Management and
queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
this method.
Creates a task and adds it to a queue.
Tasks cannot be updated after creation; there is no UpdateTask command.
* The maximum task size is 100KB.
Deletes a queue.
This command will delete the queue even if it has tasks in it.
Note: If you delete a queue, a queue with the same name can't be created
for 7 days.
WARNING: Using this method may have unintended side effects if you are
using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
Read
[Overview of Queue Management and
queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
this method.
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.
Gets the access control policy for a [Queue][google.cloud.tasks.v2.Queue].
Returns an empty policy if the resource exists and does not have a policy
set.
Authorization requires the following
[Google IAM](https://cloud.google.com/iam) permission on the specified
resource parent:
* `cloudtasks.queues.getIamPolicy`
Gets a queue.
Gets a task.
Lists queues.
Queues are returned in lexicographical order.
Lists the tasks in a queue.
By default, only the [BASIC][google.cloud.tasks.v2.Task.View.BASIC] view is retrieved
due to performance considerations;
[response_view][google.cloud.tasks.v2.ListTasksRequest.response_view] controls the
subset of information which is returned.
The tasks may be returned in any order. The ordering may change at any
time.
Pauses the queue.
If a queue is paused then the system will stop dispatching tasks
until the queue is resumed via
[ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue]. Tasks can still be added
when the queue is paused. A queue is paused if its
[state][google.cloud.tasks.v2.Queue.state] is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
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.
Resume a queue.
This method resumes a queue after it has been
[PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED] or
[DISABLED][google.cloud.tasks.v2.Queue.State.DISABLED]. The state of a queue is stored
in the queue's [state][google.cloud.tasks.v2.Queue.state]; after calling this method it
will be set to [RUNNING][google.cloud.tasks.v2.Queue.State.RUNNING].
WARNING: Resuming many high-QPS queues at the same time can
lead to target overloading. If you are resuming high-QPS
queues, follow the 500/50/5 pattern described in
[Managing Cloud Tasks Scaling
Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
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 [RateLimits][google.cloud.tasks.v2.RateLimits] or
is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
This command is meant to be used for manual debugging. For
example, [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] can be used to retry a failed
task after a fix has been made or to manually force a task to be
dispatched now.
The dispatched task is returned. That is, the task that is returned
contains the [status][Task.status] after the task is dispatched but
before the task is received by its target.
If Cloud Tasks receives a successful response from the task's
target, then the task will be deleted; otherwise the task's
[schedule_time][google.cloud.tasks.v2.Task.schedule_time] will be reset to the time that
[RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] was called plus the retry delay specified
in the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig].
[RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] returns
[NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
task that has already succeeded or permanently failed.
Sets the access control policy for a [Queue][google.cloud.tasks.v2.Queue]. Replaces any existing
policy.
Note: The Cloud Console does not check queue-level IAM permissions yet.
Project-level permissions are required to use the Cloud Console.
Authorization requires the following
[Google IAM](https://cloud.google.com/iam) permission on the specified
resource parent:
* `cloudtasks.queues.setIamPolicy`
Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2.Queue].
If the resource does not exist, this will return an empty set of
permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
Note: This operation is designed to be used for building permission-aware
UIs and command-line tools, not for authorization checking. This operation
may "fail open" without warning.
Updates a queue.
This method creates the queue if it does not exist and updates
the queue if it does exist.
Queues created with this method allow tasks to live for a maximum of 31
days. After a task is 31 days old, the task will be deleted regardless of whether
it was dispatched or not.
WARNING: Using this method may have unintended side effects if you are
using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
Read
[Overview of Queue Management and
queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
this method.
*UnimplementedCloudTasksServer
T : google.golang.org/genproto/googleapis/iam/v1.IAMPolicyServer
func RegisterCloudTasksServer(s *grpc.Server, srv CloudTasksServer)
Request message for [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask].
Required. The queue name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
The queue must already exist.
The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be
returned.
By default response_view is [BASIC][google.cloud.tasks.v2.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.v2.Task.View.FULL] requires
`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
permission on the [Task][google.cloud.tasks.v2.Task] resource.
Required. The task to add.
Task names have the following format:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
The user can optionally specify a task [name][google.cloud.tasks.v2.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.v2.Task.name].
If [schedule_time][google.cloud.tasks.v2.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.v2.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.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use CreateTaskRequest.ProtoReflect.Descriptor instead.
(*T) GetParent() string(*T) GetResponseView() Task_View(*T) GetTask() *Task(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func golang.org/x/pkgsite/internal/queue.(*GCP).newTaskRequest(modulePath, version, suffix string, disableProxyFetch bool) *CreateTaskRequest
func CloudTasksClient.CreateTask(ctx context.Context, in *CreateTaskRequest, opts ...grpc.CallOption) (*Task, error)
func CloudTasksServer.CreateTask(context.Context, *CreateTaskRequest) (*Task, error)
func (*UnimplementedCloudTasksServer).CreateTask(context.Context, *CreateTaskRequest) (*Task, error)
func cloud.google.com/go/cloudtasks/apiv2.(*Client).CreateTask(ctx context.Context, req *CreateTaskRequest, opts ...gax.CallOption) (*Task, error)
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][google.cloud.tasks.v2.Queue.retry_config],
[rate limits][google.cloud.tasks.v2.Queue.rate_limits], and the [queue's state][google.cloud.tasks.v2.Queue.state].
* System throttling: To prevent the worker from overloading, Cloud Tasks may
temporarily reduce the queue's effective rate. User-specified settings
will not be changed.
System throttling happens because:
* Cloud Tasks backs off on all errors. Normally the backoff specified in
[rate limits][google.cloud.tasks.v2.Queue.rate_limits] will be used. But if the worker returns
`429` (Too Many Requests), `503` (Service Unavailable), or the rate of
errors is high, Cloud Tasks will use a higher backoff rate. The retry
specified in the `Retry-After` HTTP response header is considered.
* To prevent traffic spikes and to smooth sudden increases in traffic,
dispatches ramp up slowly when the queue is newly created or idle and
if large numbers of tasks suddenly become available to dispatch (due to
spikes in create task rates, the queue being unpaused, or many tasks
that are scheduled at the same time).
The mode for generating an `Authorization` header for HTTP requests.
If specified, all `Authorization` headers in the [HttpRequest.headers][google.cloud.tasks.v2.HttpRequest.headers]
field will be overridden.
Types that are assignable to AuthorizationHeader:
*HttpRequest_OauthToken
*HttpRequest_OidcToken
HTTP request body.
A request body is allowed only if the
[HTTP method][google.cloud.tasks.v2.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.v2.HttpMethod].
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.v2.HttpRequest.url].
* Content-Length: This will be computed by Cloud Tasks.
* User-Agent: This will be set to `"Google-Cloud-Tasks"`.
* X-Google-*: Google use only.
* X-AppEngine-*: Google use only.
`Content-Type` won't be set by Cloud Tasks. You can explicitly set
`Content-Type` to a media type when the
[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.
The HTTP method to use for the request. The default is POST.
Required. The full url path that the request will be sent to.
This string must begin with either "http://" or "https://". Some examples
are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
encode some characters for safety and compatibility. The maximum allowed
URL length is 2083 characters after encoding.
The `Location` header response from a redirect response [`300` - `399`]
may be followed. The redirect is not counted as a separate attempt.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use HttpRequest.ProtoReflect.Descriptor instead.
(*T) GetAuthorizationHeader() isHttpRequest_AuthorizationHeader(*T) GetBody() []byte(*T) GetHeaders() map[string]string(*T) GetHttpMethod() HttpMethod(*T) GetOauthToken() *OAuthToken(*T) GetOidcToken() *OidcToken(*T) GetUrl() string(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*Task).GetHttpRequest() *HttpRequest
If specified, an
[OAuth token](https://developers.google.com/identity/protocols/OAuth2)
will be generated and attached as an `Authorization` header in the HTTP
request.
This type of authorization should generally only be used when calling
Google APIs hosted on *.googleapis.com.
(*T) isHttpRequest_AuthorizationHeader()
*T : isHttpRequest_AuthorizationHeader
If specified, an
[OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
token will be generated and attached as an `Authorization` header in the
HTTP request.
This type of authorization can be used for many scenarios, including
calling Cloud Run, or endpoints where you intend to validate the token
yourself.
(*T) isHttpRequest_AuthorizationHeader()
*T : isHttpRequest_AuthorizationHeader
Request message for [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues].
`filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2.Queue]
field can be used as a filter and several operators as supported.
For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
described in
[Stackdriver's Advanced Logs
Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
Sample filter "state: PAUSED".
Note that using filters might cause fewer queues than the
requested page_size to be returned.
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.v2.ListQueuesResponse.next_page_token] in the
response to determine if more queues exist.
A token identifying the page of results to return.
To request the first page results, page_token must be empty. To
request the next page of results, page_token must be the value of
[next_page_token][google.cloud.tasks.v2.ListQueuesResponse.next_page_token] returned
from the previous call to [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues]
method. It is an error to switch the value of the
[filter][google.cloud.tasks.v2.ListQueuesRequest.filter] while iterating through pages.
Required. The location name.
For example: `projects/PROJECT_ID/locations/LOCATION_ID`
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use ListQueuesRequest.ProtoReflect.Descriptor instead.
(*T) GetFilter() string(*T) GetPageSize() int32(*T) GetPageToken() string(*T) GetParent() string(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func CloudTasksClient.ListQueues(ctx context.Context, in *ListQueuesRequest, opts ...grpc.CallOption) (*ListQueuesResponse, error)
func CloudTasksServer.ListQueues(context.Context, *ListQueuesRequest) (*ListQueuesResponse, error)
func (*UnimplementedCloudTasksServer).ListQueues(context.Context, *ListQueuesRequest) (*ListQueuesResponse, error)
func cloud.google.com/go/cloudtasks/apiv2.(*Client).ListQueues(ctx context.Context, req *ListQueuesRequest, opts ...gax.CallOption) *cloudtasks.QueueIterator
Request message for listing tasks using [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
Maximum page size.
Fewer tasks than requested might be returned, even if more tasks exist; use
[next_page_token][google.cloud.tasks.v2.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.
A token identifying the page of results to return.
To request the first page results, page_token must be empty. To
request the next page of results, page_token must be the value of
[next_page_token][google.cloud.tasks.v2.ListTasksResponse.next_page_token] returned
from the previous call to [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks]
method.
The page token is valid for only 2 hours.
Required. The queue name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be
returned.
By default response_view is [BASIC][google.cloud.tasks.v2.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.v2.Task.View.FULL] requires
`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
permission on the [Task][google.cloud.tasks.v2.Task] resource.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use ListTasksRequest.ProtoReflect.Descriptor instead.
(*T) GetPageSize() int32(*T) GetPageToken() string(*T) GetParent() string(*T) GetResponseView() Task_View(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func CloudTasksClient.ListTasks(ctx context.Context, in *ListTasksRequest, opts ...grpc.CallOption) (*ListTasksResponse, error)
func CloudTasksServer.ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)
func (*UnimplementedCloudTasksServer).ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)
func cloud.google.com/go/cloudtasks/apiv2.(*Client).ListTasks(ctx context.Context, req *ListTasksRequest, opts ...gax.CallOption) *cloudtasks.TaskIterator
Contains information needed for generating an
[OAuth token](https://developers.google.com/identity/protocols/OAuth2).
This type of authorization should generally only be used when calling Google
APIs hosted on *.googleapis.com.
OAuth scope to be used for generating OAuth access token.
If not specified, "https://www.googleapis.com/auth/cloud-platform"
will be used.
[Service account email](https://cloud.google.com/iam/docs/service-accounts)
to be used for generating OAuth token.
The service account must be within the same project as the queue. The
caller must have iam.serviceAccounts.actAs permission for the service
account.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use OAuthToken.ProtoReflect.Descriptor instead.
(*T) GetScope() string(*T) GetServiceAccountEmail() string(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*HttpRequest).GetOauthToken() *OAuthToken
Contains information needed for generating an
[OpenID Connect
token](https://developers.google.com/identity/protocols/OpenIDConnect).
This type of authorization can be used for many scenarios, including
calling Cloud Run, or endpoints where you intend to validate the token
yourself.
Audience to be used when generating OIDC token. If not specified, the URI
specified in target will be used.
[Service account email](https://cloud.google.com/iam/docs/service-accounts)
to be used for generating OIDC token.
The service account must be within the same project as the queue. The
caller must have iam.serviceAccounts.actAs permission for the service
account.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use OidcToken.ProtoReflect.Descriptor instead.
(*T) GetAudience() string(*T) GetServiceAccountEmail() string(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*HttpRequest).GetOidcToken() *OidcToken
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.v2.CloudTasks.RunTask], will run a task
even if the queue has reached its [RateLimits][google.cloud.tasks.v2.RateLimits].
Output only. The max burst size.
Max burst size limits how fast tasks in queue are processed when
many tasks are in the queue and the rate is high. This field
allows the queue to have a high rate so processing starts shortly
after a task is enqueued, but still limits resource usage when
many tasks are enqueued in a short period of time.
The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
algorithm is used to control the rate of task dispatches. Each
queue has a token bucket that holds tokens, up to the maximum
specified by `max_burst_size`. Each time a task is dispatched, a
token is removed from the bucket. Tasks will be dispatched until
the queue's bucket runs out of tokens. The bucket will be
continuously refilled with new tokens based on
[max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second].
Cloud Tasks will pick the value of `max_burst_size` based on the
value of
[max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second].
For queues that were created or updated using
`queue.yaml/xml`, `max_burst_size` is equal to
[bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
Since `max_burst_size` is output only, if
[UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] is called on a queue
created by `queue.yaml/xml`, `max_burst_size` will be reset based
on the value of
[max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second],
regardless of whether
[max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second]
is updated.
The maximum number of concurrent tasks that Cloud Tasks allows
to be dispatched for this queue. After this threshold has been
reached, Cloud Tasks stops dispatching tasks until the number of
concurrent requests decreases.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
The maximum allowed value is 5,000.
This field has the same meaning as
[max_concurrent_requests in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
The maximum rate at which tasks are dispatched from this queue.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
* The maximum allowed value is 500.
This field has the same meaning as
[rate in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use RateLimits.ProtoReflect.Descriptor instead.
(*T) GetMaxBurstSize() int32(*T) GetMaxConcurrentDispatches() int32(*T) GetMaxDispatchesPerSecond() float64(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*Queue).GetRateLimits() *RateLimits
Retry config.
These settings determine when a failed task attempt is retried.
Number of attempts per task.
Cloud Tasks will attempt the task `max_attempts` times (that is, if the
first attempt fails, then there will be `max_attempts - 1` retries). Must
be >= -1.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
-1 indicates unlimited attempts.
This field has the same meaning as
[task_retry_limit in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for retry between
[min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] and
[max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration after it fails,
if the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task should be
retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
`max_backoff` will be truncated to the nearest second.
This field has the same meaning as
[max_backoff_seconds in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
The time between retries will double `max_doublings` times.
A task's retry interval starts at
[min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff], then doubles
`max_doublings` times, then increases linearly, and finally
retries retries at intervals of
[max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] up to
[max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times.
For example, if [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] is 10s,
[max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] is 300s, and
`max_doublings` is 3, then the a task will first be retried in
10s. The retry interval will double three times, and then
increase linearly by 2^3 * 10s. Finally, the task will retry at
intervals of [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] until the
task has been attempted [max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts]
times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
240s, 300s, 300s, ....
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field has the same meaning as
[max_doublings in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
If positive, `max_retry_duration` specifies the time limit for
retrying a failed task, measured from when the task was first
attempted. Once `max_retry_duration` time has passed *and* the
task has been attempted [max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts]
times, no further attempts will be made and the task will be
deleted.
If zero, then the task age is unlimited.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
`max_retry_duration` will be truncated to the nearest second.
This field has the same meaning as
[task_age_limit in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for retry between
[min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] and
[max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration after it fails,
if the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task should be
retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
`min_backoff` will be truncated to the nearest second.
This field has the same meaning as
[min_backoff_seconds in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use RetryConfig.ProtoReflect.Descriptor instead.
(*T) GetMaxAttempts() int32(*T) GetMaxBackoff() *durationpb.Duration(*T) GetMaxDoublings() int32(*T) GetMaxRetryDuration() *durationpb.Duration(*T) GetMinBackoff() *durationpb.Duration(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*Queue).GetRetryConfig() *RetryConfig
A unit of scheduled work.
Output only. The time that the task was created.
`create_time` will be truncated to the nearest second.
Output only. The number of attempts dispatched.
This count includes attempts which have been dispatched but haven't
received a response.
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.v2.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.v2.HttpRequest], the default is 10 minutes. The deadline
must be in the interval [15 seconds, 30 minutes].
* For [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest], 0 indicates that the
request has the default deadline. The default deadline depends on the
[scaling
type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
of the service: 10 minutes for standard apps with automatic scaling, 24
hours for standard apps with manual and basic scaling, and 60 minutes for
flex apps. If the request deadline is set, it must be in the interval [15
seconds, 24 hours 15 seconds]. Regardless of the task's
`dispatch_deadline`, the app handler will not run for longer than than
the service's timeout. We recommend setting the `dispatch_deadline` to
at most a few seconds more than the app handler's timeout. For more
information see
[Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
`dispatch_deadline` will be truncated to the nearest millisecond. The
deadline is an approximate deadline.
Output only. The status of the task's first attempt.
Only [dispatch_time][google.cloud.tasks.v2.Attempt.dispatch_time] will be set.
The other [Attempt][google.cloud.tasks.v2.Attempt] information is not retained by Cloud Tasks.
Output only. The status of the task's last attempt.
Required. The message to send to the worker.
Types that are assignable to MessageType:
*Task_AppEngineHttpRequest
*Task_HttpRequest
Optionally caller-specified in [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask].
The task name.
The task name must have the following format:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
hyphens (-), colons (:), or periods (.).
For more information, see
[Identifying
projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
* `LOCATION_ID` is the canonical ID for the task's location.
The list of available locations can be obtained by calling
[ListLocations][google.cloud.location.Locations.ListLocations].
For more information, see https://cloud.google.com/about/locations/.
* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
hyphens (-). The maximum length is 100 characters.
* `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
hyphens (-), or underscores (_). The maximum length is 500 characters.
Output only. The number of attempts which have received a response.
The time when the task is scheduled to be attempted or retried.
`schedule_time` will be truncated to the nearest microsecond.
Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2.Task] has
been returned.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use Task.ProtoReflect.Descriptor instead.
(*T) GetAppEngineHttpRequest() *AppEngineHttpRequest(*T) GetCreateTime() *timestamppb.Timestamp(*T) GetDispatchCount() int32(*T) GetDispatchDeadline() *durationpb.Duration(*T) GetFirstAttempt() *Attempt(*T) GetHttpRequest() *HttpRequest(*T) GetLastAttempt() *Attempt(*T) GetMessageType() isTask_MessageType(*T) GetName() string(*T) GetResponseCount() int32(*T) GetScheduleTime() *timestamppb.Timestamp(*T) GetView() Task_View(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func CloudTasksClient.CreateTask(ctx context.Context, in *CreateTaskRequest, opts ...grpc.CallOption) (*Task, error)
func CloudTasksClient.GetTask(ctx context.Context, in *GetTaskRequest, opts ...grpc.CallOption) (*Task, error)
func CloudTasksClient.RunTask(ctx context.Context, in *RunTaskRequest, opts ...grpc.CallOption) (*Task, error)
func CloudTasksServer.CreateTask(context.Context, *CreateTaskRequest) (*Task, error)
func CloudTasksServer.GetTask(context.Context, *GetTaskRequest) (*Task, error)
func CloudTasksServer.RunTask(context.Context, *RunTaskRequest) (*Task, error)
func (*CreateTaskRequest).GetTask() *Task
func (*ListTasksResponse).GetTasks() []*Task
func (*UnimplementedCloudTasksServer).CreateTask(context.Context, *CreateTaskRequest) (*Task, error)
func (*UnimplementedCloudTasksServer).GetTask(context.Context, *GetTaskRequest) (*Task, error)
func (*UnimplementedCloudTasksServer).RunTask(context.Context, *RunTaskRequest) (*Task, error)
func cloud.google.com/go/cloudtasks/apiv2.(*Client).CreateTask(ctx context.Context, req *CreateTaskRequest, opts ...gax.CallOption) (*Task, error)
func cloud.google.com/go/cloudtasks/apiv2.(*Client).GetTask(ctx context.Context, req *GetTaskRequest, opts ...gax.CallOption) (*Task, error)
func cloud.google.com/go/cloudtasks/apiv2.(*Client).RunTask(ctx context.Context, req *RunTaskRequest, opts ...gax.CallOption) (*Task, error)
func cloud.google.com/go/cloudtasks/apiv2.(*TaskIterator).Next() (*Task, error)
HTTP request that is sent to the App Engine app handler.
An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest] set.
(*T) isTask_MessageType()
*T : isTask_MessageType
HTTP request that is sent to the worker.
An HTTP task is a task that has [HttpRequest][google.cloud.tasks.v2.HttpRequest] set.
(*T) isTask_MessageType()
*T : isTask_MessageType
Package-Level Constants (total 15, all are exported)
HTTP DELETE
HTTP GET
HTTP HEAD
HTTP method unspecified
HTTP OPTIONS
HTTP PATCH
HTTP POST
HTTP PUT
The queue is disabled.
A queue becomes `DISABLED` when
[queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref)
or
[queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref)
is uploaded which does not contain the queue. You cannot directly disable
a queue.
When a queue is disabled, tasks can still be added to a queue
but the tasks are not dispatched.
To permanently delete this queue and all of its tasks, call
[DeleteQueue][google.cloud.tasks.v2.CloudTasks.DeleteQueue].
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.
The queue is running. Tasks can be dispatched.
If the queue was created using Cloud Tasks and the queue has
had no activity (method calls or task dispatches) for 30 days,
the queue may take a few minutes to re-activate. Some method
calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and
tasks may not be dispatched for a few minutes until the queue
has been re-activated.
Unspecified state.
The basic view omits fields which can be large or can contain
sensitive data.
This view does not include the
[body in AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest.body].
Bodies are desirable to return only when needed, because they
can be large and because of the sensitivity of the data that you
choose to store in it.
All information is returned.
Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires
`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
permission on the [Queue][google.cloud.tasks.v2.Queue] resource.
Unspecified. Defaults to BASIC.
The pages are generated with Goldsv0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.