Package cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb (v1.12.7)

Version latest

• 1.12.7 (latest)
• 1.12.6
• 1.11.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

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.

UriOverride_Scheme_name, UriOverride_Scheme_value

var (
	UriOverride_Scheme_name = map[int32]string{
		0: "SCHEME_UNSPECIFIED",
		1: "HTTP",
		2: "HTTPS",
	}
	UriOverride_Scheme_value = map[string]int32{
		"SCHEME_UNSPECIFIED": 0,
		"HTTP":               1,
		"HTTPS":              2,
	}
)

Enum value maps for UriOverride_Scheme.

UriOverride_UriOverrideEnforceMode_name, UriOverride_UriOverrideEnforceMode_value

var (
	UriOverride_UriOverrideEnforceMode_name = map[int32]string{
		0: "URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED",
		1: "IF_NOT_EXISTS",
		2: "ALWAYS",
	}
	UriOverride_UriOverrideEnforceMode_value = map[string]int32{
		"URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED": 0,
		"IF_NOT_EXISTS":                         1,
		"ALWAYS":                                2,
	}
)

Enum value maps for UriOverride_UriOverrideEnforceMode.

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_v2beta2_cloudtasks_proto

var File_google_cloud_tasks_v2beta2_cloudtasks_proto protoreflect.FileDescriptor

File_google_cloud_tasks_v2beta2_old_target_proto

var File_google_cloud_tasks_v2beta2_old_target_proto protoreflect.FileDescriptor

File_google_cloud_tasks_v2beta2_queue_proto

var File_google_cloud_tasks_v2beta2_queue_proto protoreflect.FileDescriptor

File_google_cloud_tasks_v2beta2_target_proto

var File_google_cloud_tasks_v2beta2_target_proto protoreflect.FileDescriptor

File_google_cloud_tasks_v2beta2_task_proto

var File_google_cloud_tasks_v2beta2_task_proto protoreflect.FileDescriptor

Functions

func RegisterCloudTasksServer

func RegisterCloudTasksServer(s *grpc.Server, srv CloudTasksServer)

AcknowledgeTaskRequest

type AcknowledgeTaskRequest 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"`
	// Required. The task's current schedule time, available in the
	// [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] returned by
	// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] response or
	// [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease] response.
	// This restriction is to ensure that your worker currently holds the lease.
	ScheduleTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=schedule_time,json=scheduleTime,proto3" json:"schedule_time,omitempty"`
	// contains filtered or unexported fields
}

Request message for acknowledging a task using [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask].

func (*AcknowledgeTaskRequest) Descriptor

func (*AcknowledgeTaskRequest) Descriptor() ([]byte, []int)

Deprecated: Use AcknowledgeTaskRequest.ProtoReflect.Descriptor instead.

func (*AcknowledgeTaskRequest) GetName

func (x *AcknowledgeTaskRequest) GetName() string

func (*AcknowledgeTaskRequest) GetScheduleTime

func (x *AcknowledgeTaskRequest) GetScheduleTime() *timestamppb.Timestamp

func (*AcknowledgeTaskRequest) ProtoMessage

func (*AcknowledgeTaskRequest) ProtoMessage()

func (*AcknowledgeTaskRequest) ProtoReflect

func (x *AcknowledgeTaskRequest) ProtoReflect() protoreflect.Message

func (*AcknowledgeTaskRequest) Reset

func (x *AcknowledgeTaskRequest) Reset()

func (*AcknowledgeTaskRequest) String

func (x *AcknowledgeTaskRequest) String() string

AppEngineHttpRequest

type AppEngineHttpRequest struct {
	HttpMethod HttpMethod "" /* 135 byte string literal not displayed */

	AppEngineRouting *AppEngineRouting `protobuf:"bytes,2,opt,name=app_engine_routing,json=appEngineRouting,proto3" json:"app_engine_routing,omitempty"`

	RelativeUrl string `protobuf:"bytes,3,opt,name=relative_url,json=relativeUrl,proto3" json:"relative_url,omitempty"`

	Headers map[string]string "" /* 155 byte string literal not displayed */

	Payload []byte `protobuf:"bytes,5,opt,name=payload,proto3" json:"payload,omitempty"`

}

App Engine HTTP request.

The message defines the HTTP request that is sent to an App Engine app when the task is dispatched.

This proto can only be used for tasks in a queue which has [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] set.

Using [AppEngineHttpRequest][google.cloud.tasks.v2beta2.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.v2beta2.AppEngineRouting] used to construct the URL that the task is delivered to can be set at the queue-level or task-level:

• If set, [app_engine_routing_override][google.cloud.tasks.v2beta2.AppEngineHttpTarget.app_engine_routing_override] is used for all tasks in the queue, no matter what the setting is for the [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].

The url that the task will be sent to is:

• url = [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] + [relative_url][google.cloud.tasks.v2beta2.AppEngineHttpRequest.relative_url]

Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with login: admin. Because tasks are not run as any user, they cannot be dispatched to URIs restricted with login: required Task dispatches also do not follow redirects.

The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [200 - 299]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the [deadline][Task.dispatch_deadline]. Failed tasks will be retried according to the [retry configuration][google.cloud.tasks.v2beta2.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) GetHeaders

func (x *AppEngineHttpRequest) GetHeaders() map[string]string

func (*AppEngineHttpRequest) GetHttpMethod

func (x *AppEngineHttpRequest) GetHttpMethod() HttpMethod

func (*AppEngineHttpRequest) GetPayload

func (x *AppEngineHttpRequest) GetPayload() []byte

func (*AppEngineHttpRequest) GetRelativeUrl

func (x *AppEngineHttpRequest) GetRelativeUrl() 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

AppEngineHttpTarget

type AppEngineHttpTarget struct {
	AppEngineRoutingOverride *AppEngineRouting "" /* 137 byte string literal not displayed */

}

App Engine HTTP target.

The task will be delivered to the App Engine application hostname specified by its [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget] and [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]. The documentation for [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] explains how the task's host URL is constructed.

Using [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget] requires appengine.applications.get Google IAM permission for the project and the following scope:

https://www.googleapis.com/auth/cloud-platform

func (*AppEngineHttpTarget) Descriptor

func (*AppEngineHttpTarget) Descriptor() ([]byte, []int)

Deprecated: Use AppEngineHttpTarget.ProtoReflect.Descriptor instead.

func (*AppEngineHttpTarget) GetAppEngineRoutingOverride

func (x *AppEngineHttpTarget) GetAppEngineRoutingOverride() *AppEngineRouting

func (*AppEngineHttpTarget) ProtoMessage

func (*AppEngineHttpTarget) ProtoMessage()

func (*AppEngineHttpTarget) ProtoReflect

func (x *AppEngineHttpTarget) ProtoReflect() protoreflect.Message

func (*AppEngineHttpTarget) Reset

func (x *AppEngineHttpTarget) Reset()

func (*AppEngineHttpTarget) String

func (x *AppEngineHttpTarget) 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.v2beta2.AppEngineRouting.host] is
	// not parsable into
	// [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
	// [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
	// [instance][google.cloud.tasks.v2beta2.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.v2beta2.AppEngineRouting.host] is not parsable,
	// then [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
	// [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
	// [instance][google.cloud.tasks.v2beta2.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.v2beta2.AppEngineRouting.host] is
	// not parsable into
	// [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
	// [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
	// [instance][google.cloud.tasks.v2beta2.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.v2beta2.AppEngineRouting.host] is not parsable,
	// then [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
	// [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
	// [instance][google.cloud.tasks.v2beta2.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.
	//
	// For more information, see
	// [How Requests are
	// Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
	//
	// The host is constructed as:
	//
	//   - `host = [application_domain_name]`

	//     `| [service] + '.' + [application_domain_name]`

	//     `| [version] + '.' + [application_domain_name]`

	//     `| [version_dot_service]+ '.' + [application_domain_name]`

	//     `| [instance] + '.' + [application_domain_name]`

	//     `| [instance_dot_service] + '.' + [application_domain_name]`

	//     `| [instance_dot_version] + '.' + [application_domain_name]`

	//     `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
	//
	//   - `application_domain_name` = The domain name of the app, 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.

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

