Package com.google.cloud.tasks.v2beta2 (2.40.0)

RepositoryRPC DocumentationREST Documentation

This package is not the latest GA version!

For this library, we recommend using the package associated with API version v2 for new applications.

Prerelease Implications

This package is a prerelease version! Use with caution. Prerelease versions are considered unstable as they may be shut down. You can read more about Cloud API versioning strategy here. Each Cloud Java client library may contain multiple packages. Each package containing a version number in its name corresponds to a published version of the service. We recommend using the latest stable version for new production applications, which can be identified by the largest numeric version that does not contain a suffix. For example, if a client library has two packages: v1 and v2alpha, then the latest stable version is v1. If you use an unstable release, breaking changes may be introduced when upgrading.

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

ClientDescription
com.google.cloud.tasks.v2beta2.CloudTasksClientService Description: Cloud Tasks allows developers to manage the execution of background work in their applications.

This class provides the ability to make remote calls to the backing service through method

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

SettingsDescription
com.google.cloud.tasks.v2beta2.CloudTasksSettingsSettings class to configure an instance of CloudTasksClient.

The default instance has everything set to sensible defaults:

Classes

ClassDescription
com.google.cloud.tasks.v2beta2.AcknowledgeTaskRequestRequest message for acknowledging a task using AcknowledgeTask.
com.google.cloud.tasks.v2beta2.AcknowledgeTaskRequest.BuilderRequest message for acknowledging a task using AcknowledgeTask.
com.google.cloud.tasks.v2beta2.AppEngineHttpRequestApp Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when
com.google.cloud.tasks.v2beta2.AppEngineHttpRequest.BuilderApp Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when
com.google.cloud.tasks.v2beta2.AppEngineHttpTargetApp Engine HTTP target. The task will be delivered to the App Engine application hostname
com.google.cloud.tasks.v2beta2.AppEngineHttpTarget.BuilderApp Engine HTTP target. The task will be delivered to the App Engine application hostname
com.google.cloud.tasks.v2beta2.AppEngineRoutingApp Engine Routing. Defines routing characteristics specific to App Engine - service, version,
com.google.cloud.tasks.v2beta2.AppEngineRouting.BuilderApp Engine Routing. Defines routing characteristics specific to App Engine - service, version,
com.google.cloud.tasks.v2beta2.AttemptStatusThe status of a task attempt.
com.google.cloud.tasks.v2beta2.AttemptStatus.BuilderThe status of a task attempt.
com.google.cloud.tasks.v2beta2.CancelLeaseRequestRequest message for canceling a lease using CancelLease.
com.google.cloud.tasks.v2beta2.CancelLeaseRequest.BuilderRequest message for canceling a lease using CancelLease.
com.google.cloud.tasks.v2beta2.CloudTasksClient.ListLocationsFixedSizeCollection
com.google.cloud.tasks.v2beta2.CloudTasksClient.ListLocationsPage
com.google.cloud.tasks.v2beta2.CloudTasksClient.ListLocationsPagedResponse
com.google.cloud.tasks.v2beta2.CloudTasksClient.ListQueuesFixedSizeCollection
com.google.cloud.tasks.v2beta2.CloudTasksClient.ListQueuesPage
com.google.cloud.tasks.v2beta2.CloudTasksClient.ListQueuesPagedResponse
com.google.cloud.tasks.v2beta2.CloudTasksClient.ListTasksFixedSizeCollection
com.google.cloud.tasks.v2beta2.CloudTasksClient.ListTasksPage
com.google.cloud.tasks.v2beta2.CloudTasksClient.ListTasksPagedResponse
com.google.cloud.tasks.v2beta2.CloudTasksGrpcCloud Tasks allows developers to manage the execution of background work in their applications.
com.google.cloud.tasks.v2beta2.CloudTasksGrpc.CloudTasksImplBaseBase class for the server implementation of the service CloudTasks. Cloud Tasks allows developers to manage the execution of background
com.google.cloud.tasks.v2beta2.CloudTasksProto
com.google.cloud.tasks.v2beta2.CloudTasksSettings.BuilderBuilder for CloudTasksSettings.
com.google.cloud.tasks.v2beta2.CreateQueueRequestRequest message for CreateQueue.
com.google.cloud.tasks.v2beta2.CreateQueueRequest.BuilderRequest message for CreateQueue.
com.google.cloud.tasks.v2beta2.CreateTaskRequestRequest message for CreateTask.
com.google.cloud.tasks.v2beta2.CreateTaskRequest.BuilderRequest message for CreateTask.
com.google.cloud.tasks.v2beta2.DeleteQueueRequestRequest message for DeleteQueue.
com.google.cloud.tasks.v2beta2.DeleteQueueRequest.BuilderRequest message for DeleteQueue.
com.google.cloud.tasks.v2beta2.DeleteTaskRequestRequest message for deleting a task using DeleteTask.
com.google.cloud.tasks.v2beta2.DeleteTaskRequest.BuilderRequest message for deleting a task using DeleteTask.
com.google.cloud.tasks.v2beta2.GetQueueRequestRequest message for GetQueue.
com.google.cloud.tasks.v2beta2.GetQueueRequest.BuilderRequest message for GetQueue.
com.google.cloud.tasks.v2beta2.GetTaskRequestRequest message for getting a task using GetTask.
com.google.cloud.tasks.v2beta2.GetTaskRequest.BuilderRequest message for getting a task using GetTask.
com.google.cloud.tasks.v2beta2.HttpRequestHTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request
com.google.cloud.tasks.v2beta2.HttpRequest.BuilderHTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request
com.google.cloud.tasks.v2beta2.HttpTargetHTTP target. When specified as a Queue, all the tasks with [HttpRequest]
com.google.cloud.tasks.v2beta2.HttpTarget.BuilderHTTP target. When specified as a Queue, all the tasks with [HttpRequest]
com.google.cloud.tasks.v2beta2.HttpTarget.HeaderDefines a header message. A header can have a key and a value.
com.google.cloud.tasks.v2beta2.HttpTarget.Header.BuilderDefines a header message. A header can have a key and a value.
com.google.cloud.tasks.v2beta2.HttpTarget.HeaderOverrideWraps the Header object.
com.google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride.BuilderWraps the Header object.
com.google.cloud.tasks.v2beta2.LeaseTasksRequestRequest message for leasing tasks using LeaseTasks.
com.google.cloud.tasks.v2beta2.LeaseTasksRequest.BuilderRequest message for leasing tasks using LeaseTasks.
com.google.cloud.tasks.v2beta2.LeaseTasksResponseResponse message for leasing tasks using LeaseTasks.
com.google.cloud.tasks.v2beta2.LeaseTasksResponse.BuilderResponse message for leasing tasks using LeaseTasks.
com.google.cloud.tasks.v2beta2.ListQueuesRequestRequest message for ListQueues.
com.google.cloud.tasks.v2beta2.ListQueuesRequest.BuilderRequest message for ListQueues.
com.google.cloud.tasks.v2beta2.ListQueuesResponseResponse message for ListQueues.
com.google.cloud.tasks.v2beta2.ListQueuesResponse.BuilderResponse message for ListQueues.
com.google.cloud.tasks.v2beta2.ListTasksRequestRequest message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta2.ListTasksRequest.BuilderRequest message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta2.ListTasksResponseResponse message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta2.ListTasksResponse.BuilderResponse message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta2.LocationName
com.google.cloud.tasks.v2beta2.LocationName.BuilderBuilder for projects/{project}/locations/{location}.
com.google.cloud.tasks.v2beta2.OAuthTokenContains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google
com.google.cloud.tasks.v2beta2.OAuthToken.BuilderContains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google
com.google.cloud.tasks.v2beta2.OidcTokenContains information needed for generating an OpenID Connect token.
com.google.cloud.tasks.v2beta2.OidcToken.BuilderContains information needed for generating an OpenID Connect token.
com.google.cloud.tasks.v2beta2.OldTargetProto
com.google.cloud.tasks.v2beta2.PathOverridePathOverride. Path message defines path override for HTTP targets.
com.google.cloud.tasks.v2beta2.PathOverride.BuilderPathOverride. Path message defines path override for HTTP targets.
com.google.cloud.tasks.v2beta2.PauseQueueRequestRequest message for PauseQueue.
com.google.cloud.tasks.v2beta2.PauseQueueRequest.BuilderRequest message for PauseQueue.
com.google.cloud.tasks.v2beta2.ProjectName
com.google.cloud.tasks.v2beta2.ProjectName.BuilderBuilder for ProjectName.
com.google.cloud.tasks.v2beta2.PullMessageThe pull message contains data that can be used by the caller of LeaseTasks to process the task.
com.google.cloud.tasks.v2beta2.PullMessage.BuilderThe pull message contains data that can be used by the caller of LeaseTasks to process the task.
com.google.cloud.tasks.v2beta2.PullTargetPull target.
com.google.cloud.tasks.v2beta2.PullTarget.BuilderPull target.
com.google.cloud.tasks.v2beta2.PurgeQueueRequestRequest message for PurgeQueue.
com.google.cloud.tasks.v2beta2.PurgeQueueRequest.BuilderRequest message for PurgeQueue.
com.google.cloud.tasks.v2beta2.QueryOverrideQueryOverride. Query message defines query override for HTTP targets.
com.google.cloud.tasks.v2beta2.QueryOverride.BuilderQueryOverride. Query message defines query override for HTTP targets.
com.google.cloud.tasks.v2beta2.QueueA queue is a container of related tasks. Queues are configured to manage how those tasks are dised. Configurable properties include rate limits, retry options, target types, and others.
com.google.cloud.tasks.v2beta2.Queue.BuilderA queue is a container of related tasks. Queues are configured to manage how those tasks are dised. Configurable properties include rate limits, retry options, target types, and others.
com.google.cloud.tasks.v2beta2.QueueName
com.google.cloud.tasks.v2beta2.QueueName.BuilderBuilder for projects/{project}/locations/{location}/queues/{queue}.
com.google.cloud.tasks.v2beta2.QueueProto
com.google.cloud.tasks.v2beta2.QueueStatsStatistics for a queue.
com.google.cloud.tasks.v2beta2.QueueStats.BuilderStatistics for a queue.
com.google.cloud.tasks.v2beta2.RateLimitsRate limits. This message determines the maximum rate that tasks can be dised by a
com.google.cloud.tasks.v2beta2.RateLimits.BuilderRate limits. This message determines the maximum rate that tasks can be dised by a
com.google.cloud.tasks.v2beta2.RenewLeaseRequestRequest message for renewing a lease using RenewLease.
com.google.cloud.tasks.v2beta2.RenewLeaseRequest.BuilderRequest message for renewing a lease using RenewLease.
com.google.cloud.tasks.v2beta2.ResumeQueueRequestRequest message for ResumeQueue.
com.google.cloud.tasks.v2beta2.ResumeQueueRequest.BuilderRequest message for ResumeQueue.
com.google.cloud.tasks.v2beta2.RetryConfigRetry config. These settings determine how a failed task attempt is retried.
com.google.cloud.tasks.v2beta2.RetryConfig.BuilderRetry config. These settings determine how a failed task attempt is retried.
com.google.cloud.tasks.v2beta2.RunTaskRequestRequest message for forcing a task to run now using RunTask.
com.google.cloud.tasks.v2beta2.RunTaskRequest.BuilderRequest message for forcing a task to run now using RunTask.
com.google.cloud.tasks.v2beta2.TargetProto
com.google.cloud.tasks.v2beta2.TaskA unit of scheduled work.
com.google.cloud.tasks.v2beta2.Task.BuilderA unit of scheduled work.
com.google.cloud.tasks.v2beta2.TaskName
com.google.cloud.tasks.v2beta2.TaskName.BuilderBuilder for projects/{project}/locations/{location}/queues/{queue}/tasks/{task}.
com.google.cloud.tasks.v2beta2.TaskProto
com.google.cloud.tasks.v2beta2.TaskStatusStatus of the task.
com.google.cloud.tasks.v2beta2.TaskStatus.BuilderStatus of the task.
com.google.cloud.tasks.v2beta2.UpdateQueueRequestRequest message for UpdateQueue.
com.google.cloud.tasks.v2beta2.UpdateQueueRequest.BuilderRequest message for UpdateQueue.
com.google.cloud.tasks.v2beta2.UploadQueueYamlRequestRequest message for UploadQueueYaml.
com.google.cloud.tasks.v2beta2.UploadQueueYamlRequest.BuilderRequest message for UploadQueueYaml.
com.google.cloud.tasks.v2beta2.UriOverrideUri Override. When specified, all the HTTP tasks inside the queue will be partially or
com.google.cloud.tasks.v2beta2.UriOverride.BuilderUri Override. When specified, all the HTTP tasks inside the queue will be partially or

