Package com.google.cloud.tasks.v2beta3 (2.76.0)

GitHub Repository RPC Documentation REST Documentation

This package is not the recommended entry point to using this client library!

For this library, we recommend using com.google.cloud.tasks.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 and/or subject to breaking changes when upgrading. Use them only for testing or if you specifically need their experimental features.

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.v2beta3.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.v2beta3.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.v2beta3.AppEngineHttpQueue App Engine HTTP queue. The task will be delivered to the App Engine application hostname
com.google.cloud.tasks.v2beta3.AppEngineHttpQueue.Builder App Engine HTTP queue. The task will be delivered to the App Engine application hostname
com.google.cloud.tasks.v2beta3.AppEngineHttpRequest App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when
com.google.cloud.tasks.v2beta3.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.v2beta3.AppEngineRouting App Engine Routing. Defines routing characteristics specific to App Engine - service, version,
com.google.cloud.tasks.v2beta3.AppEngineRouting.Builder App Engine Routing. Defines routing characteristics specific to App Engine - service, version,
com.google.cloud.tasks.v2beta3.Attempt The status of a task attempt.
com.google.cloud.tasks.v2beta3.Attempt.Builder The status of a task attempt.
com.google.cloud.tasks.v2beta3.CloudTasksClient.ListLocationsFixedSizeCollection
com.google.cloud.tasks.v2beta3.CloudTasksClient.ListLocationsPage
com.google.cloud.tasks.v2beta3.CloudTasksClient.ListLocationsPagedResponse
com.google.cloud.tasks.v2beta3.CloudTasksClient.ListQueuesFixedSizeCollection
com.google.cloud.tasks.v2beta3.CloudTasksClient.ListQueuesPage
com.google.cloud.tasks.v2beta3.CloudTasksClient.ListQueuesPagedResponse
com.google.cloud.tasks.v2beta3.CloudTasksClient.ListTasksFixedSizeCollection
com.google.cloud.tasks.v2beta3.CloudTasksClient.ListTasksPage
com.google.cloud.tasks.v2beta3.CloudTasksClient.ListTasksPagedResponse
com.google.cloud.tasks.v2beta3.CloudTasksGrpc Cloud Tasks allows developers to manage the execution of background work in their applications.
com.google.cloud.tasks.v2beta3.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.v2beta3.CloudTasksProto
com.google.cloud.tasks.v2beta3.CloudTasksSettings.Builder Builder for CloudTasksSettings.
com.google.cloud.tasks.v2beta3.CreateQueueRequest Request message for CreateQueue.
com.google.cloud.tasks.v2beta3.CreateQueueRequest.Builder Request message for CreateQueue.
com.google.cloud.tasks.v2beta3.CreateTaskRequest Request message for CreateTask.
com.google.cloud.tasks.v2beta3.CreateTaskRequest.Builder Request message for CreateTask.
com.google.cloud.tasks.v2beta3.DeleteQueueRequest Request message for DeleteQueue.
com.google.cloud.tasks.v2beta3.DeleteQueueRequest.Builder Request message for DeleteQueue.
com.google.cloud.tasks.v2beta3.DeleteTaskRequest Request message for deleting a task using DeleteTask.
com.google.cloud.tasks.v2beta3.DeleteTaskRequest.Builder Request message for deleting a task using DeleteTask.
com.google.cloud.tasks.v2beta3.GetQueueRequest Request message for GetQueue.
com.google.cloud.tasks.v2beta3.GetQueueRequest.Builder Request message for GetQueue.
com.google.cloud.tasks.v2beta3.GetTaskRequest Request message for getting a task using GetTask.
com.google.cloud.tasks.v2beta3.GetTaskRequest.Builder Request message for getting a task using GetTask.
com.google.cloud.tasks.v2beta3.HttpRequest HTTP request. The task will be pushed to the worker as an HTTP request. If the worker
com.google.cloud.tasks.v2beta3.HttpRequest.Builder HTTP request. The task will be pushed to the worker as an HTTP request. If the worker
com.google.cloud.tasks.v2beta3.HttpTarget HTTP target. When specified as a Queue, all the tasks with [HttpRequest]
com.google.cloud.tasks.v2beta3.HttpTarget.Builder HTTP target. When specified as a Queue, all the tasks with [HttpRequest]
com.google.cloud.tasks.v2beta3.HttpTarget.Header Defines a header message. A header can have a key and a value.
com.google.cloud.tasks.v2beta3.HttpTarget.Header.Builder Defines a header message. A header can have a key and a value.
com.google.cloud.tasks.v2beta3.HttpTarget.HeaderOverride Wraps the Header object.
com.google.cloud.tasks.v2beta3.HttpTarget.HeaderOverride.Builder Wraps the Header object.
com.google.cloud.tasks.v2beta3.ListQueuesRequest Request message for ListQueues.
com.google.cloud.tasks.v2beta3.ListQueuesRequest.Builder Request message for ListQueues.
com.google.cloud.tasks.v2beta3.ListQueuesResponse Response message for ListQueues.
com.google.cloud.tasks.v2beta3.ListQueuesResponse.Builder Response message for ListQueues.
com.google.cloud.tasks.v2beta3.ListTasksRequest Request message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta3.ListTasksRequest.Builder Request message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta3.ListTasksResponse Response message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta3.ListTasksResponse.Builder Response message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta3.LocationName
com.google.cloud.tasks.v2beta3.LocationName.Builder Builder for projects/{project}/locations/{location}.
com.google.cloud.tasks.v2beta3.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.v2beta3.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.v2beta3.OidcToken Contains information needed for generating an OpenID Connect token.
com.google.cloud.tasks.v2beta3.OidcToken.Builder Contains information needed for generating an OpenID Connect token.
com.google.cloud.tasks.v2beta3.PathOverride PathOverride. Path message defines path override for HTTP targets.
com.google.cloud.tasks.v2beta3.PathOverride.Builder PathOverride. Path message defines path override for HTTP targets.
com.google.cloud.tasks.v2beta3.PauseQueueRequest Request message for PauseQueue.
com.google.cloud.tasks.v2beta3.PauseQueueRequest.Builder Request message for PauseQueue.
com.google.cloud.tasks.v2beta3.ProjectName
com.google.cloud.tasks.v2beta3.ProjectName.Builder Builder for ProjectName.
com.google.cloud.tasks.v2beta3.PullMessage Pull Message. This proto can only be used for tasks in a queue which has
com.google.cloud.tasks.v2beta3.PullMessage.Builder Pull Message. This proto can only be used for tasks in a queue which has
com.google.cloud.tasks.v2beta3.PurgeQueueRequest Request message for PurgeQueue.
com.google.cloud.tasks.v2beta3.PurgeQueueRequest.Builder Request message for PurgeQueue.
com.google.cloud.tasks.v2beta3.QueryOverride QueryOverride. Query message defines query override for HTTP targets.
com.google.cloud.tasks.v2beta3.QueryOverride.Builder QueryOverride. Query message defines query override for HTTP targets.
com.google.cloud.tasks.v2beta3.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, queue types, and others.
com.google.cloud.tasks.v2beta3.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, queue types, and others.
com.google.cloud.tasks.v2beta3.QueueName
com.google.cloud.tasks.v2beta3.QueueName.Builder Builder for projects/{project}/locations/{location}/queues/{queue}.
com.google.cloud.tasks.v2beta3.QueueProto
com.google.cloud.tasks.v2beta3.QueueStats Statistics for a queue.
com.google.cloud.tasks.v2beta3.QueueStats.Builder Statistics for a queue.
com.google.cloud.tasks.v2beta3.RateLimits Rate limits. This message determines the maximum rate that tasks can be dispatched by a
com.google.cloud.tasks.v2beta3.RateLimits.Builder Rate limits. This message determines the maximum rate that tasks can be dispatched by a
com.google.cloud.tasks.v2beta3.ResumeQueueRequest Request message for ResumeQueue.
com.google.cloud.tasks.v2beta3.ResumeQueueRequest.Builder Request message for ResumeQueue.
com.google.cloud.tasks.v2beta3.RetryConfig Retry config. These settings determine when a failed task attempt is retried.
com.google.cloud.tasks.v2beta3.RetryConfig.Builder Retry config. These settings determine when a failed task attempt is retried.
com.google.cloud.tasks.v2beta3.RunTaskRequest Request message for forcing a task to run now using RunTask.
com.google.cloud.tasks.v2beta3.RunTaskRequest.Builder Request message for forcing a task to run now using RunTask.
com.google.cloud.tasks.v2beta3.StackdriverLoggingConfig Configuration options for writing logs to Stackdriver Logging.
com.google.cloud.tasks.v2beta3.StackdriverLoggingConfig.Builder Configuration options for writing logs to Stackdriver Logging.
com.google.cloud.tasks.v2beta3.TargetProto
com.google.cloud.tasks.v2beta3.Task A unit of scheduled work.
com.google.cloud.tasks.v2beta3.Task.Builder A unit of scheduled work.
com.google.cloud.tasks.v2beta3.TaskName
com.google.cloud.tasks.v2beta3.TaskName.Builder Builder for projects/{project}/locations/{location}/queues/{queue}/tasks/{task}.
com.google.cloud.tasks.v2beta3.TaskProto
com.google.cloud.tasks.v2beta3.UpdateQueueRequest Request message for UpdateQueue.
com.google.cloud.tasks.v2beta3.UpdateQueueRequest.Builder Request message for UpdateQueue.
com.google.cloud.tasks.v2beta3.UriOverride URI Override. When specified, all the HTTP tasks inside the queue will be partially or
com.google.cloud.tasks.v2beta3.UriOverride.Builder URI Override. When specified, all the HTTP tasks inside the queue will be partially or