AttemptStatus

type AttemptStatus 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 target for this attempt.
	//
	// If the task has not been attempted or the task is currently running
	// then the response status is unset.
	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 (*AttemptStatus) Descriptor

func (*AttemptStatus) Descriptor() ([]byte, []int)

Deprecated: Use AttemptStatus.ProtoReflect.Descriptor instead.

func (*AttemptStatus) GetDispatchTime

func (x *AttemptStatus) GetDispatchTime() *timestamppb.Timestamp

func (*AttemptStatus) GetResponseStatus

func (x *AttemptStatus) GetResponseStatus() *status.Status

func (*AttemptStatus) GetResponseTime

func (x *AttemptStatus) GetResponseTime() *timestamppb.Timestamp

func (*AttemptStatus) GetScheduleTime

func (x *AttemptStatus) GetScheduleTime() *timestamppb.Timestamp

func (*AttemptStatus) ProtoMessage

func (*AttemptStatus) ProtoMessage()

func (*AttemptStatus) ProtoReflect

func (x *AttemptStatus) ProtoReflect() protoreflect.Message

func (*AttemptStatus) Reset

func (x *AttemptStatus) Reset()

func (*AttemptStatus) String

func (x *AttemptStatus) String() string

CancelLeaseRequest

type CancelLeaseRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	ScheduleTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=schedule_time,json=scheduleTime,proto3" json:"schedule_time,omitempty"`

	ResponseView Task_View "" /* 140 byte string literal not displayed */

}

Request message for canceling a lease using [CancelLease][google.cloud.tasks.v2beta2.CloudTasks.CancelLease].

func (*CancelLeaseRequest) Descriptor

