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

GitHub 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.

Client Description
com.google.cloud.tasks.v2beta2.CloudTasksClient Service 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.

Settings Description
com.google.cloud.tasks.v2beta2.CloudTasksSettings Settings class to configure an instance of CloudTasksClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.tasks.v2beta2.AcknowledgeTaskRequest Request message for acknowledging a task using AcknowledgeTask.
com.google.cloud.tasks.v2beta2.AcknowledgeTaskRequest.Builder Request message for acknowledging a task using AcknowledgeTask.
com.google.cloud.tasks.v2beta2.AppEngineHttpRequest App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when
com.google.cloud.tasks.v2beta2.AppEngineHttpRequest.Builder App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when
com.google.cloud.tasks.v2beta2.AppEngineHttpTarget App Engine HTTP target. The task will be delivered to the App Engine application hostname
com.google.cloud.tasks.v2beta2.AppEngineHttpTarget.Builder App Engine HTTP target. The task will be delivered to the App Engine application hostname
com.google.cloud.tasks.v2beta2.AppEngineRouting App Engine Routing. Defines routing characteristics specific to App Engine - service, version,
com.google.cloud.tasks.v2beta2.AppEngineRouting.Builder App Engine Routing. Defines routing characteristics specific to App Engine - service, version,
com.google.cloud.tasks.v2beta2.AttemptStatus The status of a task attempt.
com.google.cloud.tasks.v2beta2.AttemptStatus.Builder The status of a task attempt.
com.google.cloud.tasks.v2beta2.CancelLeaseRequest Request message for canceling a lease using CancelLease.
com.google.cloud.tasks.v2beta2.CancelLeaseRequest.Builder Request 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.CloudTasksGrpc Cloud Tasks allows developers to manage the execution of background work in their applications.
com.google.cloud.tasks.v2beta2.CloudTasksGrpc.CloudTasksImplBase Base 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.Builder Builder for CloudTasksSettings.
com.google.cloud.tasks.v2beta2.CreateQueueRequest Request message for CreateQueue.
com.google.cloud.tasks.v2beta2.CreateQueueRequest.Builder Request message for CreateQueue.
com.google.cloud.tasks.v2beta2.CreateTaskRequest Request message for CreateTask.
com.google.cloud.tasks.v2beta2.CreateTaskRequest.Builder Request message for CreateTask.
com.google.cloud.tasks.v2beta2.DeleteQueueRequest Request message for DeleteQueue.
com.google.cloud.tasks.v2beta2.DeleteQueueRequest.Builder Request message for DeleteQueue.
com.google.cloud.tasks.v2beta2.DeleteTaskRequest Request message for deleting a task using DeleteTask.
com.google.cloud.tasks.v2beta2.DeleteTaskRequest.Builder Request message for deleting a task using DeleteTask.
com.google.cloud.tasks.v2beta2.GetQueueRequest Request message for GetQueue.
com.google.cloud.tasks.v2beta2.GetQueueRequest.Builder Request message for GetQueue.
com.google.cloud.tasks.v2beta2.GetTaskRequest Request message for getting a task using GetTask.
com.google.cloud.tasks.v2beta2.GetTaskRequest.Builder Request message for getting a task using GetTask.
com.google.cloud.tasks.v2beta2.HttpRequest HTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request
com.google.cloud.tasks.v2beta2.HttpRequest.Builder HTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request
com.google.cloud.tasks.v2beta2.HttpTarget HTTP target. When specified as a Queue, all the tasks with [HttpRequest]
com.google.cloud.tasks.v2beta2.HttpTarget.Builder HTTP target. When specified as a Queue, all the tasks with [HttpRequest]
com.google.cloud.tasks.v2beta2.HttpTarget.Header Defines a header message. A header can have a key and a value.
com.google.cloud.tasks.v2beta2.HttpTarget.Header.Builder Defines a header message. A header can have a key and a value.
com.google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride Wraps the Header object.
com.google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride.Builder Wraps the Header object.
com.google.cloud.tasks.v2beta2.LeaseTasksRequest Request message for leasing tasks using LeaseTasks.
com.google.cloud.tasks.v2beta2.LeaseTasksRequest.Builder Request message for leasing tasks using LeaseTasks.
com.google.cloud.tasks.v2beta2.LeaseTasksResponse Response message for leasing tasks using LeaseTasks.
com.google.cloud.tasks.v2beta2.LeaseTasksResponse.Builder Response message for leasing tasks using LeaseTasks.
com.google.cloud.tasks.v2beta2.ListQueuesRequest Request message for ListQueues.
com.google.cloud.tasks.v2beta2.ListQueuesRequest.Builder Request message for ListQueues.
com.google.cloud.tasks.v2beta2.ListQueuesResponse Response message for ListQueues.
com.google.cloud.tasks.v2beta2.ListQueuesResponse.Builder Response message for ListQueues.
com.google.cloud.tasks.v2beta2.ListTasksRequest Request message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta2.ListTasksRequest.Builder Request message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta2.ListTasksResponse Response message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta2.ListTasksResponse.Builder Response message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta2.LocationName
com.google.cloud.tasks.v2beta2.LocationName.Builder Builder for projects/{project}/locations/{location}.
com.google.cloud.tasks.v2beta2.OAuthToken Contains 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.Builder Contains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google
com.google.cloud.tasks.v2beta2.OidcToken Contains information needed for generating an OpenID Connect token.
com.google.cloud.tasks.v2beta2.OidcToken.Builder Contains information needed for generating an OpenID Connect token.
com.google.cloud.tasks.v2beta2.OldTargetProto
com.google.cloud.tasks.v2beta2.PathOverride PathOverride. Path message defines path override for HTTP targets.
com.google.cloud.tasks.v2beta2.PathOverride.Builder PathOverride. Path message defines path override for HTTP targets.
com.google.cloud.tasks.v2beta2.PauseQueueRequest Request message for PauseQueue.
com.google.cloud.tasks.v2beta2.PauseQueueRequest.Builder Request message for PauseQueue.
com.google.cloud.tasks.v2beta2.ProjectName
com.google.cloud.tasks.v2beta2.ProjectName.Builder Builder for ProjectName.
com.google.cloud.tasks.v2beta2.PullMessage The pull message contains data that can be used by the caller of LeaseTasks to process the task.
com.google.cloud.tasks.v2beta2.PullMessage.Builder The pull message contains data that can be used by the caller of LeaseTasks to process the task.
com.google.cloud.tasks.v2beta2.PullTarget Pull target.
com.google.cloud.tasks.v2beta2.PullTarget.Builder Pull target.
com.google.cloud.tasks.v2beta2.PurgeQueueRequest Request message for PurgeQueue.
com.google.cloud.tasks.v2beta2.PurgeQueueRequest.Builder Request message for PurgeQueue.
com.google.cloud.tasks.v2beta2.QueryOverride QueryOverride. Query message defines query override for HTTP targets.
com.google.cloud.tasks.v2beta2.QueryOverride.Builder QueryOverride. Query message defines query override for HTTP targets.
com.google.cloud.tasks.v2beta2.Queue 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.
com.google.cloud.tasks.v2beta2.Queue.Builder 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.
com.google.cloud.tasks.v2beta2.QueueName
com.google.cloud.tasks.v2beta2.QueueName.Builder Builder for projects/{project}/locations/{location}/queues/{queue}.
com.google.cloud.tasks.v2beta2.QueueProto
com.google.cloud.tasks.v2beta2.QueueStats Statistics for a queue.
com.google.cloud.tasks.v2beta2.QueueStats.Builder Statistics for a queue.
com.google.cloud.tasks.v2beta2.RateLimits Rate limits. This message determines the maximum rate that tasks can be dispatched by a
com.google.cloud.tasks.v2beta2.RateLimits.Builder Rate limits. This message determines the maximum rate that tasks can be dispatched by a
com.google.cloud.tasks.v2beta2.RenewLeaseRequest Request message for renewing a lease using RenewLease.
com.google.cloud.tasks.v2beta2.RenewLeaseRequest.Builder Request message for renewing a lease using RenewLease.
com.google.cloud.tasks.v2beta2.ResumeQueueRequest Request message for ResumeQueue.
com.google.cloud.tasks.v2beta2.ResumeQueueRequest.Builder Request message for ResumeQueue.
com.google.cloud.tasks.v2beta2.RetryConfig Retry config. These settings determine how a failed task attempt is retried.
com.google.cloud.tasks.v2beta2.RetryConfig.Builder Retry config. These settings determine how a failed task attempt is retried.
com.google.cloud.tasks.v2beta2.RunTaskRequest Request message for forcing a task to run now using RunTask.
com.google.cloud.tasks.v2beta2.RunTaskRequest.Builder Request message for forcing a task to run now using RunTask.
com.google.cloud.tasks.v2beta2.TargetProto
com.google.cloud.tasks.v2beta2.Task A unit of scheduled work.
com.google.cloud.tasks.v2beta2.Task.Builder A unit of scheduled work.
com.google.cloud.tasks.v2beta2.TaskName
com.google.cloud.tasks.v2beta2.TaskName.Builder Builder for projects/{project}/locations/{location}/queues/{queue}/tasks/{task}.
com.google.cloud.tasks.v2beta2.TaskProto
com.google.cloud.tasks.v2beta2.TaskStatus Status of the task.
com.google.cloud.tasks.v2beta2.TaskStatus.Builder Status of the task.
com.google.cloud.tasks.v2beta2.UpdateQueueRequest Request message for UpdateQueue.
com.google.cloud.tasks.v2beta2.UpdateQueueRequest.Builder Request message for UpdateQueue.
com.google.cloud.tasks.v2beta2.UploadQueueYamlRequest Request message for UploadQueueYaml.
com.google.cloud.tasks.v2beta2.UploadQueueYamlRequest.Builder Request message for UploadQueueYaml.
com.google.cloud.tasks.v2beta2.UriOverride Uri Override. When specified, all the HTTP tasks inside the queue will be partially or
com.google.cloud.tasks.v2beta2.UriOverride.Builder Uri Override. When specified, all the HTTP tasks inside the queue will be partially or

Interfaces

Interface Description
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.AsyncService Cloud 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

Enum Description
com.google.cloud.tasks.v2beta2.HttpMethod The 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.State State 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.View The view specifies a subset of Task data.
com.google.cloud.tasks.v2beta2.UriOverride.Scheme The Scheme for an HTTP request. By default, it is HTTPS.
com.google.cloud.tasks.v2beta2.UriOverride.UriOverrideEnforceMode UriOverrideEnforceMode mode is to define enforcing mode for the override modes.