Interfaces

Interface Description
com.google.cloud.tasks.v2beta3.AppEngineHttpQueueOrBuilder
com.google.cloud.tasks.v2beta3.AppEngineHttpRequestOrBuilder
com.google.cloud.tasks.v2beta3.AppEngineRoutingOrBuilder
com.google.cloud.tasks.v2beta3.AttemptOrBuilder
com.google.cloud.tasks.v2beta3.CloudTasksGrpc.AsyncService Cloud Tasks allows developers to manage the execution of background work in their applications.
com.google.cloud.tasks.v2beta3.CreateQueueRequestOrBuilder
com.google.cloud.tasks.v2beta3.CreateTaskRequestOrBuilder
com.google.cloud.tasks.v2beta3.DeleteQueueRequestOrBuilder
com.google.cloud.tasks.v2beta3.DeleteTaskRequestOrBuilder
com.google.cloud.tasks.v2beta3.GetQueueRequestOrBuilder
com.google.cloud.tasks.v2beta3.GetTaskRequestOrBuilder
com.google.cloud.tasks.v2beta3.HttpRequestOrBuilder
com.google.cloud.tasks.v2beta3.HttpTarget.HeaderOrBuilder
com.google.cloud.tasks.v2beta3.HttpTarget.HeaderOverrideOrBuilder
com.google.cloud.tasks.v2beta3.HttpTargetOrBuilder
com.google.cloud.tasks.v2beta3.ListQueuesRequestOrBuilder
com.google.cloud.tasks.v2beta3.ListQueuesResponseOrBuilder
com.google.cloud.tasks.v2beta3.ListTasksRequestOrBuilder
com.google.cloud.tasks.v2beta3.ListTasksResponseOrBuilder
com.google.cloud.tasks.v2beta3.OAuthTokenOrBuilder
com.google.cloud.tasks.v2beta3.OidcTokenOrBuilder
com.google.cloud.tasks.v2beta3.PathOverrideOrBuilder
com.google.cloud.tasks.v2beta3.PauseQueueRequestOrBuilder
com.google.cloud.tasks.v2beta3.PullMessageOrBuilder
com.google.cloud.tasks.v2beta3.PurgeQueueRequestOrBuilder
com.google.cloud.tasks.v2beta3.QueryOverrideOrBuilder
com.google.cloud.tasks.v2beta3.QueueOrBuilder
com.google.cloud.tasks.v2beta3.QueueStatsOrBuilder
com.google.cloud.tasks.v2beta3.RateLimitsOrBuilder
com.google.cloud.tasks.v2beta3.ResumeQueueRequestOrBuilder
com.google.cloud.tasks.v2beta3.RetryConfigOrBuilder
com.google.cloud.tasks.v2beta3.RunTaskRequestOrBuilder
com.google.cloud.tasks.v2beta3.StackdriverLoggingConfigOrBuilder
com.google.cloud.tasks.v2beta3.TaskOrBuilder
com.google.cloud.tasks.v2beta3.UpdateQueueRequestOrBuilder
com.google.cloud.tasks.v2beta3.UriOverrideOrBuilder

Enums

Enum Description
com.google.cloud.tasks.v2beta3.HttpMethod The HTTP method used to execute the task.
com.google.cloud.tasks.v2beta3.HttpRequest.AuthorizationHeaderCase
com.google.cloud.tasks.v2beta3.HttpTarget.AuthorizationHeaderCase
com.google.cloud.tasks.v2beta3.Queue.QueueTypeCase
com.google.cloud.tasks.v2beta3.Queue.State State of the queue.
com.google.cloud.tasks.v2beta3.Queue.Type The type of the queue.
com.google.cloud.tasks.v2beta3.Task.PayloadTypeCase
com.google.cloud.tasks.v2beta3.Task.View The view specifies a subset of Task data.
com.google.cloud.tasks.v2beta3.UriOverride.Scheme The Scheme for an HTTP request. By default, it is HTTPS.
com.google.cloud.tasks.v2beta3.UriOverride.UriOverrideEnforceMode UriOverrideEnforceMode mode is to define enforcing mode for the override modes.