func (*CancelLeaseRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelLeaseRequest.ProtoReflect.Descriptor instead.

func (*CancelLeaseRequest) GetName

func (x *CancelLeaseRequest) GetName() string

func (*CancelLeaseRequest) GetResponseView

func (x *CancelLeaseRequest) GetResponseView() Task_View

func (*CancelLeaseRequest) GetScheduleTime

func (x *CancelLeaseRequest) GetScheduleTime() *timestamppb.Timestamp

func (*CancelLeaseRequest) ProtoMessage

func (*CancelLeaseRequest) ProtoMessage()

func (*CancelLeaseRequest) ProtoReflect

func (x *CancelLeaseRequest) ProtoReflect() protoreflect.Message

func (*CancelLeaseRequest) Reset

func (x *CancelLeaseRequest) Reset()

func (*CancelLeaseRequest) String

func (x *CancelLeaseRequest) String() 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.v2beta2.CloudTasks.ResumeQueue]. Tasks can
	// still be added when the queue is paused. A queue is paused if its
	// [state][google.cloud.tasks.v2beta2.Queue.state] is
	// [PAUSED][google.cloud.tasks.v2beta2.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.v2beta2.Queue.State.PAUSED] or
	// [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a
	// queue is stored in the queue's
	// [state][google.cloud.tasks.v2beta2.Queue.state]; after calling this method
	// it will be set to
	// [RUNNING][google.cloud.tasks.v2beta2.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)
	// Update queue list by uploading a queue.yaml file.
	//
	// The queue.yaml file is supplied in the request body as a YAML encoded
	// string. This method was added to support gcloud clients versions before
	// 322.0.0. New clients should use CreateQueue instead of this method.
	UploadQueueYaml(ctx context.Context, in *UploadQueueYamlRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Gets the access control policy for a
	// [Queue][google.cloud.tasks.v2beta2.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 *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
	// Sets the access control policy for a
	// [Queue][google.cloud.tasks.v2beta2.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 *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
	// Returns permissions that a caller has on a
	// [Queue][google.cloud.tasks.v2beta2.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 *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
	// Lists the tasks in a queue.
	//
	// By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]
	// view is retrieved due to performance considerations;
	// [response_view][google.cloud.tasks.v2beta2.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.
	//
	// * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget],
	// the maximum task size is
	//
	//	100KB.
	//
	// * For [pull queues][google.cloud.tasks.v2beta2.PullTarget], the maximum
	// task size is 1MB.
	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 completed successfully or permanently
	// failed.
	DeleteTask(ctx context.Context, in *DeleteTaskRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Leases tasks from a pull queue for
	// [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
	//
	// This method is invoked by the worker to obtain a lease. The
	// worker must acknowledge the task via
	// [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask]
	// after they have performed the work associated with the task.
	//
	// The [payload][google.cloud.tasks.v2beta2.PullMessage.payload] is intended
	// to store data that the worker needs to perform the work associated with the
	// task. To return the payloads in the
	// [response][google.cloud.tasks.v2beta2.LeaseTasksResponse], set
	// [response_view][google.cloud.tasks.v2beta2.LeaseTasksRequest.response_view]
	// to [FULL][google.cloud.tasks.v2beta2.Task.View.FULL].
	//
	// A maximum of 10 qps of
	// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] requests are
	// allowed per queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
	// is returned when this limit is
	// exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
	// is also returned when
	// [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second]
	// is exceeded.
	LeaseTasks(ctx context.Context, in *LeaseTasksRequest, opts ...grpc.CallOption) (*LeaseTasksResponse, error)
	// Acknowledges a pull task.
	//
	// The worker, that is, the entity that
	// [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] this task must
	// call this method to indicate that the work associated with the task has
	// finished.
	//
	// The worker must acknowledge a task within the
	// [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration]
	// or the lease will expire and the task will become available to be leased
	// again. After the task is acknowledged, it will not be returned
	// by a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks],
	// [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask], or
	// [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
	AcknowledgeTask(ctx context.Context, in *AcknowledgeTaskRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Renew the current lease of a pull task.
	//
	// The worker can use this method to extend the lease by a new
	// duration, starting from now. The new task lease will be
	// returned in the task's
	// [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
	RenewLease(ctx context.Context, in *RenewLeaseRequest, opts ...grpc.CallOption) (*Task, error)
	// Cancel a pull task's lease.
	//
	// The worker can use this method to cancel a task's lease by
	// setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]
	// to now. This will make the task available to be leased to the next caller
	// of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
	CancelLease(ctx context.Context, in *CancelLeaseRequest, opts ...grpc.CallOption) (*Task, 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.v2beta2.RateLimits] or is
	// [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED].
	//
	// This command is meant to be used for manual debugging. For
	// example, [RunTask][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.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.v2beta2.Task.schedule_time] will be
	// reset to the time that
	// [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] was called plus
	// the retry delay specified in the queue's
	// [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig].
	//
	// [RunTask][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called
	// on a [pull task][google.cloud.tasks.v2beta2.PullMessage].
	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.v2beta2.CloudTasks.ResumeQueue]. Tasks can
	// still be added when the queue is paused. A queue is paused if its
	// [state][google.cloud.tasks.v2beta2.Queue.state] is
	// [PAUSED][google.cloud.tasks.v2beta2.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.v2beta2.Queue.State.PAUSED] or
	// [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a
	// queue is stored in the queue's
	// [state][google.cloud.tasks.v2beta2.Queue.state]; after calling this method
	// it will be set to
	// [RUNNING][google.cloud.tasks.v2beta2.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)
	// Update queue list by uploading a queue.yaml file.
	//
	// The queue.yaml file is supplied in the request body as a YAML encoded
	// string. This method was added to support gcloud clients versions before
	// 322.0.0. New clients should use CreateQueue instead of this method.
	UploadQueueYaml(context.Context, *UploadQueueYamlRequest) (*emptypb.Empty, error)
	// Gets the access control policy for a
	// [Queue][google.cloud.tasks.v2beta2.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, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
	// Sets the access control policy for a
	// [Queue][google.cloud.tasks.v2beta2.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, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
	// Returns permissions that a caller has on a
	// [Queue][google.cloud.tasks.v2beta2.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, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
	// Lists the tasks in a queue.
	//
	// By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]
	// view is retrieved due to performance considerations;
	// [response_view][google.cloud.tasks.v2beta2.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.
	//
	// * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget],
	// the maximum task size is
	//
	//	100KB.
	//
	// * For [pull queues][google.cloud.tasks.v2beta2.PullTarget], the maximum
	// task size is 1MB.
	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 completed successfully or permanently
	// failed.
	DeleteTask(context.Context, *DeleteTaskRequest) (*emptypb.Empty, error)
	// Leases tasks from a pull queue for
	// [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
	//
	// This method is invoked by the worker to obtain a lease. The
	// worker must acknowledge the task via
	// [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask]
	// after they have performed the work associated with the task.
	//
	// The [payload][google.cloud.tasks.v2beta2.PullMessage.payload] is intended
	// to store data that the worker needs to perform the work associated with the
	// task. To return the payloads in the
	// [response][google.cloud.tasks.v2beta2.LeaseTasksResponse], set
	// [response_view][google.cloud.tasks.v2beta2.LeaseTasksRequest.response_view]
	// to [FULL][google.cloud.tasks.v2beta2.Task.View.FULL].
	//
	// A maximum of 10 qps of
	// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] requests are
	// allowed per queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
	// is returned when this limit is
	// exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
	// is also returned when
	// [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second]
	// is exceeded.
	LeaseTasks(context.Context, *LeaseTasksRequest) (*LeaseTasksResponse, error)
	// Acknowledges a pull task.
	//
	// The worker, that is, the entity that
	// [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] this task must
	// call this method to indicate that the work associated with the task has
	// finished.
	//
	// The worker must acknowledge a task within the
	// [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration]
	// or the lease will expire and the task will become available to be leased
	// again. After the task is acknowledged, it will not be returned
	// by a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks],
	// [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask], or
	// [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
	AcknowledgeTask(context.Context, *AcknowledgeTaskRequest) (*emptypb.Empty, error)
	// Renew the current lease of a pull task.
	//
	// The worker can use this method to extend the lease by a new
	// duration, starting from now. The new task lease will be
	// returned in the task's
	// [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
	RenewLease(context.Context, *RenewLeaseRequest) (*Task, error)
	// Cancel a pull task's lease.
	//
	// The worker can use this method to cancel a task's lease by
	// setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]
	// to now. This will make the task available to be leased to the next caller
	// of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
	CancelLease(context.Context, *CancelLeaseRequest) (*Task, 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.v2beta2.RateLimits] or is
	// [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED].
	//
	// This command is meant to be used for manual debugging. For
	// example, [RunTask][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.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.v2beta2.Task.schedule_time] will be
	// reset to the time that
	// [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] was called plus
	// the retry delay specified in the queue's
	// [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig].
	//
	// [RunTask][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called
	// on a [pull task][google.cloud.tasks.v2beta2.PullMessage].
	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.v2beta2.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.v2beta2.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 "" /* 140 byte string literal not displayed */

}

Request message for [CreateTask][google.cloud.tasks.v2beta2.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.v2beta2.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.v2beta2.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"`
	// Optional. Read mask is used for a more granular control over what the API
	// returns. If the mask is not present all fields will be returned except
	// [Queue.stats]. [Queue.stats] will be returned only if it was  explicitly
	// specified in the mask.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [GetQueue][google.cloud.tasks.v2beta2.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) GetReadMask

func (x *GetQueueRequest) GetReadMask() *fieldmaskpb.FieldMask

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 "" /* 140 byte string literal not displayed */

}

Request message for getting a task using [GetTask][google.cloud.tasks.v2beta2.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 execute 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 "" /* 135 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. An HTTP request embodies a url, an http method, headers, body and authorization for the http task.

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"`
}

HttpTarget

type HttpTarget struct {
	UriOverride *UriOverride `protobuf:"bytes,1,opt,name=uri_override,json=uriOverride,proto3" json:"uri_override,omitempty"`

	HttpMethod HttpMethod "" /* 135 byte string literal not displayed */

	HeaderOverrides []*HttpTarget_HeaderOverride `protobuf:"bytes,3,rep,name=header_overrides,json=headerOverrides,proto3" json:"header_overrides,omitempty"`

	AuthorizationHeader isHttpTarget_AuthorizationHeader `protobuf_oneof:"authorization_header"`

}

HTTP target.

When specified as a [Queue][target_type], all the tasks with [HttpRequest] will be overridden according to the target.

func (*HttpTarget) Descriptor

func (*HttpTarget) Descriptor() ([]byte, []int)

Deprecated: Use HttpTarget.ProtoReflect.Descriptor instead.

func (*HttpTarget) GetAuthorizationHeader

func (m *HttpTarget) GetAuthorizationHeader() isHttpTarget_AuthorizationHeader

func (*HttpTarget) GetHeaderOverrides

func (x *HttpTarget) GetHeaderOverrides() []*HttpTarget_HeaderOverride

func (*HttpTarget) GetHttpMethod

func (x *HttpTarget) GetHttpMethod() HttpMethod

func (*HttpTarget) GetOauthToken

func (x *HttpTarget) GetOauthToken() *OAuthToken

func (*HttpTarget) GetOidcToken

func (x *HttpTarget) GetOidcToken() *OidcToken

func (*HttpTarget) GetUriOverride

func (x *HttpTarget) GetUriOverride() *UriOverride

func (*HttpTarget) ProtoMessage

func (*HttpTarget) ProtoMessage()

func (*HttpTarget) ProtoReflect

func (x *HttpTarget) ProtoReflect() protoreflect.Message

func (*HttpTarget) Reset

func (x *HttpTarget) Reset()

func (*HttpTarget) String

func (x *HttpTarget) String() string

HttpTarget_Header

type HttpTarget_Header struct {

	// The key of the header.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// The value of the header.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Defines a header message. A header can have a key and a value.

func (*HttpTarget_Header) Descriptor

func (*HttpTarget_Header) Descriptor() ([]byte, []int)

Deprecated: Use HttpTarget_Header.ProtoReflect.Descriptor instead.

func (*HttpTarget_Header) GetKey

func (x *HttpTarget_Header) GetKey() string

func (*HttpTarget_Header) GetValue

func (x *HttpTarget_Header) GetValue() string

func (*HttpTarget_Header) ProtoMessage

func (*HttpTarget_Header) ProtoMessage()

func (*HttpTarget_Header) ProtoReflect

func (x *HttpTarget_Header) ProtoReflect() protoreflect.Message

func (*HttpTarget_Header) Reset

func (x *HttpTarget_Header) Reset()

func (*HttpTarget_Header) String

func (x *HttpTarget_Header) String() string

HttpTarget_HeaderOverride

type HttpTarget_HeaderOverride struct {

	// header embodying a key and a value.
	Header *HttpTarget_Header `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// contains filtered or unexported fields
}

Wraps the Header object.

func (*HttpTarget_HeaderOverride) Descriptor

func (*HttpTarget_HeaderOverride) Descriptor() ([]byte, []int)

Deprecated: Use HttpTarget_HeaderOverride.ProtoReflect.Descriptor instead.

func (*HttpTarget_HeaderOverride) GetHeader

func (x *HttpTarget_HeaderOverride) GetHeader() *HttpTarget_Header

func (*HttpTarget_HeaderOverride) ProtoMessage

func (*HttpTarget_HeaderOverride) ProtoMessage()

func (*HttpTarget_HeaderOverride) ProtoReflect

func (x *HttpTarget_HeaderOverride) ProtoReflect() protoreflect.Message

func (*HttpTarget_HeaderOverride) Reset

func (x *HttpTarget_HeaderOverride) Reset()

func (*HttpTarget_HeaderOverride) String

func (x *HttpTarget_HeaderOverride) String() string

HttpTarget_OauthToken

type HttpTarget_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"`
}

HttpTarget_OidcToken

type HttpTarget_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"`
}

LeaseTasksRequest

type LeaseTasksRequest struct {
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`

	MaxTasks int32 `protobuf:"varint,2,opt,name=max_tasks,json=maxTasks,proto3" json:"max_tasks,omitempty"`

	LeaseDuration *durationpb.Duration `protobuf:"bytes,3,opt,name=lease_duration,json=leaseDuration,proto3" json:"lease_duration,omitempty"`

	ResponseView Task_View "" /* 140 byte string literal not displayed */

	Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`

}

Request message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].

