@Generated("by gapic-generator-java")
Package com.google.cloud.tasks.v2beta2
A client to Cloud Tasks API
The interfaces provided are listed below, along with usage samples.
======================= CloudTasksClient =======================
Service Description: Cloud Tasks allows developers to manage the execution of background work in their applications.
Sample for CloudTasksClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (CloudTasksClient cloudTasksClient = CloudTasksClient.create()) {
QueueName name = QueueName.of("[PROJECT]", "[LOCATION]", "[QUEUE]");
Queue response = cloudTasksClient.getQueue(name);
}
-
Class Summary Class Description AcknowledgeTaskRequest Request message for acknowledging a task using [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask].AcknowledgeTaskRequest.Builder Request message for acknowledging a task using [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask].AppEngineHttpRequest App Engine HTTP request.AppEngineHttpRequest.Builder App Engine HTTP request.AppEngineHttpTarget App Engine HTTP target.AppEngineHttpTarget.Builder App Engine HTTP target.AppEngineRouting App Engine Routing.AppEngineRouting.Builder App Engine Routing.AttemptStatus The status of a task attempt.AttemptStatus.Builder The status of a task attempt.BufferTaskRequest LINT.IfChange Request message for [BufferTask][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].BufferTaskRequest.Builder LINT.IfChange Request message for [BufferTask][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].BufferTaskResponse Response message for [BufferTask][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].BufferTaskResponse.Builder Response message for [BufferTask][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].CancelLeaseRequest Request message for canceling a lease using [CancelLease][google.cloud.tasks.v2beta2.CloudTasks.CancelLease].CancelLeaseRequest.Builder Request message for canceling a lease using [CancelLease][google.cloud.tasks.v2beta2.CloudTasks.CancelLease].CloudTasksClient Service Description: Cloud Tasks allows developers to manage the execution of background work in their applications.CloudTasksClient.ListLocationsFixedSizeCollection CloudTasksClient.ListLocationsPage CloudTasksClient.ListLocationsPagedResponse CloudTasksClient.ListQueuesFixedSizeCollection CloudTasksClient.ListQueuesPage CloudTasksClient.ListQueuesPagedResponse CloudTasksClient.ListTasksFixedSizeCollection CloudTasksClient.ListTasksPage CloudTasksClient.ListTasksPagedResponse CloudTasksGrpc Cloud Tasks allows developers to manage the execution of background work in their applications.CloudTasksGrpc.CloudTasksBlockingStub A stub to allow clients to do synchronous rpc calls to service CloudTasks.CloudTasksGrpc.CloudTasksFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service CloudTasks.CloudTasksGrpc.CloudTasksImplBase Base class for the server implementation of the service CloudTasks.CloudTasksGrpc.CloudTasksStub A stub to allow clients to do asynchronous rpc calls to service CloudTasks.CloudTasksProto CloudTasksSettings Settings class to configure an instance ofCloudTasksClient
.CloudTasksSettings.Builder Builder for CloudTasksSettings.CreateQueueRequest Request message for [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue].CreateQueueRequest.Builder Request message for [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue].CreateTaskRequest Request message for [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].CreateTaskRequest.Builder Request message for [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].DeleteQueueRequest Request message for [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue].DeleteQueueRequest.Builder Request message for [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue].DeleteTaskRequest Request message for deleting a task using [DeleteTask][google.cloud.tasks.v2beta2.CloudTasks.DeleteTask].DeleteTaskRequest.Builder Request message for deleting a task using [DeleteTask][google.cloud.tasks.v2beta2.CloudTasks.DeleteTask].GetQueueRequest Request message for [GetQueue][google.cloud.tasks.v2beta2.CloudTasks.GetQueue].GetQueueRequest.Builder Request message for [GetQueue][google.cloud.tasks.v2beta2.CloudTasks.GetQueue].GetTaskRequest Request message for getting a task using [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask].GetTaskRequest.Builder Request message for getting a task using [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask].HttpRequest HTTP request.HttpRequest.Builder HTTP request.HttpTarget HTTP target.HttpTarget.Builder HTTP target.HttpTarget.Header Defines a header message.HttpTarget.Header.Builder Defines a header message.HttpTarget.HeaderOverride Wraps the Header object.HttpTarget.HeaderOverride.Builder Wraps the Header object.LeaseTasksRequest Request message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].LeaseTasksRequest.Builder Request message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].LeaseTasksResponse Response message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].LeaseTasksResponse.Builder Response message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].ListQueuesRequest Request message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].ListQueuesRequest.Builder Request message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].ListQueuesResponse Response message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].ListQueuesResponse.Builder Response message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].ListTasksRequest Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].ListTasksRequest.Builder Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].ListTasksResponse Response message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].ListTasksResponse.Builder Response message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].LocationName LocationName.Builder Builder for projects/{project}/locations/{location}.OAuthToken Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2).OAuthToken.Builder Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2).OidcToken Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect).OidcToken.Builder Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect).OldTargetProto PathOverride PathOverride.PathOverride.Builder PathOverride.PauseQueueRequest Request message for [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue].PauseQueueRequest.Builder Request message for [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue].ProjectName ProjectName.Builder Builder for ProjectName.PullMessage The pull message contains data that can be used by the caller of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task.PullMessage.Builder The pull message contains data that can be used by the caller of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task.PullTarget Pull target.PullTarget.Builder Pull target.PurgeQueueRequest Request message for [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue].PurgeQueueRequest.Builder Request message for [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue].QueryOverride QueryOverride.QueryOverride.Builder QueryOverride.Queue A queue is a container of related tasks.Queue.Builder A queue is a container of related tasks.QueueName QueueName.Builder Builder for projects/{project}/locations/{location}/queues/{queue}.QueueProto QueueStats Statistics for a queue.QueueStats.Builder Statistics for a queue.RateLimits Rate limits.RateLimits.Builder Rate limits.RenewLeaseRequest Request message for renewing a lease using [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease].RenewLeaseRequest.Builder Request message for renewing a lease using [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease].ResumeQueueRequest Request message for [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue].ResumeQueueRequest.Builder Request message for [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue].RetryConfig Retry config.RetryConfig.Builder Retry config.RunTaskRequest Request message for forcing a task to run now using [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask].RunTaskRequest.Builder Request message for forcing a task to run now using [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask].TargetProto Task A unit of scheduled work.Task.Builder A unit of scheduled work.TaskName TaskName.Builder Builder for projects/{project}/locations/{location}/queues/{queue}/tasks/{task}.TaskProto TaskStatus Status of the task.TaskStatus.Builder Status of the task.UpdateQueueRequest Request message for [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue].UpdateQueueRequest.Builder Request message for [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue].UploadQueueYamlRequest Request message for [UploadQueueYaml][google.cloud.tasks.v2beta2.CloudTasks.UploadQueueYaml].UploadQueueYamlRequest.Builder Request message for [UploadQueueYaml][google.cloud.tasks.v2beta2.CloudTasks.UploadQueueYaml].UriOverride Uri Override.UriOverride.Builder Uri Override. -
Enum Summary Enum Description HttpMethod The HTTP method used to execute the task.HttpRequest.AuthorizationHeaderCase HttpTarget.AuthorizationHeaderCase Queue.State State of the queue.Queue.TargetTypeCase RetryConfig.NumAttemptsCase Task.PayloadTypeCase Task.View The view specifies a subset of [Task][google.cloud.tasks.v2beta2.Task] data.UriOverride.Scheme The Scheme for an HTTP request.UriOverride.UriOverrideEnforceMode UriOverrideEnforceMode mode is to define enforcing mode for the override modes.