Variables
Queue_State_name, Queue_State_value
var
(
Queue_State_name
=
map
[
int32
]
string
{
0
:
"STATE_UNSPECIFIED"
,
1
:
"RUNNING"
,
2
:
"PAUSED"
,
3
:
"DISABLED"
,
}
Queue_State_value
=
map
[
string
]
int32
{
"STATE_UNSPECIFIED"
:
0
,
"RUNNING"
:
1
,
"PAUSED"
:
2
,
"DISABLED"
:
3
,
}
)
Enum value maps for Queue_State.
HttpMethod_name, HttpMethod_value
var
(
HttpMethod_name
=
map
[
int32
]
string
{
0
:
"HTTP_METHOD_UNSPECIFIED"
,
1
:
"POST"
,
2
:
"GET"
,
3
:
"HEAD"
,
4
:
"PUT"
,
5
:
"DELETE"
,
6
:
"PATCH"
,
7
:
"OPTIONS"
,
}
HttpMethod_value
=
map
[
string
]
int32
{
"HTTP_METHOD_UNSPECIFIED"
:
0
,
"POST"
:
1
,
"GET"
:
2
,
"HEAD"
:
3
,
"PUT"
:
4
,
"DELETE"
:
5
,
"PATCH"
:
6
,
"OPTIONS"
:
7
,
}
)
Enum value maps for HttpMethod.
Task_View_name, Task_View_value
var
(
Task_View_name
=
map
[
int32
]
string
{
0
:
"VIEW_UNSPECIFIED"
,
1
:
"BASIC"
,
2
:
"FULL"
,
}
Task_View_value
=
map
[
string
]
int32
{
"VIEW_UNSPECIFIED"
:
0
,
"BASIC"
:
1
,
"FULL"
:
2
,
}
)
Enum value maps for Task_View.
File_google_cloud_tasks_v2_cloudtasks_proto
var
File_google_cloud_tasks_v2_cloudtasks_proto
protoreflect
.
FileDescriptor
File_google_cloud_tasks_v2_queue_proto
var
File_google_cloud_tasks_v2_queue_proto
protoreflect
.
FileDescriptor
File_google_cloud_tasks_v2_target_proto
var
File_google_cloud_tasks_v2_target_proto
protoreflect
.
FileDescriptor
File_google_cloud_tasks_v2_task_proto
var
File_google_cloud_tasks_v2_task_proto
protoreflect
.
FileDescriptor
Functions
func RegisterCloudTasksServer
func
RegisterCloudTasksServer
(
s
*
grpc
.
Server
,
srv
CloudTasksServer
)
AppEngineHttpRequest
type
AppEngineHttpRequest
struct
{
HttpMethod
HttpMethod
""
/* 130 byte string literal not displayed */
AppEngineRouting
*
AppEngineRouting
`protobuf:"bytes,2,opt,name=app_engine_routing,json=appEngineRouting,proto3" json:"app_engine_routing,omitempty"`
RelativeUri
string
`protobuf:"bytes,3,opt,name=relative_uri,json=relativeUri,proto3" json:"relative_uri,omitempty"`
Headers
map
[
string
]
string
""
/* 155 byte string literal not displayed */
Body
[]
byte
`protobuf:"bytes,5,opt,name=body,proto3" json:"body,omitempty"`
}
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
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.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
.
Because tasks are not run as any user, they cannot be dispatched to URIs
restricted with login:
required
Task dispatches also do not follow redirects.
The task attempt has succeeded if the app's request handler returns an HTTP
response code in the range [ 200
- 299
]. The task attempt has failed if
the app's handler returns a non-2xx response code or Cloud Tasks does
not receive response before the [deadline][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.
func (*AppEngineHttpRequest) Descriptor
func
(
*
AppEngineHttpRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AppEngineHttpRequest.ProtoReflect.Descriptor instead.
func (*AppEngineHttpRequest) GetAppEngineRouting
func
(
x
*
AppEngineHttpRequest
)
GetAppEngineRouting
()
*
AppEngineRouting
func (*AppEngineHttpRequest) GetBody
func
(
x
*
AppEngineHttpRequest
)
GetBody
()
[]
byte
func (*AppEngineHttpRequest) GetHeaders
func
(
x
*
AppEngineHttpRequest
)
GetHeaders
()
map
[
string
]
string
func (*AppEngineHttpRequest) GetHttpMethod
func
(
x
*
AppEngineHttpRequest
)
GetHttpMethod
()
HttpMethod
func (*AppEngineHttpRequest) GetRelativeUri
func
(
x
*
AppEngineHttpRequest
)
GetRelativeUri
()
string
func (*AppEngineHttpRequest) ProtoMessage
func
(
*
AppEngineHttpRequest
)
ProtoMessage
()
func (*AppEngineHttpRequest) ProtoReflect
func
(
x
*
AppEngineHttpRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*AppEngineHttpRequest) Reset
func
(
x
*
AppEngineHttpRequest
)
Reset
()
func (*AppEngineHttpRequest) String
func
(
x
*
AppEngineHttpRequest
)
String
()
string
AppEngineRouting
type
AppEngineRouting
struct
{
// 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.
Service
string
`protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
// 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.
Version
string
`protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
// 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).
Instance
string
`protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
// 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 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 .
Using [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] requires appengine.applications.get
Google IAM permission for the project
and the following scope:
https://www.googleapis.com/auth/cloud-platform
func (*AppEngineRouting) Descriptor
func
(
*
AppEngineRouting
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AppEngineRouting.ProtoReflect.Descriptor instead.
func (*AppEngineRouting) GetHost
func
(
x
*
AppEngineRouting
)
GetHost
()
string
func (*AppEngineRouting) GetInstance
func
(
x
*
AppEngineRouting
)
GetInstance
()
string
func (*AppEngineRouting) GetService
func
(
x
*
AppEngineRouting
)
GetService
()
string
func (*AppEngineRouting) GetVersion
func
(
x
*
AppEngineRouting
)
GetVersion
()
string
func (*AppEngineRouting) ProtoMessage
func
(
*
AppEngineRouting
)
ProtoMessage
()
func (*AppEngineRouting) ProtoReflect
func
(
x
*
AppEngineRouting
)
ProtoReflect
()
protoreflect
.
Message
func (*AppEngineRouting) Reset
func
(
x
*
AppEngineRouting
)
Reset
()
func (*AppEngineRouting) String
func
(
x
*
AppEngineRouting
)
String
()
string
Attempt
type
Attempt
struct
{
// Output only. The time that this attempt was scheduled.
//
// `schedule_time` will be truncated to the nearest microsecond.
ScheduleTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,1,opt,name=schedule_time,json=scheduleTime,proto3" json:"schedule_time,omitempty"`
// Output only. The time that this attempt was dispatched.
//
// `dispatch_time` will be truncated to the nearest microsecond.
DispatchTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,2,opt,name=dispatch_time,json=dispatchTime,proto3" json:"dispatch_time,omitempty"`
// Output only. The time that this attempt response was received.
//
// `response_time` will be truncated to the nearest microsecond.
ResponseTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,3,opt,name=response_time,json=responseTime,proto3" json:"response_time,omitempty"`
// 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 the `response_status` field is meaningless.
ResponseStatus
*
status
.
Status
`protobuf:"bytes,4,opt,name=response_status,json=responseStatus,proto3" json:"response_status,omitempty"`
// contains filtered or unexported fields
}
The status of a task attempt.
func (*Attempt) Descriptor
Deprecated: Use Attempt.ProtoReflect.Descriptor instead.
func (*Attempt) GetDispatchTime
func
(
x
*
Attempt
)
GetDispatchTime
()
*
timestamppb
.
Timestamp
func (*Attempt) GetResponseStatus
func (*Attempt) GetResponseTime
func
(
x
*
Attempt
)
GetResponseTime
()
*
timestamppb
.
Timestamp
func (*Attempt) GetScheduleTime
func
(
x
*
Attempt
)
GetScheduleTime
()
*
timestamppb
.
Timestamp
func (*Attempt) ProtoMessage
func
(
*
Attempt
)
ProtoMessage
()
func (*Attempt) ProtoReflect
func
(
x
*
Attempt
)
ProtoReflect
()
protoreflect
.
Message
func (*Attempt) Reset
func
(
x
*
Attempt
)
Reset
()
func (*Attempt) String
CloudTasksClient
type
CloudTasksClient
interface
{
// Lists queues.
//
// Queues are returned in lexicographical order.
ListQueues
(
ctx
context
.
Context
,
in
*
ListQueuesRequest
,
opts
...
grpc
.
CallOption
)
(
*
ListQueuesResponse
,
error
)
// Gets a queue.
GetQueue
(
ctx
context
.
Context
,
in
*
GetQueueRequest
,
opts
...
grpc
.
CallOption
)
(
*
Queue
,
error
)
// 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.
CreateQueue
(
ctx
context
.
Context
,
in
*
CreateQueueRequest
,
opts
...
grpc
.
CallOption
)
(
*
Queue
,
error
)
// 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.
UpdateQueue
(
ctx
context
.
Context
,
in
*
UpdateQueueRequest
,
opts
...
grpc
.
CallOption
)
(
*
Queue
,
error
)
// 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.
DeleteQueue
(
ctx
context
.
Context
,
in
*
DeleteQueueRequest
,
opts
...
grpc
.
CallOption
)
(
*
emptypb
.
Empty
,
error
)
// 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.
PurgeQueue
(
ctx
context
.
Context
,
in
*
PurgeQueueRequest
,
opts
...
grpc
.
CallOption
)
(
*
Queue
,
error
)
// 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].
PauseQueue
(
ctx
context
.
Context
,
in
*
PauseQueueRequest
,
opts
...
grpc
.
CallOption
)
(
*
Queue
,
error
)
// 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).
ResumeQueue
(
ctx
context
.
Context
,
in
*
ResumeQueueRequest
,
opts
...
grpc
.
CallOption
)
(
*
Queue
,
error
)
// 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`
GetIamPolicy
(
ctx
context
.
Context
,
in
*
v1
.
GetIamPolicyRequest
,
opts
...
grpc
.
CallOption
)
(
*
v1
.
Policy
,
error
)
// 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`
SetIamPolicy
(
ctx
context
.
Context
,
in
*
v1
.
SetIamPolicyRequest
,
opts
...
grpc
.
CallOption
)
(
*
v1
.
Policy
,
error
)
// 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.
TestIamPermissions
(
ctx
context
.
Context
,
in
*
v1
.
TestIamPermissionsRequest
,
opts
...
grpc
.
CallOption
)
(
*
v1
.
TestIamPermissionsResponse
,
error
)
// 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.
ListTasks
(
ctx
context
.
Context
,
in
*
ListTasksRequest
,
opts
...
grpc
.
CallOption
)
(
*
ListTasksResponse
,
error
)
// Gets a task.
GetTask
(
ctx
context
.
Context
,
in
*
GetTaskRequest
,
opts
...
grpc
.
CallOption
)
(
*
Task
,
error
)
// 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.
CreateTask
(
ctx
context
.
Context
,
in
*
CreateTaskRequest
,
opts
...
grpc
.
CallOption
)
(
*
Task
,
error
)
// 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.
DeleteTask
(
ctx
context
.
Context
,
in
*
DeleteTaskRequest
,
opts
...
grpc
.
CallOption
)
(
*
emptypb
.
Empty
,
error
)
// 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.
RunTask
(
ctx
context
.
Context
,
in
*
RunTaskRequest
,
opts
...
grpc
.
CallOption
)
(
*
Task
,
error
)
}
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 .
func NewCloudTasksClient
func
NewCloudTasksClient
(
cc
grpc
.
ClientConnInterface
)
CloudTasksClient
CloudTasksServer
type
CloudTasksServer
interface
{
// Lists queues.
//
// Queues are returned in lexicographical order.
ListQueues
(
context
.
Context
,
*
ListQueuesRequest
)
(
*
ListQueuesResponse
,
error
)
// Gets a queue.
GetQueue
(
context
.
Context
,
*
GetQueueRequest
)
(
*
Queue
,
error
)
// 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.
CreateQueue
(
context
.
Context
,
*
CreateQueueRequest
)
(
*
Queue
,
error
)
// 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.
UpdateQueue
(
context
.
Context
,
*
UpdateQueueRequest
)
(
*
Queue
,
error
)
// 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.
DeleteQueue
(
context
.
Context
,
*
DeleteQueueRequest
)
(
*
emptypb
.
Empty
,
error
)
// 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.
PurgeQueue
(
context
.
Context
,
*
PurgeQueueRequest
)
(
*
Queue
,
error
)
// 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].
PauseQueue
(
context
.
Context
,
*
PauseQueueRequest
)
(
*
Queue
,
error
)
// 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).
ResumeQueue
(
context
.
Context
,
*
ResumeQueueRequest
)
(
*
Queue
,
error
)
// 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`
GetIamPolicy
(
context
.
Context
,
*
v1
.
GetIamPolicyRequest
)
(
*
v1
.
Policy
,
error
)
// 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`
SetIamPolicy
(
context
.
Context
,
*
v1
.
SetIamPolicyRequest
)
(
*
v1
.
Policy
,
error
)
// 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.
TestIamPermissions
(
context
.
Context
,
*
v1
.
TestIamPermissionsRequest
)
(
*
v1
.
TestIamPermissionsResponse
,
error
)
// 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.
ListTasks
(
context
.
Context
,
*
ListTasksRequest
)
(
*
ListTasksResponse
,
error
)
// Gets a task.
GetTask
(
context
.
Context
,
*
GetTaskRequest
)
(
*
Task
,
error
)
// 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.
CreateTask
(
context
.
Context
,
*
CreateTaskRequest
)
(
*
Task
,
error
)
// 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.
DeleteTask
(
context
.
Context
,
*
DeleteTaskRequest
)
(
*
emptypb
.
Empty
,
error
)
// 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.
RunTask
(
context
.
Context
,
*
RunTaskRequest
)
(
*
Task
,
error
)
}
CloudTasksServer is the server API for CloudTasks service.
CreateQueueRequest
type
CreateQueueRequest
struct
{
// Required. The location name in which the queue will be created.
// For example: `projects/PROJECT_ID/locations/LOCATION_ID`
//
// The list of allowed locations can be obtained by calling Cloud
// Tasks' implementation of
// [ListLocations][google.cloud.location.Locations.ListLocations].
Parent
string
`protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The queue to create.
//
// [Queue's name][google.cloud.tasks.v2.Queue.name] cannot be the same as an existing queue.
Queue
*
Queue
`protobuf:"bytes,2,opt,name=queue,proto3" json:"queue,omitempty"`
// contains filtered or unexported fields
}
Request message for [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue].
func (*CreateQueueRequest) Descriptor
func
(
*
CreateQueueRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use CreateQueueRequest.ProtoReflect.Descriptor instead.
func (*CreateQueueRequest) GetParent
func
(
x
*
CreateQueueRequest
)
GetParent
()
string
func (*CreateQueueRequest) GetQueue
func
(
x
*
CreateQueueRequest
)
GetQueue
()
*
Queue
func (*CreateQueueRequest) ProtoMessage
func
(
*
CreateQueueRequest
)
ProtoMessage
()
func (*CreateQueueRequest) ProtoReflect
func
(
x
*
CreateQueueRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*CreateQueueRequest) Reset
func
(
x
*
CreateQueueRequest
)
Reset
()
func (*CreateQueueRequest) String
func
(
x
*
CreateQueueRequest
)
String
()
string
CreateTaskRequest
type
CreateTaskRequest
struct
{
Parent
string
`protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
Task
*
Task
`protobuf:"bytes,2,opt,name=task,proto3" json:"task,omitempty"`
ResponseView
Task_View
""
/* 135 byte string literal not displayed */
}
Request message for [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask].
func (*CreateTaskRequest) Descriptor
func
(
*
CreateTaskRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use CreateTaskRequest.ProtoReflect.Descriptor instead.
func (*CreateTaskRequest) GetParent
func
(
x
*
CreateTaskRequest
)
GetParent
()
string
func (*CreateTaskRequest) GetResponseView
func
(
x
*
CreateTaskRequest
)
GetResponseView
()
Task_View
func (*CreateTaskRequest) GetTask
func
(
x
*
CreateTaskRequest
)
GetTask
()
*
Task
func (*CreateTaskRequest) ProtoMessage
func
(
*
CreateTaskRequest
)
ProtoMessage
()
func (*CreateTaskRequest) ProtoReflect
func
(
x
*
CreateTaskRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*CreateTaskRequest) Reset
func
(
x
*
CreateTaskRequest
)
Reset
()
func (*CreateTaskRequest) String
func
(
x
*
CreateTaskRequest
)
String
()
string
DeleteQueueRequest
type
DeleteQueueRequest
struct
{
// Required. The queue name. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request message for [DeleteQueue][google.cloud.tasks.v2.CloudTasks.DeleteQueue].
func (*DeleteQueueRequest) Descriptor
func
(
*
DeleteQueueRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use DeleteQueueRequest.ProtoReflect.Descriptor instead.
func (*DeleteQueueRequest) GetName
func
(
x
*
DeleteQueueRequest
)
GetName
()
string
func (*DeleteQueueRequest) ProtoMessage
func
(
*
DeleteQueueRequest
)
ProtoMessage
()
func (*DeleteQueueRequest) ProtoReflect
func
(
x
*
DeleteQueueRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*DeleteQueueRequest) Reset
func
(
x
*
DeleteQueueRequest
)
Reset
()
func (*DeleteQueueRequest) String
func
(
x
*
DeleteQueueRequest
)
String
()
string
DeleteTaskRequest
type
DeleteTaskRequest
struct
{
// Required. The task name. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request message for deleting a task using [DeleteTask][google.cloud.tasks.v2.CloudTasks.DeleteTask].
func (*DeleteTaskRequest) Descriptor
func
(
*
DeleteTaskRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use DeleteTaskRequest.ProtoReflect.Descriptor instead.
func (*DeleteTaskRequest) GetName
func
(
x
*
DeleteTaskRequest
)
GetName
()
string
func (*DeleteTaskRequest) ProtoMessage
func
(
*
DeleteTaskRequest
)
ProtoMessage
()
func (*DeleteTaskRequest) ProtoReflect
func
(
x
*
DeleteTaskRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*DeleteTaskRequest) Reset
func
(
x
*
DeleteTaskRequest
)
Reset
()
func (*DeleteTaskRequest) String
func
(
x
*
DeleteTaskRequest
)
String
()
string
GetQueueRequest
type
GetQueueRequest
struct
{
// Required. The resource name of the queue. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request message for [GetQueue][google.cloud.tasks.v2.CloudTasks.GetQueue].
func (*GetQueueRequest) Descriptor
func
(
*
GetQueueRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use GetQueueRequest.ProtoReflect.Descriptor instead.
func (*GetQueueRequest) GetName
func
(
x
*
GetQueueRequest
)
GetName
()
string
func (*GetQueueRequest) ProtoMessage
func
(
*
GetQueueRequest
)
ProtoMessage
()
func (*GetQueueRequest) ProtoReflect
func
(
x
*
GetQueueRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*GetQueueRequest) Reset
func
(
x
*
GetQueueRequest
)
Reset
()
func (*GetQueueRequest) String
func
(
x
*
GetQueueRequest
)
String
()
string
GetTaskRequest
type
GetTaskRequest
struct
{
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
ResponseView
Task_View
""
/* 135 byte string literal not displayed */
}
Request message for getting a task using [GetTask][google.cloud.tasks.v2.CloudTasks.GetTask].
func (*GetTaskRequest) Descriptor
func
(
*
GetTaskRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use GetTaskRequest.ProtoReflect.Descriptor instead.
func (*GetTaskRequest) GetName
func
(
x
*
GetTaskRequest
)
GetName
()
string
func (*GetTaskRequest) GetResponseView
func
(
x
*
GetTaskRequest
)
GetResponseView
()
Task_View
func (*GetTaskRequest) ProtoMessage
func
(
*
GetTaskRequest
)
ProtoMessage
()
func (*GetTaskRequest) ProtoReflect
func
(
x
*
GetTaskRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*GetTaskRequest) Reset
func
(
x
*
GetTaskRequest
)
Reset
()
func (*GetTaskRequest) String
func
(
x
*
GetTaskRequest
)
String
()
string
HttpMethod
type
HttpMethod
int32
The HTTP method used to deliver the task.
HttpMethod_HTTP_METHOD_UNSPECIFIED, HttpMethod_POST, HttpMethod_GET, HttpMethod_HEAD, HttpMethod_PUT, HttpMethod_DELETE, HttpMethod_PATCH, HttpMethod_OPTIONS
const
(
// HTTP method unspecified
HttpMethod_HTTP_METHOD_UNSPECIFIED
HttpMethod
=
0
// HTTP POST
HttpMethod_POST
HttpMethod
=
1
// HTTP GET
HttpMethod_GET
HttpMethod
=
2
// HTTP HEAD
HttpMethod_HEAD
HttpMethod
=
3
// HTTP PUT
HttpMethod_PUT
HttpMethod
=
4
// HTTP DELETE
HttpMethod_DELETE
HttpMethod
=
5
// HTTP PATCH
HttpMethod_PATCH
HttpMethod
=
6
// HTTP OPTIONS
HttpMethod_OPTIONS
HttpMethod
=
7
)
func (HttpMethod) Descriptor
func
(
HttpMethod
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (HttpMethod) Enum
func
(
x
HttpMethod
)
Enum
()
*
HttpMethod
func (HttpMethod) EnumDescriptor
func
(
HttpMethod
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use HttpMethod.Descriptor instead.
func (HttpMethod) Number
func
(
x
HttpMethod
)
Number
()
protoreflect
.
EnumNumber
func (HttpMethod) String
func
(
x
HttpMethod
)
String
()
string
func (HttpMethod) Type
func
(
HttpMethod
)
Type
()
protoreflect
.
EnumType
HttpRequest
type
HttpRequest
struct
{
Url
string
`protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
HttpMethod
HttpMethod
""
/* 130 byte string literal not displayed */
Headers
map
[
string
]
string
""
/* 155 byte string literal not displayed */
Body
[]
byte
`protobuf:"bytes,4,opt,name=body,proto3" json:"body,omitempty"`
AuthorizationHeader
isHttpRequest_AuthorizationHeader
`protobuf_oneof:"authorization_header"`
}
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 theRetry-AfterHTTP response header is considered. -
To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time).
func (*HttpRequest) Descriptor
func
(
*
HttpRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use HttpRequest.ProtoReflect.Descriptor instead.
func (*HttpRequest) GetAuthorizationHeader
func
(
m
*
HttpRequest
)
GetAuthorizationHeader
()
isHttpRequest_AuthorizationHeader
func (*HttpRequest) GetBody
func
(
x
*
HttpRequest
)
GetBody
()
[]
byte
func (*HttpRequest) GetHeaders
func
(
x
*
HttpRequest
)
GetHeaders
()
map
[
string
]
string
func (*HttpRequest) GetHttpMethod
func
(
x
*
HttpRequest
)
GetHttpMethod
()
HttpMethod
func (*HttpRequest) GetOauthToken
func
(
x
*
HttpRequest
)
GetOauthToken
()
*
OAuthToken
func (*HttpRequest) GetOidcToken
func
(
x
*
HttpRequest
)
GetOidcToken
()
*
OidcToken
func (*HttpRequest) GetUrl
func
(
x
*
HttpRequest
)
GetUrl
()
string
func (*HttpRequest) ProtoMessage
func
(
*
HttpRequest
)
ProtoMessage
()
func (*HttpRequest) ProtoReflect
func
(
x
*
HttpRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*HttpRequest) Reset
func
(
x
*
HttpRequest
)
Reset
()
func (*HttpRequest) String
func
(
x
*
HttpRequest
)
String
()
string
HttpRequest_OauthToken
type
HttpRequest_OauthToken
struct
{
// 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.
OauthToken
*
OAuthToken
`protobuf:"bytes,5,opt,name=oauth_token,json=oauthToken,proto3,oneof"`
}
HttpRequest_OidcToken
type
HttpRequest_OidcToken
struct
{
// 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.
OidcToken
*
OidcToken
`protobuf:"bytes,6,opt,name=oidc_token,json=oidcToken,proto3,oneof"`
}
ListQueuesRequest
type
ListQueuesRequest
struct
{
// Required. The location name.
// For example: `projects/PROJECT_ID/locations/LOCATION_ID`
Parent
string
`protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// `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.
Filter
string
`protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// 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.
PageSize
int32
`protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// 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.
PageToken
string
`protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
Request message for [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues].
func (*ListQueuesRequest) Descriptor
func
(
*
ListQueuesRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ListQueuesRequest.ProtoReflect.Descriptor instead.
func (*ListQueuesRequest) GetFilter
func
(
x
*
ListQueuesRequest
)
GetFilter
()
string
func (*ListQueuesRequest) GetPageSize
func
(
x
*
ListQueuesRequest
)
GetPageSize
()
int32
func (*ListQueuesRequest) GetPageToken
func
(
x
*
ListQueuesRequest
)
GetPageToken
()
string
func (*ListQueuesRequest) GetParent
func
(
x
*
ListQueuesRequest
)
GetParent
()
string
func (*ListQueuesRequest) ProtoMessage
func
(
*
ListQueuesRequest
)
ProtoMessage
()
func (*ListQueuesRequest) ProtoReflect
func
(
x
*
ListQueuesRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*ListQueuesRequest) Reset
func
(
x
*
ListQueuesRequest
)
Reset
()
func (*ListQueuesRequest) String
func
(
x
*
ListQueuesRequest
)
String
()
string
ListQueuesResponse
type
ListQueuesResponse
struct
{
// The list of queues.
Queues
[]
*
Queue
`protobuf:"bytes,1,rep,name=queues,proto3" json:"queues,omitempty"`
// A token to retrieve next page of results.
//
// To return the next page of results, call
// [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues] with this value as the
// [page_token][google.cloud.tasks.v2.ListQueuesRequest.page_token].
//
// If the next_page_token is empty, there are no more results.
//
// The page token is valid for only 2 hours.
NextPageToken
string
`protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
Response message for [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues].
func (*ListQueuesResponse) Descriptor
func
(
*
ListQueuesResponse
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ListQueuesResponse.ProtoReflect.Descriptor instead.
func (*ListQueuesResponse) GetNextPageToken
func
(
x
*
ListQueuesResponse
)
GetNextPageToken
()
string
func (*ListQueuesResponse) GetQueues
func
(
x
*
ListQueuesResponse
)
GetQueues
()
[]
*
Queue
func (*ListQueuesResponse) ProtoMessage
func
(
*
ListQueuesResponse
)
ProtoMessage
()
func (*ListQueuesResponse) ProtoReflect
func
(
x
*
ListQueuesResponse
)
ProtoReflect
()
protoreflect
.
Message
func (*ListQueuesResponse) Reset
func
(
x
*
ListQueuesResponse
)
Reset
()
func (*ListQueuesResponse) String
func
(
x
*
ListQueuesResponse
)
String
()
string
ListTasksRequest
type
ListTasksRequest
struct
{
Parent
string
`protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
ResponseView
Task_View
""
/* 135 byte string literal not displayed */
PageSize
int32
`protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
PageToken
string
`protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
}
Request message for listing tasks using [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
func (*ListTasksRequest) Descriptor
func
(
*
ListTasksRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ListTasksRequest.ProtoReflect.Descriptor instead.
func (*ListTasksRequest) GetPageSize
func
(
x
*
ListTasksRequest
)
GetPageSize
()
int32
func (*ListTasksRequest) GetPageToken
func
(
x
*
ListTasksRequest
)
GetPageToken
()
string
func (*ListTasksRequest) GetParent
func
(
x
*
ListTasksRequest
)
GetParent
()
string
func (*ListTasksRequest) GetResponseView
func
(
x
*
ListTasksRequest
)
GetResponseView
()
Task_View
func (*ListTasksRequest) ProtoMessage
func
(
*
ListTasksRequest
)
ProtoMessage
()
func (*ListTasksRequest) ProtoReflect
func
(
x
*
ListTasksRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*ListTasksRequest) Reset
func
(
x
*
ListTasksRequest
)
Reset
()
func (*ListTasksRequest) String
func
(
x
*
ListTasksRequest
)
String
()
string
ListTasksResponse
type
ListTasksResponse
struct
{
// The list of tasks.
Tasks
[]
*
Task
`protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
// A token to retrieve next page of results.
//
// To return the next page of results, call
// [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks] with this value as the
// [page_token][google.cloud.tasks.v2.ListTasksRequest.page_token].
//
// If the next_page_token is empty, there are no more results.
NextPageToken
string
`protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
Response message for listing tasks using [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
func (*ListTasksResponse) Descriptor
func
(
*
ListTasksResponse
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ListTasksResponse.ProtoReflect.Descriptor instead.
func (*ListTasksResponse) GetNextPageToken
func
(
x
*
ListTasksResponse
)
GetNextPageToken
()
string
func (*ListTasksResponse) GetTasks
func
(
x
*
ListTasksResponse
)
GetTasks
()
[]
*
Task
func (*ListTasksResponse) ProtoMessage
func
(
*
ListTasksResponse
)
ProtoMessage
()
func (*ListTasksResponse) ProtoReflect
func
(
x
*
ListTasksResponse
)
ProtoReflect
()
protoreflect
.
Message
func (*ListTasksResponse) Reset
func
(
x
*
ListTasksResponse
)
Reset
()
func (*ListTasksResponse) String
func
(
x
*
ListTasksResponse
)
String
()
string
OAuthToken
type
OAuthToken
struct
{
// [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.
ServiceAccountEmail
string
`protobuf:"bytes,1,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
// OAuth scope to be used for generating OAuth access token.
// If not specified, "https://www.googleapis.com/auth/cloud-platform"
// will be used.
Scope
string
`protobuf:"bytes,2,opt,name=scope,proto3" json:"scope,omitempty"`
// contains filtered or unexported fields
}
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.
func (*OAuthToken) Descriptor
func
(
*
OAuthToken
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use OAuthToken.ProtoReflect.Descriptor instead.
func (*OAuthToken) GetScope
func
(
x
*
OAuthToken
)
GetScope
()
string
func (*OAuthToken) GetServiceAccountEmail
func
(
x
*
OAuthToken
)
GetServiceAccountEmail
()
string
func (*OAuthToken) ProtoMessage
func
(
*
OAuthToken
)
ProtoMessage
()
func (*OAuthToken) ProtoReflect
func
(
x
*
OAuthToken
)
ProtoReflect
()
protoreflect
.
Message
func (*OAuthToken) Reset
func
(
x
*
OAuthToken
)
Reset
()
func (*OAuthToken) String
func
(
x
*
OAuthToken
)
String
()
string
OidcToken
type
OidcToken
struct
{
// [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.
ServiceAccountEmail
string
`protobuf:"bytes,1,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
// Audience to be used when generating OIDC token. If not specified, the URI
// specified in target will be used.
Audience
string
`protobuf:"bytes,2,opt,name=audience,proto3" json:"audience,omitempty"`
// contains filtered or unexported fields
}
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.
func (*OidcToken) Descriptor
Deprecated: Use OidcToken.ProtoReflect.Descriptor instead.
func (*OidcToken) GetAudience
func (*OidcToken) GetServiceAccountEmail
func (*OidcToken) ProtoMessage
func
(
*
OidcToken
)
ProtoMessage
()
func (*OidcToken) ProtoReflect
func
(
x
*
OidcToken
)
ProtoReflect
()
protoreflect
.
Message
func (*OidcToken) Reset
func
(
x
*
OidcToken
)
Reset
()
func (*OidcToken) String
PauseQueueRequest
type
PauseQueueRequest
struct
{
// Required. The queue name. For example:
// `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request message for [PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue].
func (*PauseQueueRequest) Descriptor
func
(
*
PauseQueueRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PauseQueueRequest.ProtoReflect.Descriptor instead.
func (*PauseQueueRequest) GetName
func
(
x
*
PauseQueueRequest
)
GetName
()
string
func (*PauseQueueRequest) ProtoMessage
func
(
*
PauseQueueRequest
)
ProtoMessage
()
func (*PauseQueueRequest) ProtoReflect
func
(
x
*
PauseQueueRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*PauseQueueRequest) Reset
func
(
x
*
PauseQueueRequest
)
Reset
()
func (*PauseQueueRequest) String
func
(
x
*
PauseQueueRequest
)
String
()
string
PurgeQueueRequest
type
PurgeQueueRequest
struct
{
// Required. The queue name. For example:
// `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request message for [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue].
func (*PurgeQueueRequest) Descriptor
func
(
*
PurgeQueueRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PurgeQueueRequest.ProtoReflect.Descriptor instead.
func (*PurgeQueueRequest) GetName
func
(
x
*
PurgeQueueRequest
)
GetName
()
string
func (*PurgeQueueRequest) ProtoMessage
func
(
*
PurgeQueueRequest
)
ProtoMessage
()
func (*PurgeQueueRequest) ProtoReflect
func
(
x
*
PurgeQueueRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*PurgeQueueRequest) Reset
func
(
x
*
PurgeQueueRequest
)
Reset
()
func (*PurgeQueueRequest) String
func
(
x
*
PurgeQueueRequest
)
String
()
string
Queue
type
Queue
struct
{
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
AppEngineRoutingOverride
*
AppEngineRouting
""
/* 137 byte string literal not displayed */
RateLimits
*
RateLimits
`protobuf:"bytes,3,opt,name=rate_limits,json=rateLimits,proto3" json:"rate_limits,omitempty"`
RetryConfig
*
RetryConfig
`protobuf:"bytes,4,opt,name=retry_config,json=retryConfig,proto3" json:"retry_config,omitempty"`
State
Queue_State
`protobuf:"varint,5,opt,name=state,proto3,enum=google.cloud.tasks.v2.Queue_State" json:"state,omitempty"`
PurgeTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,6,opt,name=purge_time,json=purgeTime,proto3" json:"purge_time,omitempty"`
StackdriverLoggingConfig
*
StackdriverLoggingConfig
""
/* 135 byte string literal not displayed */
}
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.
func (*Queue) Descriptor
Deprecated: Use Queue.ProtoReflect.Descriptor instead.
func (*Queue) GetAppEngineRoutingOverride
func
(
x
*
Queue
)
GetAppEngineRoutingOverride
()
*
AppEngineRouting
func (*Queue) GetName
func (*Queue) GetPurgeTime
func
(
x
*
Queue
)
GetPurgeTime
()
*
timestamppb
.
Timestamp
func (*Queue) GetRateLimits
func
(
x
*
Queue
)
GetRateLimits
()
*
RateLimits
func (*Queue) GetRetryConfig
func
(
x
*
Queue
)
GetRetryConfig
()
*
RetryConfig
func (*Queue) GetStackdriverLoggingConfig
func
(
x
*
Queue
)
GetStackdriverLoggingConfig
()
*
StackdriverLoggingConfig
func (*Queue) GetState
func
(
x
*
Queue
)
GetState
()
Queue_State
func (*Queue) ProtoMessage
func
(
*
Queue
)
ProtoMessage
()
func (*Queue) ProtoReflect
func
(
x
*
Queue
)
ProtoReflect
()
protoreflect
.
Message
func (*Queue) Reset
func
(
x
*
Queue
)
Reset
()
func (*Queue) String
Queue_State
type
Queue_State
int32
State of the queue.
Queue_STATE_UNSPECIFIED, Queue_RUNNING, Queue_PAUSED, Queue_DISABLED
const
(
// Unspecified state.
Queue_STATE_UNSPECIFIED
Queue_State
=
0
// 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.
Queue_RUNNING
Queue_State
=
1
// 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.
Queue_PAUSED
Queue_State
=
2
// 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].
Queue_DISABLED
Queue_State
=
3
)
func (Queue_State) Descriptor
func
(
Queue_State
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (Queue_State) Enum
func
(
x
Queue_State
)
Enum
()
*
Queue_State
func (Queue_State) EnumDescriptor
func
(
Queue_State
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use Queue_State.Descriptor instead.
func (Queue_State) Number
func
(
x
Queue_State
)
Number
()
protoreflect
.
EnumNumber
func (Queue_State) String
func
(
x
Queue_State
)
String
()
string
func (Queue_State) Type
func
(
Queue_State
)
Type
()
protoreflect
.
EnumType
RateLimits
type
RateLimits
struct
{
MaxDispatchesPerSecond
float64
""
/* 133 byte string literal not displayed */
MaxBurstSize
int32
`protobuf:"varint,2,opt,name=max_burst_size,json=maxBurstSize,proto3" json:"max_burst_size,omitempty"`
MaxConcurrentDispatches
int32
""
/* 133 byte string literal not displayed */
}
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].
func (*RateLimits) Descriptor
func
(
*
RateLimits
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use RateLimits.ProtoReflect.Descriptor instead.
func (*RateLimits) GetMaxBurstSize
func
(
x
*
RateLimits
)
GetMaxBurstSize
()
int32
func (*RateLimits) GetMaxConcurrentDispatches
func
(
x
*
RateLimits
)
GetMaxConcurrentDispatches
()
int32
func (*RateLimits) GetMaxDispatchesPerSecond
func
(
x
*
RateLimits
)
GetMaxDispatchesPerSecond
()
float64
func (*RateLimits) ProtoMessage
func
(
*
RateLimits
)
ProtoMessage
()
func (*RateLimits) ProtoReflect
func
(
x
*
RateLimits
)
ProtoReflect
()
protoreflect
.
Message
func (*RateLimits) Reset
func
(
x
*
RateLimits
)
Reset
()
func (*RateLimits) String
func
(
x
*
RateLimits
)
String
()
string
ResumeQueueRequest
type
ResumeQueueRequest
struct
{
// Required. The queue name. For example:
// `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request message for [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue].
func (*ResumeQueueRequest) Descriptor
func
(
*
ResumeQueueRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ResumeQueueRequest.ProtoReflect.Descriptor instead.
func (*ResumeQueueRequest) GetName
func
(
x
*
ResumeQueueRequest
)
GetName
()
string
func (*ResumeQueueRequest) ProtoMessage
func
(
*
ResumeQueueRequest
)
ProtoMessage
()
func (*ResumeQueueRequest) ProtoReflect
func
(
x
*
ResumeQueueRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*ResumeQueueRequest) Reset
func
(
x
*
ResumeQueueRequest
)
Reset
()
func (*ResumeQueueRequest) String
func
(
x
*
ResumeQueueRequest
)
String
()
string
RetryConfig
type
RetryConfig
struct
{
// 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).
MaxAttempts
int32
`protobuf:"varint,1,opt,name=max_attempts,json=maxAttempts,proto3" json:"max_attempts,omitempty"`
// 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).
MaxRetryDuration
*
durationpb
.
Duration
`protobuf:"bytes,2,opt,name=max_retry_duration,json=maxRetryDuration,proto3" json:"max_retry_duration,omitempty"`
// 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).
MinBackoff
*
durationpb
.
Duration
`protobuf:"bytes,3,opt,name=min_backoff,json=minBackoff,proto3" json:"min_backoff,omitempty"`
// 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).
MaxBackoff
*
durationpb
.
Duration
`protobuf:"bytes,4,opt,name=max_backoff,json=maxBackoff,proto3" json:"max_backoff,omitempty"`
// 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).
MaxDoublings
int32
`protobuf:"varint,5,opt,name=max_doublings,json=maxDoublings,proto3" json:"max_doublings,omitempty"`
// contains filtered or unexported fields
}
Retry config.
These settings determine when a failed task attempt is retried.
func (*RetryConfig) Descriptor
func
(
*
RetryConfig
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use RetryConfig.ProtoReflect.Descriptor instead.
func (*RetryConfig) GetMaxAttempts
func
(
x
*
RetryConfig
)
GetMaxAttempts
()
int32
func (*RetryConfig) GetMaxBackoff
func
(
x
*
RetryConfig
)
GetMaxBackoff
()
*
durationpb
.
Duration
func (*RetryConfig) GetMaxDoublings
func
(
x
*
RetryConfig
)
GetMaxDoublings
()
int32
func (*RetryConfig) GetMaxRetryDuration
func
(
x
*
RetryConfig
)
GetMaxRetryDuration
()
*
durationpb
.
Duration
func (*RetryConfig) GetMinBackoff
func
(
x
*
RetryConfig
)
GetMinBackoff
()
*
durationpb
.
Duration
func (*RetryConfig) ProtoMessage
func
(
*
RetryConfig
)
ProtoMessage
()
func (*RetryConfig) ProtoReflect
func
(
x
*
RetryConfig
)
ProtoReflect
()
protoreflect
.
Message
func (*RetryConfig) Reset
func
(
x
*
RetryConfig
)
Reset
()
func (*RetryConfig) String
func
(
x
*
RetryConfig
)
String
()
string
RunTaskRequest
type
RunTaskRequest
struct
{
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
ResponseView
Task_View
""
/* 135 byte string literal not displayed */
}
Request message for forcing a task to run now using [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask].
func (*RunTaskRequest) Descriptor
func
(
*
RunTaskRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use RunTaskRequest.ProtoReflect.Descriptor instead.
func (*RunTaskRequest) GetName
func
(
x
*
RunTaskRequest
)
GetName
()
string
func (*RunTaskRequest) GetResponseView
func
(
x
*
RunTaskRequest
)
GetResponseView
()
Task_View
func (*RunTaskRequest) ProtoMessage
func
(
*
RunTaskRequest
)
ProtoMessage
()
func (*RunTaskRequest) ProtoReflect
func
(
x
*
RunTaskRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*RunTaskRequest) Reset
func
(
x
*
RunTaskRequest
)
Reset
()
func (*RunTaskRequest) String
func
(
x
*
RunTaskRequest
)
String
()
string
StackdriverLoggingConfig
type
StackdriverLoggingConfig
struct
{
// Specifies the fraction of operations to write to
// [Stackdriver Logging](https://cloud.google.com/logging/docs/).
// 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.
SamplingRatio
float64
`protobuf:"fixed64,1,opt,name=sampling_ratio,json=samplingRatio,proto3" json:"sampling_ratio,omitempty"`
// contains filtered or unexported fields
}
Configuration options for writing logs to Stackdriver Logging .
func (*StackdriverLoggingConfig) Descriptor
func
(
*
StackdriverLoggingConfig
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use StackdriverLoggingConfig.ProtoReflect.Descriptor instead.
func (*StackdriverLoggingConfig) GetSamplingRatio
func
(
x
*
StackdriverLoggingConfig
)
GetSamplingRatio
()
float64
func (*StackdriverLoggingConfig) ProtoMessage
func
(
*
StackdriverLoggingConfig
)
ProtoMessage
()
func (*StackdriverLoggingConfig) ProtoReflect
func
(
x
*
StackdriverLoggingConfig
)
ProtoReflect
()
protoreflect
.
Message
func (*StackdriverLoggingConfig) Reset
func
(
x
*
StackdriverLoggingConfig
)
Reset
()
func (*StackdriverLoggingConfig) String
func
(
x
*
StackdriverLoggingConfig
)
String
()
string
Task
type
Task
struct
{
// 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.
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The message to send to the worker.
//
// Types that are assignable to MessageType:
//
// *Task_AppEngineHttpRequest
// *Task_HttpRequest
MessageType
isTask_MessageType
`protobuf_oneof:"message_type"`
// The time when the task is scheduled to be attempted or retried.
//
// `schedule_time` will be truncated to the nearest microsecond.
ScheduleTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,4,opt,name=schedule_time,json=scheduleTime,proto3" json:"schedule_time,omitempty"`
// Output only. The time that the task was created.
//
// `create_time` will be truncated to the nearest second.
CreateTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// 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.
DispatchDeadline
*
durationpb
.
Duration
`protobuf:"bytes,6,opt,name=dispatch_deadline,json=dispatchDeadline,proto3" json:"dispatch_deadline,omitempty"`
// Output only. The number of attempts dispatched.
//
// This count includes attempts which have been dispatched but haven't
// received a response.
DispatchCount
int32
`protobuf:"varint,7,opt,name=dispatch_count,json=dispatchCount,proto3" json:"dispatch_count,omitempty"`
// Output only. The number of attempts which have received a response.
ResponseCount
int32
`protobuf:"varint,8,opt,name=response_count,json=responseCount,proto3" json:"response_count,omitempty"`
// 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.
FirstAttempt
*
Attempt
`protobuf:"bytes,9,opt,name=first_attempt,json=firstAttempt,proto3" json:"first_attempt,omitempty"`
// Output only. The status of the task's last attempt.
LastAttempt
*
Attempt
`protobuf:"bytes,10,opt,name=last_attempt,json=lastAttempt,proto3" json:"last_attempt,omitempty"`
// Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2.Task] has
// been returned.
View
Task_View
`protobuf:"varint,11,opt,name=view,proto3,enum=google.cloud.tasks.v2.Task_View" json:"view,omitempty"`
// contains filtered or unexported fields
}
A unit of scheduled work.
func (*Task) Descriptor
Deprecated: Use Task.ProtoReflect.Descriptor instead.
func (*Task) GetAppEngineHttpRequest
func
(
x
*
Task
)
GetAppEngineHttpRequest
()
*
AppEngineHttpRequest
func (*Task) GetCreateTime
func
(
x
*
Task
)
GetCreateTime
()
*
timestamppb
.
Timestamp
func (*Task) GetDispatchCount
func (*Task) GetDispatchDeadline
func
(
x
*
Task
)
GetDispatchDeadline
()
*
durationpb
.
Duration
func (*Task) GetFirstAttempt
func (*Task) GetHttpRequest
func
(
x
*
Task
)
GetHttpRequest
()
*
HttpRequest
func (*Task) GetLastAttempt
func (*Task) GetMessageType
func
(
m
*
Task
)
GetMessageType
()
isTask_MessageType
func (*Task) GetName
func (*Task) GetResponseCount
func (*Task) GetScheduleTime
func
(
x
*
Task
)
GetScheduleTime
()
*
timestamppb
.
Timestamp
func (*Task) GetView
func (*Task) ProtoMessage
func
(
*
Task
)
ProtoMessage
()
func (*Task) ProtoReflect
func
(
x
*
Task
)
ProtoReflect
()
protoreflect
.
Message
func (*Task) Reset
func
(
x
*
Task
)
Reset
()
func (*Task) String
Task_AppEngineHttpRequest
type
Task_AppEngineHttpRequest
struct
{
// 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.
AppEngineHttpRequest
*
AppEngineHttpRequest
`protobuf:"bytes,2,opt,name=app_engine_http_request,json=appEngineHttpRequest,proto3,oneof"`
}
Task_HttpRequest
type
Task_HttpRequest
struct
{
// HTTP request that is sent to the worker.
//
// An HTTP task is a task that has [HttpRequest][google.cloud.tasks.v2.HttpRequest] set.
HttpRequest
*
HttpRequest
`protobuf:"bytes,3,opt,name=http_request,json=httpRequest,proto3,oneof"`
}
Task_View
type
Task_View
int32
The view specifies a subset of [Task][google.cloud.tasks.v2.Task] data.
When a task is returned in a response, not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.
Task_VIEW_UNSPECIFIED, Task_BASIC, Task_FULL
const
(
// Unspecified. Defaults to BASIC.
Task_VIEW_UNSPECIFIED
Task_View
=
0
// 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.
Task_BASIC
Task_View
=
1
// 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.
Task_FULL
Task_View
=
2
)
func (Task_View) Descriptor
func
(
Task_View
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (Task_View) Enum
func (Task_View) EnumDescriptor
Deprecated: Use Task_View.Descriptor instead.
func (Task_View) Number
func
(
x
Task_View
)
Number
()
protoreflect
.
EnumNumber
func (Task_View) String
func (Task_View) Type
func
(
Task_View
)
Type
()
protoreflect
.
EnumType
UnimplementedCloudTasksServer
type
UnimplementedCloudTasksServer
struct
{
}
UnimplementedCloudTasksServer can be embedded to have forward compatible implementations.
func (*UnimplementedCloudTasksServer) CreateQueue
func
(
*
UnimplementedCloudTasksServer
)
CreateQueue
(
context
.
Context
,
*
CreateQueueRequest
)
(
*
Queue
,
error
)
func (*UnimplementedCloudTasksServer) CreateTask
func
(
*
UnimplementedCloudTasksServer
)
CreateTask
(
context
.
Context
,
*
CreateTaskRequest
)
(
*
Task
,
error
)
func (*UnimplementedCloudTasksServer) DeleteQueue
func
(
*
UnimplementedCloudTasksServer
)
DeleteQueue
(
context
.
Context
,
*
DeleteQueueRequest
)
(
*
emptypb
.
Empty
,
error
)
func (*UnimplementedCloudTasksServer) DeleteTask
func
(
*
UnimplementedCloudTasksServer
)
DeleteTask
(
context
.
Context
,
*
DeleteTaskRequest
)
(
*
emptypb
.
Empty
,
error
)
func (*UnimplementedCloudTasksServer) GetIamPolicy
func
(
*
UnimplementedCloudTasksServer
)
GetIamPolicy
(
context
.
Context
,
*
v1
.
GetIamPolicyRequest
)
(
*
v1
.
Policy
,
error
)
func (*UnimplementedCloudTasksServer) GetQueue
func
(
*
UnimplementedCloudTasksServer
)
GetQueue
(
context
.
Context
,
*
GetQueueRequest
)
(
*
Queue
,
error
)
func (*UnimplementedCloudTasksServer) GetTask
func
(
*
UnimplementedCloudTasksServer
)
GetTask
(
context
.
Context
,
*
GetTaskRequest
)
(
*
Task
,
error
)
func (*UnimplementedCloudTasksServer) ListQueues
func
(
*
UnimplementedCloudTasksServer
)
ListQueues
(
context
.
Context
,
*
ListQueuesRequest
)
(
*
ListQueuesResponse
,
error
)
func (*UnimplementedCloudTasksServer) ListTasks
func
(
*
UnimplementedCloudTasksServer
)
ListTasks
(
context
.
Context
,
*
ListTasksRequest
)
(
*
ListTasksResponse
,
error
)
func (*UnimplementedCloudTasksServer) PauseQueue
func
(
*
UnimplementedCloudTasksServer
)
PauseQueue
(
context
.
Context
,
*
PauseQueueRequest
)
(
*
Queue
,
error
)
func (*UnimplementedCloudTasksServer) PurgeQueue
func
(
*
UnimplementedCloudTasksServer
)
PurgeQueue
(
context
.
Context
,
*
PurgeQueueRequest
)
(
*
Queue
,
error
)
func (*UnimplementedCloudTasksServer) ResumeQueue
func
(
*
UnimplementedCloudTasksServer
)
ResumeQueue
(
context
.
Context
,
*
ResumeQueueRequest
)
(
*
Queue
,
error
)
func (*UnimplementedCloudTasksServer) RunTask
func
(
*
UnimplementedCloudTasksServer
)
RunTask
(
context
.
Context
,
*
RunTaskRequest
)
(
*
Task
,
error
)
func (*UnimplementedCloudTasksServer) SetIamPolicy
func
(
*
UnimplementedCloudTasksServer
)
SetIamPolicy
(
context
.
Context
,
*
v1
.
SetIamPolicyRequest
)
(
*
v1
.
Policy
,
error
)
func (*UnimplementedCloudTasksServer) TestIamPermissions
func
(
*
UnimplementedCloudTasksServer
)
TestIamPermissions
(
context
.
Context
,
*
v1
.
TestIamPermissionsRequest
)
(
*
v1
.
TestIamPermissionsResponse
,
error
)
func (*UnimplementedCloudTasksServer) UpdateQueue
func
(
*
UnimplementedCloudTasksServer
)
UpdateQueue
(
context
.
Context
,
*
UpdateQueueRequest
)
(
*
Queue
,
error
)
UpdateQueueRequest
type
UpdateQueueRequest
struct
{
// Required. The queue to create or update.
//
// The queue's [name][google.cloud.tasks.v2.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.v2.Queue.name] cannot be changed.
Queue
*
Queue
`protobuf:"bytes,1,opt,name=queue,proto3" json:"queue,omitempty"`
// A mask used to specify which fields of the queue are being updated.
//
// If empty, then all fields will be updated.
UpdateMask
*
fieldmaskpb
.
FieldMask
`protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
Request message for [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue].
func (*UpdateQueueRequest) Descriptor
func
(
*
UpdateQueueRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use UpdateQueueRequest.ProtoReflect.Descriptor instead.
func (*UpdateQueueRequest) GetQueue
func
(
x
*
UpdateQueueRequest
)
GetQueue
()
*
Queue
func (*UpdateQueueRequest) GetUpdateMask
func
(
x
*
UpdateQueueRequest
)
GetUpdateMask
()
*
fieldmaskpb
.
FieldMask
func (*UpdateQueueRequest) ProtoMessage
func
(
*
UpdateQueueRequest
)
ProtoMessage
()
func (*UpdateQueueRequest) ProtoReflect
func
(
x
*
UpdateQueueRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*UpdateQueueRequest) Reset
func
(
x
*
UpdateQueueRequest
)
Reset
()
func (*UpdateQueueRequest) String
func
(
x
*
UpdateQueueRequest
)
String
()
string