func (*LeaseTasksRequest) Descriptor

func (*LeaseTasksRequest) Descriptor() ([]byte, []int)

Deprecated: Use LeaseTasksRequest.ProtoReflect.Descriptor instead.

func (*LeaseTasksRequest) GetFilter

func (x *LeaseTasksRequest) GetFilter() string

func (*LeaseTasksRequest) GetLeaseDuration

func (x *LeaseTasksRequest) GetLeaseDuration() *durationpb.Duration

func (*LeaseTasksRequest) GetMaxTasks

func (x *LeaseTasksRequest) GetMaxTasks() int32

func (*LeaseTasksRequest) GetParent

func (x *LeaseTasksRequest) GetParent() string

func (*LeaseTasksRequest) GetResponseView

func (x *LeaseTasksRequest) GetResponseView() Task_View

func (*LeaseTasksRequest) ProtoMessage

func (*LeaseTasksRequest) ProtoMessage()

func (*LeaseTasksRequest) ProtoReflect

func (x *LeaseTasksRequest) ProtoReflect() protoreflect.Message

func (*LeaseTasksRequest) Reset

func (x *LeaseTasksRequest) Reset()

func (*LeaseTasksRequest) String

func (x *LeaseTasksRequest) String() string

LeaseTasksResponse

type LeaseTasksResponse struct {

	// The leased tasks.
	Tasks []*Task `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
	// contains filtered or unexported fields
}

Response message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].

func (*LeaseTasksResponse) Descriptor

func (*LeaseTasksResponse) Descriptor() ([]byte, []int)

Deprecated: Use LeaseTasksResponse.ProtoReflect.Descriptor instead.

func (*LeaseTasksResponse) GetTasks

func (x *LeaseTasksResponse) GetTasks() []*Task

func (*LeaseTasksResponse) ProtoMessage

func (*LeaseTasksResponse) ProtoMessage()

func (*LeaseTasksResponse) ProtoReflect

func (x *LeaseTasksResponse) ProtoReflect() protoreflect.Message

func (*LeaseTasksResponse) Reset

func (x *LeaseTasksResponse) Reset()

func (*LeaseTasksResponse) String

func (x *LeaseTasksResponse) String() string

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.v2beta2.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 "app_engine_http_target: *".
	//
	// 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.v2beta2.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.v2beta2.ListQueuesResponse.next_page_token]
	// returned from the previous call to
	// [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues] method. It
	// is an error to switch the value of the
	// [filter][google.cloud.tasks.v2beta2.ListQueuesRequest.filter] while
	// iterating through pages.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Read mask is used for a more granular control over what the API
	// returns. If the mask is not present all fields will be returned except
	// [Queue.stats]. [Queue.stats] will be returned only if it was  explicitly
	// specified in the mask.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ListQueues][google.cloud.tasks.v2beta2.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) GetReadMask

func (x *ListQueuesRequest) GetReadMask() *fieldmaskpb.FieldMask

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.v2beta2.CloudTasks.ListQueues] with this
	// value as the
	// [page_token][google.cloud.tasks.v2beta2.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.v2beta2.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 "" /* 140 byte string literal not displayed */

	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`

	PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`

}

Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.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.v2beta2.CloudTasks.ListTasks] with this
	// value as the
	// [page_token][google.cloud.tasks.v2beta2.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.v2beta2.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

func (*OidcToken) Descriptor() ([]byte, []int)

Deprecated: Use OidcToken.ProtoReflect.Descriptor instead.

func (*OidcToken) GetAudience

func (x *OidcToken) GetAudience() string

func (*OidcToken) GetServiceAccountEmail

func (x *OidcToken) GetServiceAccountEmail() string

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

func (x *OidcToken) String() string

PathOverride

type PathOverride struct {

	// The URI path (e.g., /users/1234). Default is an empty string.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

PathOverride.

Path message defines path override for HTTP targets.

func (*PathOverride) Descriptor

func (*PathOverride) Descriptor() ([]byte, []int)

Deprecated: Use PathOverride.ProtoReflect.Descriptor instead.

func (*PathOverride) GetPath

func (x *PathOverride) GetPath() string

func (*PathOverride) ProtoMessage

func (*PathOverride) ProtoMessage()

func (*PathOverride) ProtoReflect

func (x *PathOverride) ProtoReflect() protoreflect.Message

func (*PathOverride) Reset

func (x *PathOverride) Reset()

func (*PathOverride) String

func (x *PathOverride) String() 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.v2beta2.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

PullMessage

type PullMessage struct {

	// A data payload consumed by the worker to execute the task.
	Payload []byte `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
	// The task's tag.
	//
	// Tags allow similar tasks to be processed in a batch. If you label
	// tasks with a tag, your worker can
	// [lease tasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] with the
	// same tag using
	// [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter]. For example,
	// if you want to aggregate the events associated with a specific user once a
	// day, you could tag tasks with the user ID.
	//
	// The task's tag can only be set when the
	// [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
	//
	// The tag must be less than 500 characters.
	//
	// SDK compatibility: Although the SDK allows tags to be either
	// string or
	// [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
	// only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
	// encoded, the tag will be empty when the task is returned by Cloud Tasks.
	Tag string `protobuf:"bytes,2,opt,name=tag,proto3" json:"tag,omitempty"`
	// contains filtered or unexported fields
}

The pull message contains data that can be used by the caller of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task.

This proto can only be used for tasks in a queue which has [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] set.

func (*PullMessage) Descriptor

func (*PullMessage) Descriptor() ([]byte, []int)

Deprecated: Use PullMessage.ProtoReflect.Descriptor instead.

func (*PullMessage) GetPayload

func (x *PullMessage) GetPayload() []byte

func (*PullMessage) GetTag

func (x *PullMessage) GetTag() string

func (*PullMessage) ProtoMessage

func (*PullMessage) ProtoMessage()

func (*PullMessage) ProtoReflect

func (x *PullMessage) ProtoReflect() protoreflect.Message

func (*PullMessage) Reset

func (x *PullMessage) Reset()

func (*PullMessage) String

func (x *PullMessage) String() string

PullTarget

type PullTarget struct {
	// contains filtered or unexported fields
}

Pull target.

func (*PullTarget) Descriptor

func (*PullTarget) Descriptor() ([]byte, []int)

Deprecated: Use PullTarget.ProtoReflect.Descriptor instead.

func (*PullTarget) ProtoMessage

func (*PullTarget) ProtoMessage()

func (*PullTarget) ProtoReflect

func (x *PullTarget) ProtoReflect() protoreflect.Message

func (*PullTarget) Reset

func (x *PullTarget) Reset()

func (*PullTarget) String