Interfaces

InterfaceDescription
com.google.cloud.tasks.v2beta2.AcknowledgeTaskRequestOrBuilder
com.google.cloud.tasks.v2beta2.AppEngineHttpRequestOrBuilder
com.google.cloud.tasks.v2beta2.AppEngineHttpTargetOrBuilder
com.google.cloud.tasks.v2beta2.AppEngineRoutingOrBuilder
com.google.cloud.tasks.v2beta2.AttemptStatusOrBuilder
com.google.cloud.tasks.v2beta2.CancelLeaseRequestOrBuilder
com.google.cloud.tasks.v2beta2.CloudTasksGrpc.AsyncServiceCloud Tasks allows developers to manage the execution of background work in their applications.
com.google.cloud.tasks.v2beta2.CreateQueueRequestOrBuilder
com.google.cloud.tasks.v2beta2.CreateTaskRequestOrBuilder
com.google.cloud.tasks.v2beta2.DeleteQueueRequestOrBuilder
com.google.cloud.tasks.v2beta2.DeleteTaskRequestOrBuilder
com.google.cloud.tasks.v2beta2.GetQueueRequestOrBuilder
com.google.cloud.tasks.v2beta2.GetTaskRequestOrBuilder
com.google.cloud.tasks.v2beta2.HttpRequestOrBuilder
com.google.cloud.tasks.v2beta2.HttpTarget.HeaderOrBuilder
com.google.cloud.tasks.v2beta2.HttpTarget.HeaderOverrideOrBuilder
com.google.cloud.tasks.v2beta2.HttpTargetOrBuilder
com.google.cloud.tasks.v2beta2.LeaseTasksRequestOrBuilder
com.google.cloud.tasks.v2beta2.LeaseTasksResponseOrBuilder
com.google.cloud.tasks.v2beta2.ListQueuesRequestOrBuilder
com.google.cloud.tasks.v2beta2.ListQueuesResponseOrBuilder
com.google.cloud.tasks.v2beta2.ListTasksRequestOrBuilder
com.google.cloud.tasks.v2beta2.ListTasksResponseOrBuilder
com.google.cloud.tasks.v2beta2.OAuthTokenOrBuilder
com.google.cloud.tasks.v2beta2.OidcTokenOrBuilder
com.google.cloud.tasks.v2beta2.PathOverrideOrBuilder
com.google.cloud.tasks.v2beta2.PauseQueueRequestOrBuilder
com.google.cloud.tasks.v2beta2.PullMessageOrBuilder
com.google.cloud.tasks.v2beta2.PullTargetOrBuilder
com.google.cloud.tasks.v2beta2.PurgeQueueRequestOrBuilder
com.google.cloud.tasks.v2beta2.QueryOverrideOrBuilder
com.google.cloud.tasks.v2beta2.QueueOrBuilder
com.google.cloud.tasks.v2beta2.QueueStatsOrBuilder
com.google.cloud.tasks.v2beta2.RateLimitsOrBuilder
com.google.cloud.tasks.v2beta2.RenewLeaseRequestOrBuilder
com.google.cloud.tasks.v2beta2.ResumeQueueRequestOrBuilder
com.google.cloud.tasks.v2beta2.RetryConfigOrBuilder
com.google.cloud.tasks.v2beta2.RunTaskRequestOrBuilder
com.google.cloud.tasks.v2beta2.TaskOrBuilder
com.google.cloud.tasks.v2beta2.TaskStatusOrBuilder
com.google.cloud.tasks.v2beta2.UpdateQueueRequestOrBuilder
com.google.cloud.tasks.v2beta2.UploadQueueYamlRequestOrBuilder
com.google.cloud.tasks.v2beta2.UriOverrideOrBuilder

Enums

EnumDescription
com.google.cloud.tasks.v2beta2.HttpMethodThe HTTP method used to execute the task.
com.google.cloud.tasks.v2beta2.HttpRequest.AuthorizationHeaderCase
com.google.cloud.tasks.v2beta2.HttpTarget.AuthorizationHeaderCase
com.google.cloud.tasks.v2beta2.Queue.StateState of the queue.
com.google.cloud.tasks.v2beta2.Queue.TargetTypeCase
com.google.cloud.tasks.v2beta2.RetryConfig.NumAttemptsCase
com.google.cloud.tasks.v2beta2.Task.PayloadTypeCase
com.google.cloud.tasks.v2beta2.Task.ViewThe view specifies a subset of Task data.
com.google.cloud.tasks.v2beta2.UriOverride.SchemeThe Scheme for an HTTP request. By default, it is HTTPS.
com.google.cloud.tasks.v2beta2.UriOverride.UriOverrideEnforceModeUriOverrideEnforceMode mode is to define enforcing mode for the override modes.