func (x *PullTarget) 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.v2beta2.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

QueryOverride

type QueryOverride struct {

	// The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty
	// string.
	QueryParams string `protobuf:"bytes,1,opt,name=query_params,json=queryParams,proto3" json:"query_params,omitempty"`
	// contains filtered or unexported fields
}

QueryOverride.

Query message defines query override for HTTP targets.

func (*QueryOverride) Descriptor

func (*QueryOverride) Descriptor() ([]byte, []int)

Deprecated: Use QueryOverride.ProtoReflect.Descriptor instead.

func (*QueryOverride) GetQueryParams

func (x *QueryOverride) GetQueryParams() string

func (*QueryOverride) ProtoMessage

func (*QueryOverride) ProtoMessage()

func (*QueryOverride) ProtoReflect

func (x *QueryOverride) ProtoReflect() protoreflect.Message

func (*QueryOverride) Reset

func (x *QueryOverride) Reset()

func (*QueryOverride) String

func (x *QueryOverride) String() string

Queue

type Queue struct {

	// Caller-specified and required in
	// [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue], after
	// which it becomes output only.
	//
	// The queue name.
	//
	// The queue name must have the following format:
	// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
	//
	//   - `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
	//     hyphens (-), colons (:), or periods (.).
	//     For more information, see
	//     [Identifying
	//     projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
	//   - `LOCATION_ID` is the canonical ID for the queue'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.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Caller-specified and required in
	// [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue][], after
	// which the queue config type becomes output only, though fields within the
	// config are mutable.
	//
	// The queue's target.
	//
	// The target applies to all tasks in the queue.
	//
	// Types that are assignable to TargetType:
	//
	//	*Queue_AppEngineHttpTarget
	//	*Queue_PullTarget
	//	*Queue_HttpTarget
	TargetType isQueue_TargetType `protobuf_oneof:"target_type"`
	// Rate limits for task dispatches.
	//
	// [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and
	// [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related
	// because they both control task attempts however they control how tasks are
	// attempted in different ways:
	//
	// * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the
	// total rate of
	//
	//	dispatches from a queue (i.e. all traffic dispatched from the
	//	queue, regardless of whether the dispatch is from a first
	//	attempt or a retry).
	//
	// * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls
	// what happens to
	//
	//	particular a task after its first attempt fails. That is,
	//	[retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls
	//	task retries (the second attempt, third attempt, etc).
	RateLimits *RateLimits `protobuf:"bytes,5,opt,name=rate_limits,json=rateLimits,proto3" json:"rate_limits,omitempty"`
	// Settings that determine the retry behavior.
	//
	//   - For tasks created using Cloud Tasks: the queue-level retry settings
	//     apply to all tasks in the queue that were created using Cloud Tasks.
	//     Retry settings cannot be set on individual tasks.
	//   - For tasks created using the App Engine SDK: the queue-level retry
	//     settings apply to all tasks in the queue which do not have retry settings
	//     explicitly set on the task and were created by the App Engine SDK. See
	//     [App Engine
	//     documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
	RetryConfig *RetryConfig `protobuf:"bytes,6,opt,name=retry_config,json=retryConfig,proto3" json:"retry_config,omitempty"`
	// Output only. The state of the queue.
	//
	// `state` can only be changed by called
	// [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue],
	// [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue], or
	// uploading
	// [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
	// [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] cannot be
	// used to change `state`.
	State Queue_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.cloud.tasks.v2beta2.Queue_State" json:"state,omitempty"`
	// Output only. The last time this queue was purged.
	//
	// All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time]
	// before this time were purged.
	//
	// A queue can be purged using
	// [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the [App
	// Engine Task Queue SDK, or the Cloud
	// Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
	//
	// Purge time will be truncated to the nearest microsecond. Purge
	// time will be unset if the queue has never been purged.
	PurgeTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=purge_time,json=purgeTime,proto3" json:"purge_time,omitempty"`
	// The maximum amount of time that a task will be retained in
	// this queue.
	//
	// Queues created by Cloud Tasks have a default `task_ttl` of 31 days.
	// After a task has lived for `task_ttl`, the task will be deleted
	// regardless of whether it was dispatched or not.
	//
	// The `task_ttl` for queues created via queue.yaml/xml is equal to the
	// maximum duration because there is a
	// [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for
	// these queues. To view the maximum valid duration, see the documentation for
	// [Duration][google.protobuf.Duration].
	TaskTtl *durationpb.Duration `protobuf:"bytes,9,opt,name=task_ttl,json=taskTtl,proto3" json:"task_ttl,omitempty"`
	// The task tombstone time to live (TTL).
	//
	// After a task is deleted or completed, the task's tombstone is
	// retained for the length of time specified by `tombstone_ttl`.
	// The tombstone is used by task de-duplication; another task with the same
	// name can't be created until the tombstone has expired. For more information
	// about task de-duplication, see the documentation for
	// [CreateTaskRequest][google.cloud.tasks.v2beta2.CreateTaskRequest.task].
	//
	// Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
	TombstoneTtl *durationpb.Duration `protobuf:"bytes,10,opt,name=tombstone_ttl,json=tombstoneTtl,proto3" json:"tombstone_ttl,omitempty"`
	// Output only. The realtime, informational statistics for a queue. In order
	// to receive the statistics the caller should include this field in the
	// FieldMask.
	Stats *QueueStats `protobuf:"bytes,16,opt,name=stats,proto3" json:"stats,omitempty"`
	// contains filtered or unexported fields
}

A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, target types, and others.

func (*Queue) Descriptor

func (*Queue) Descriptor() ([]byte, []int)

Deprecated: Use Queue.ProtoReflect.Descriptor instead.

func (*Queue) GetAppEngineHttpTarget

func (x *Queue) GetAppEngineHttpTarget() *AppEngineHttpTarget

func (*Queue) GetHttpTarget

func (x *Queue) GetHttpTarget() *HttpTarget

func (*Queue) GetName

func (x *Queue) GetName() string

func (*Queue) GetPullTarget

func (x *Queue) GetPullTarget() *PullTarget

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) GetState

func (x *Queue) GetState() Queue_State

func (*Queue) GetStats

func (x *Queue) GetStats() *QueueStats

func (*Queue) GetTargetType

func (m *Queue) GetTargetType() isQueue_TargetType

func (*Queue) GetTaskTtl

func (x *Queue) GetTaskTtl() *durationpb.Duration

func (*Queue) GetTombstoneTtl

func (x *Queue) GetTombstoneTtl() *durationpb.Duration

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

func (x *Queue) String() string

QueueStats

type QueueStats struct {
	TasksCount int64 `protobuf:"varint,1,opt,name=tasks_count,json=tasksCount,proto3" json:"tasks_count,omitempty"`

	OldestEstimatedArrivalTime *timestamppb.Timestamp "" /* 143 byte string literal not displayed */

	ExecutedLastMinuteCount int64 "" /* 135 byte string literal not displayed */

	ConcurrentDispatchesCount int64 "" /* 139 byte string literal not displayed */

	EffectiveExecutionRate float64 "" /* 131 byte string literal not displayed */

}

Statistics for a queue.

func (*QueueStats) Descriptor

func (*QueueStats) Descriptor() ([]byte, []int)

Deprecated: Use QueueStats.ProtoReflect.Descriptor instead.

func (*QueueStats) GetConcurrentDispatchesCount

func (x *QueueStats) GetConcurrentDispatchesCount() int64

func (*QueueStats) GetEffectiveExecutionRate

func (x *QueueStats) GetEffectiveExecutionRate() float64

func (*QueueStats) GetExecutedLastMinuteCount

func (x *QueueStats) GetExecutedLastMinuteCount() int64

func (*QueueStats) GetOldestEstimatedArrivalTime

func (x *QueueStats) GetOldestEstimatedArrivalTime() *timestamppb.Timestamp

func (*QueueStats) GetTasksCount

func (x *QueueStats) GetTasksCount() int64

func (*QueueStats) ProtoMessage

func (*QueueStats) ProtoMessage()

func (*QueueStats) ProtoReflect

func (x *QueueStats) ProtoReflect() protoreflect.Message

func (*QueueStats) Reset

func (x *QueueStats) Reset()

func (*QueueStats) String

func (x *QueueStats) String() string

Queue_AppEngineHttpTarget

type Queue_AppEngineHttpTarget struct {
	// App Engine HTTP target.
	//
	// An App Engine queue is a queue that has an
	// [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget].
	AppEngineHttpTarget *AppEngineHttpTarget `protobuf:"bytes,3,opt,name=app_engine_http_target,json=appEngineHttpTarget,proto3,oneof"`
}

Queue_HttpTarget

type Queue_HttpTarget struct {
	// An http_target is used to override the target values for HTTP tasks.
	HttpTarget *HttpTarget `protobuf:"bytes,17,opt,name=http_target,json=httpTarget,proto3,oneof"`
}

Queue_PullTarget

type Queue_PullTarget struct {
	// Pull target.
	//
	// A pull queue is a queue that has a
	// [PullTarget][google.cloud.tasks.v2beta2.PullTarget].
	PullTarget *PullTarget `protobuf:"bytes,4,opt,name=pull_target,json=pullTarget,proto3,oneof"`
}

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. When a pull queue is paused,
	// all [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls
	// will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION].
	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 and
	// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls
	// return a `FAILED_PRECONDITION` error.
	//
	// To permanently delete this queue and all of its tasks, call
	// [DeleteQueue][google.cloud.tasks.v2beta2.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 {
	MaxTasksDispatchedPerSecond float64 "" /* 150 byte string literal not displayed */

	MaxBurstSize int32 `protobuf:"varint,2,opt,name=max_burst_size,json=maxBurstSize,proto3" json:"max_burst_size,omitempty"`

	MaxConcurrentTasks int32 `protobuf:"varint,3,opt,name=max_concurrent_tasks,json=maxConcurrentTasks,proto3" json:"max_concurrent_tasks,omitempty"`

}

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.v2beta2.CloudTasks.RunTask], will run a task even if the queue has reached its [RateLimits][google.cloud.tasks.v2beta2.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) GetMaxConcurrentTasks

func (x *RateLimits) GetMaxConcurrentTasks() int32

func (*RateLimits) GetMaxTasksDispatchedPerSecond

func (x *RateLimits) GetMaxTasksDispatchedPerSecond() 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

RenewLeaseRequest

type RenewLeaseRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	ScheduleTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=schedule_time,json=scheduleTime,proto3" json:"schedule_time,omitempty"`

	LeaseDuration *durationpb.Duration `protobuf:"bytes,3,opt,name=lease_duration,json=leaseDuration,proto3" json:"lease_duration,omitempty"`

	ResponseView Task_View "" /* 140 byte string literal not displayed */

}

Request message for renewing a lease using [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease].

func (*RenewLeaseRequest) Descriptor

func (*RenewLeaseRequest) Descriptor() ([]byte, []int)

Deprecated: Use RenewLeaseRequest.ProtoReflect.Descriptor instead.

func (*RenewLeaseRequest) GetLeaseDuration

func (x *RenewLeaseRequest) GetLeaseDuration() *durationpb.Duration

func (*RenewLeaseRequest) GetName

func (x *RenewLeaseRequest) GetName() string

func (*RenewLeaseRequest) GetResponseView

func (x *RenewLeaseRequest) GetResponseView() Task_View

func (*RenewLeaseRequest) GetScheduleTime

func (x *RenewLeaseRequest) GetScheduleTime() *timestamppb.Timestamp

func (*RenewLeaseRequest) ProtoMessage

func (*RenewLeaseRequest) ProtoMessage()

func (*RenewLeaseRequest) ProtoReflect

func (x *RenewLeaseRequest) ProtoReflect() protoreflect.Message

func (*RenewLeaseRequest) Reset

func (x *RenewLeaseRequest) Reset()

func (*RenewLeaseRequest) String

func (x *RenewLeaseRequest) 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.v2beta2.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.
	//
	// If unspecified when the queue is created, Cloud Tasks will pick the
	// default.
	//
	// 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).
	//
	// Types that are assignable to NumAttempts:
	//
	//	*RetryConfig_MaxAttempts
	//	*RetryConfig_UnlimitedAttempts
	NumAttempts isRetryConfig_NumAttempts `protobuf_oneof:"num_attempts"`
	// 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.v2beta2.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.
	//
	// This field is output only for [pull
	// queues][google.cloud.tasks.v2beta2.PullTarget].
	//
	// `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,3,opt,name=max_retry_duration,json=maxRetryDuration,proto3" json:"max_retry_duration,omitempty"`
	// A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time]
	// for retry between
	// [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
	// [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration
	// after it fails, if the queue's
	// [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the
	// task should be retried.
	//
	// If unspecified when the queue is created, Cloud Tasks will pick the
	// default.
	//
	// This field is output only for [pull
	// queues][google.cloud.tasks.v2beta2.PullTarget].
	//
	// `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,4,opt,name=min_backoff,json=minBackoff,proto3" json:"min_backoff,omitempty"`
	// A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time]
	// for retry between
	// [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
	// [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration
	// after it fails, if the queue's
	// [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the
	// task should be retried.
	//
	// If unspecified when the queue is created, Cloud Tasks will pick the
	// default.
	//
	// This field is output only for [pull
	// queues][google.cloud.tasks.v2beta2.PullTarget].
	//
	// `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,5,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.v2beta2.RetryConfig.min_backoff], then
	// doubles `max_doublings` times, then increases linearly, and finally retries
	// at intervals of
	// [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] up to
	// [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] times.
	//
	// For example, if
	// [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] is 10s,
	// [max_backoff][google.cloud.tasks.v2beta2.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.v2beta2.RetryConfig.max_backoff] until the
	// task has been attempted
	// [max_attempts][google.cloud.tasks.v2beta2.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 is output only for [pull
	// queues][google.cloud.tasks.v2beta2.PullTarget].
	//
	// 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,6,opt,name=max_doublings,json=maxDoublings,proto3" json:"max_doublings,omitempty"`
	// contains filtered or unexported fields
}

Retry config.

These settings determine how 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) GetNumAttempts

func (m *RetryConfig) GetNumAttempts() isRetryConfig_NumAttempts

func (*RetryConfig) GetUnlimitedAttempts

func (x *RetryConfig) GetUnlimitedAttempts() bool

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

RetryConfig_MaxAttempts

type RetryConfig_MaxAttempts struct {
	// The maximum number of attempts for a 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 > 0.
	MaxAttempts int32 `protobuf:"varint,1,opt,name=max_attempts,json=maxAttempts,proto3,oneof"`
}

RetryConfig_UnlimitedAttempts

type RetryConfig_UnlimitedAttempts struct {
	// If true, then the number of attempts is unlimited.
	UnlimitedAttempts bool `protobuf:"varint,2,opt,name=unlimited_attempts,json=unlimitedAttempts,proto3,oneof"`
}

RunTaskRequest

type RunTaskRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	ResponseView Task_View "" /* 140 byte string literal not displayed */

}

Request message for forcing a task to run now using [RunTask][google.cloud.tasks.v2beta2.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

Task

type Task struct {

	// Optionally caller-specified in
	// [CreateTask][google.cloud.tasks.v2beta2.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 task's payload is used by the task's target to process the task.
	// A payload is valid only if it is compatible with the queue's target.
	//
	// Types that are assignable to PayloadType:
	//
	//	*Task_AppEngineHttpRequest
	//	*Task_PullMessage
	//	*Task_HttpRequest
	PayloadType isTask_PayloadType `protobuf_oneof:"payload_type"`
	// The time when the task is scheduled to be attempted.
	//
	// For App Engine queues, this is when the task will be attempted or retried.
	//
	// For pull queues, this is the time when the task is available to
	// be leased; if a task is currently leased, this is the time when
	// the current lease expires, that is, the time that the task was
	// leased plus the
	// [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
	//
	// `schedule_time` will be truncated to the nearest microsecond.
	ScheduleTime *timestamppb.Timestamp `protobuf:"bytes,5,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,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The task status.
	Status *TaskStatus `protobuf:"bytes,7,opt,name=status,proto3" json:"status,omitempty"`
	// Output only. The view specifies which subset of the
	// [Task][google.cloud.tasks.v2beta2.Task] has been returned.
	View Task_View `protobuf:"varint,8,opt,name=view,proto3,enum=google.cloud.tasks.v2beta2.Task_View" json:"view,omitempty"`
	// contains filtered or unexported fields
}

A unit of scheduled work.

func (*Task) Descriptor

func (*Task) Descriptor() ([]byte, []int)

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) GetHttpRequest

func (x *Task) GetHttpRequest() *HttpRequest

func (*Task) GetName

func (x *Task) GetName() string

func (*Task) GetPayloadType

func (m *Task) GetPayloadType() isTask_PayloadType

func (*Task) GetPullMessage

func (x *Task) GetPullMessage() *PullMessage

func (*Task) GetScheduleTime

func (x *Task) GetScheduleTime() *timestamppb.Timestamp

func (*Task) GetStatus

func (x *Task) GetStatus() *TaskStatus

func (*Task) GetView

func (x *Task) GetView() Task_View

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

func (x *Task) String() string

TaskStatus

type TaskStatus struct {

	// Output only. The number of attempts dispatched.
	//
	// This count includes attempts which have been dispatched but haven't
	// received a response.
	AttemptDispatchCount int32 `protobuf:"varint,1,opt,name=attempt_dispatch_count,json=attemptDispatchCount,proto3" json:"attempt_dispatch_count,omitempty"`
	// Output only. The number of attempts which have received a response.
	//
	// This field is not calculated for [pull
	// tasks][google.cloud.tasks.v2beta2.PullMessage].
	AttemptResponseCount int32 `protobuf:"varint,2,opt,name=attempt_response_count,json=attemptResponseCount,proto3" json:"attempt_response_count,omitempty"`
	// Output only. The status of the task's first attempt.
	//
	// Only
	// [dispatch_time][google.cloud.tasks.v2beta2.AttemptStatus.dispatch_time]
	// will be set. The other
	// [AttemptStatus][google.cloud.tasks.v2beta2.AttemptStatus] information is
	// not retained by Cloud Tasks.
	//
	// This field is not calculated for [pull
	// tasks][google.cloud.tasks.v2beta2.PullMessage].
	FirstAttemptStatus *AttemptStatus `protobuf:"bytes,3,opt,name=first_attempt_status,json=firstAttemptStatus,proto3" json:"first_attempt_status,omitempty"`
	// Output only. The status of the task's last attempt.
	//
	// This field is not calculated for [pull
	// tasks][google.cloud.tasks.v2beta2.PullMessage].
	LastAttemptStatus *AttemptStatus `protobuf:"bytes,4,opt,name=last_attempt_status,json=lastAttemptStatus,proto3" json:"last_attempt_status,omitempty"`
	// contains filtered or unexported fields
}

Status of the task.

func (*TaskStatus) Descriptor

func (*TaskStatus) Descriptor() ([]byte, []int)

Deprecated: Use TaskStatus.ProtoReflect.Descriptor instead.

func (*TaskStatus) GetAttemptDispatchCount

func (x *TaskStatus) GetAttemptDispatchCount() int32

func (*TaskStatus) GetAttemptResponseCount

func (x *TaskStatus) GetAttemptResponseCount() int32

func (*TaskStatus) GetFirstAttemptStatus

func (x *TaskStatus) GetFirstAttemptStatus() *AttemptStatus

func (*TaskStatus) GetLastAttemptStatus

func (x *TaskStatus) GetLastAttemptStatus() *AttemptStatus

func (*TaskStatus) ProtoMessage

func (*TaskStatus) ProtoMessage()

func (*TaskStatus) ProtoReflect

func (x *TaskStatus) ProtoReflect() protoreflect.Message

func (*TaskStatus) Reset

func (x *TaskStatus) Reset()

func (*TaskStatus) String

func (x *TaskStatus) String() string

Task_AppEngineHttpRequest

type Task_AppEngineHttpRequest struct {
	// App Engine HTTP request that is sent to the task's target. Can
	// be set only if
	// [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target]
	// is set on the queue.
	//
	// An App Engine task is a task that has
	// [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]
	// set.
	AppEngineHttpRequest *AppEngineHttpRequest `protobuf:"bytes,3,opt,name=app_engine_http_request,json=appEngineHttpRequest,proto3,oneof"`
}

Task_HttpRequest

type Task_HttpRequest struct {
	// HTTP request that is sent to the task's target.
	//
	// An HTTP task is a task that has
	// [HttpRequest][google.cloud.tasks.v2beta2.HttpRequest] set.
	HttpRequest *HttpRequest `protobuf:"bytes,13,opt,name=http_request,json=httpRequest,proto3,oneof"`
}

Task_PullMessage

type Task_PullMessage struct {
	// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process
	// the task. Can be set only if
	// [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the
	// queue.
	//
	// A pull task is a task that has
	// [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set.
	PullMessage *PullMessage `protobuf:"bytes,4,opt,name=pull_message,json=pullMessage,proto3,oneof"`
}

Task_View

type Task_View int32

The view specifies a subset of [Task][google.cloud.tasks.v2beta2.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
	// ([payload in
	// AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]
	// and [payload in
	// PullMessage][google.cloud.tasks.v2beta2.PullMessage.payload]). These
	// payloads are desirable to return only when needed, because they can be
	// large and because of the sensitivity of the data that you choose to store
	// in it.
	Task_BASIC Task_View = 1
	// All information is returned.
	//
	// Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL]
	// requires `cloudtasks.tasks.fullView` [Google
	// IAM](https://cloud.google.com/iam/) permission on the
	// [Queue][google.cloud.tasks.v2beta2.Queue] resource.
	Task_FULL Task_View = 2
)

func (Task_View) Descriptor

func (Task_View) Descriptor() protoreflect.EnumDescriptor

func (Task_View) Enum

func (x Task_View) Enum() *Task_View

func (Task_View) EnumDescriptor

func (Task_View) EnumDescriptor() ([]byte, []int)

Deprecated: Use Task_View.Descriptor instead.

func (Task_View) Number

func (x Task_View) Number() protoreflect.EnumNumber

func (Task_View) String

func (x Task_View) String() 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) AcknowledgeTask

func (*UnimplementedCloudTasksServer) AcknowledgeTask(context.Context, *AcknowledgeTaskRequest) (*emptypb.Empty, error)

func (*UnimplementedCloudTasksServer) CancelLease

func (*UnimplementedCloudTasksServer) CancelLease(context.Context, *CancelLeaseRequest) (*Task, error)

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, *iampb.GetIamPolicyRequest) (*iampb.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) LeaseTasks

func (*UnimplementedCloudTasksServer) LeaseTasks(context.Context, *LeaseTasksRequest) (*LeaseTasksResponse, 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) RenewLease

func (*UnimplementedCloudTasksServer) RenewLease(context.Context, *RenewLeaseRequest) (*Task, 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, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)

func (*UnimplementedCloudTasksServer) TestIamPermissions

func (*UnimplementedCloudTasksServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)

func (*UnimplementedCloudTasksServer) UpdateQueue

func (*UnimplementedCloudTasksServer) UpdateQueue(context.Context, *UpdateQueueRequest) (*Queue, error)

func (*UnimplementedCloudTasksServer) UploadQueueYaml

func (*UnimplementedCloudTasksServer) UploadQueueYaml(context.Context, *UploadQueueYamlRequest) (*emptypb.Empty, error)

UpdateQueueRequest

type UpdateQueueRequest struct {

	// Required. The queue to create or update.
	//
	// The queue's [name][google.cloud.tasks.v2beta2.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.v2beta2.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.v2beta2.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

UploadQueueYamlRequest

type UploadQueueYamlRequest struct {

	// Required. The App ID is supplied as an HTTP parameter. Unlike internal
	// usage of App ID, it does not include a region prefix. Rather, the App ID
	// represents the Project ID against which to make the request.
	AppId string `protobuf:"bytes,1,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"`
	// The http body contains the queue.yaml file which used to update queue lists
	HttpBody *httpbody.HttpBody `protobuf:"bytes,2,opt,name=http_body,json=httpBody,proto3,oneof" json:"http_body,omitempty"`
	// contains filtered or unexported fields
}

Request message for [UploadQueueYaml][google.cloud.tasks.v2beta2.CloudTasks.UploadQueueYaml].

func (*UploadQueueYamlRequest) Descriptor

func (*UploadQueueYamlRequest) Descriptor() ([]byte, []int)

Deprecated: Use UploadQueueYamlRequest.ProtoReflect.Descriptor instead.

func (*UploadQueueYamlRequest) GetAppId

func (x *UploadQueueYamlRequest) GetAppId() string

func (*UploadQueueYamlRequest) GetHttpBody

func (x *UploadQueueYamlRequest) GetHttpBody() *httpbody.HttpBody

func (*UploadQueueYamlRequest) ProtoMessage

func (*UploadQueueYamlRequest) ProtoMessage()

func (*UploadQueueYamlRequest) ProtoReflect

func (x *UploadQueueYamlRequest) ProtoReflect() protoreflect.Message

func (*UploadQueueYamlRequest) Reset

func (x *UploadQueueYamlRequest) Reset()

func (*UploadQueueYamlRequest) String

func (x *UploadQueueYamlRequest) String() string

UriOverride

type UriOverride struct {
	Scheme *UriOverride_Scheme `protobuf:"varint,1,opt,name=scheme,proto3,enum=google.cloud.tasks.v2beta2.UriOverride_Scheme,oneof" json:"scheme,omitempty"`

	Host *string `protobuf:"bytes,2,opt,name=host,proto3,oneof" json:"host,omitempty"`

	Port *int64 `protobuf:"varint,3,opt,name=port,proto3,oneof" json:"port,omitempty"`

	PathOverride *PathOverride `protobuf:"bytes,4,opt,name=path_override,json=pathOverride,proto3" json:"path_override,omitempty"`

	QueryOverride *QueryOverride `protobuf:"bytes,5,opt,name=query_override,json=queryOverride,proto3" json:"query_override,omitempty"`

	UriOverrideEnforceMode UriOverride_UriOverrideEnforceMode "" /* 199 byte string literal not displayed */

}

Uri Override.

When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.

func (*UriOverride) Descriptor

func (*UriOverride) Descriptor() ([]byte, []int)

Deprecated: Use UriOverride.ProtoReflect.Descriptor instead.

func (*UriOverride) GetHost

func (x *UriOverride) GetHost() string

func (*UriOverride) GetPathOverride

func (x *UriOverride) GetPathOverride() *PathOverride

func (*UriOverride) GetPort

func (x *UriOverride) GetPort() int64

func (*UriOverride) GetQueryOverride

func (x *UriOverride) GetQueryOverride() *QueryOverride

func (*UriOverride) GetScheme

func (x *UriOverride) GetScheme() UriOverride_Scheme

func (*UriOverride) GetUriOverrideEnforceMode

func (x *UriOverride) GetUriOverrideEnforceMode() UriOverride_UriOverrideEnforceMode

func (*UriOverride) ProtoMessage

func (*UriOverride) ProtoMessage()

func (*UriOverride) ProtoReflect

func (x *UriOverride) ProtoReflect() protoreflect.Message

func (*UriOverride) Reset

func (x *UriOverride) Reset()

func (*UriOverride) String

func (x *UriOverride) String() string

UriOverride_Scheme

type UriOverride_Scheme int32

The Scheme for an HTTP request. By default, it is HTTPS.

UriOverride_SCHEME_UNSPECIFIED, UriOverride_HTTP, UriOverride_HTTPS

const (
	// Scheme unspecified. Defaults to HTTPS.
	UriOverride_SCHEME_UNSPECIFIED UriOverride_Scheme = 0
	// Convert the scheme to HTTP, e.g., https://www.google.ca will change to
	// http://www.google.ca.
	UriOverride_HTTP UriOverride_Scheme = 1
	// Convert the scheme to HTTPS, e.g., http://www.google.ca will change to
	// https://www.google.ca.
	UriOverride_HTTPS UriOverride_Scheme = 2
)

func (UriOverride_Scheme) Descriptor

func (UriOverride_Scheme) Descriptor() protoreflect.EnumDescriptor

func (UriOverride_Scheme) Enum

func (x UriOverride_Scheme) Enum() *UriOverride_Scheme

func (UriOverride_Scheme) EnumDescriptor

func (UriOverride_Scheme) EnumDescriptor() ([]byte, []int)

Deprecated: Use UriOverride_Scheme.Descriptor instead.

func (UriOverride_Scheme) Number

func (x UriOverride_Scheme) Number() protoreflect.EnumNumber

func (UriOverride_Scheme) String

func (x UriOverride_Scheme) String() string

func (UriOverride_Scheme) Type

func (UriOverride_Scheme) Type() protoreflect.EnumType

UriOverride_UriOverrideEnforceMode

type UriOverride_UriOverrideEnforceMode int32

UriOverrideEnforceMode mode is to define enforcing mode for the override modes.

UriOverride_URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED, UriOverride_IF_NOT_EXISTS, UriOverride_ALWAYS

const (
	// OverrideMode Unspecified. Defaults to ALWAYS.
	UriOverride_URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED UriOverride_UriOverrideEnforceMode = 0
	// In the IF_NOT_EXISTS mode, queue-level configuration is only
	// applied where task-level configuration does not exist.
	UriOverride_IF_NOT_EXISTS UriOverride_UriOverrideEnforceMode = 1
	// In the ALWAYS mode, queue-level configuration overrides all
	// task-level configuration
	UriOverride_ALWAYS UriOverride_UriOverrideEnforceMode = 2
)

func (UriOverride_UriOverrideEnforceMode) Descriptor

func (UriOverride_UriOverrideEnforceMode) Descriptor() protoreflect.EnumDescriptor

func (UriOverride_UriOverrideEnforceMode) Enum

func (x UriOverride_UriOverrideEnforceMode) Enum() *UriOverride_UriOverrideEnforceMode

func (UriOverride_UriOverrideEnforceMode) EnumDescriptor

func (UriOverride_UriOverrideEnforceMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use UriOverride_UriOverrideEnforceMode.Descriptor instead.

func (UriOverride_UriOverrideEnforceMode) Number

func (x UriOverride_UriOverrideEnforceMode) Number() protoreflect.EnumNumber

func (UriOverride_UriOverrideEnforceMode) String

func (x UriOverride_UriOverrideEnforceMode) String() string

func (UriOverride_UriOverrideEnforceMode) Type

func (UriOverride_UriOverrideEnforceMode) Type() protoreflect.EnumType