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

RepositoryRPC DocumentationREST 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.

ClientDescription
com.google.cloud.tasks.v2beta3.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.v2beta3.CloudTasksSettingsSettings class to configure an instance of CloudTasksClient.

The default instance has everything set to sensible defaults:

Classes

ClassDescription
com.google.cloud.tasks.v2beta3.AppEngineHttpQueueApp Engine HTTP queue. The task will be delivered to the App Engine application hostname
com.google.cloud.tasks.v2beta3.AppEngineHttpQueue.BuilderApp Engine HTTP queue. The task will be delivered to the App Engine application hostname
com.google.cloud.tasks.v2beta3.AppEngineHttpRequestApp Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when
com.google.cloud.tasks.v2beta3.AppEngineHttpRequest.BuilderApp Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when
com.google.cloud.tasks.v2beta3.AppEngineRoutingApp Engine Routing. Defines routing characteristics specific to App Engine - service, version,
com.google.cloud.tasks.v2beta3.AppEngineRouting.BuilderApp Engine Routing. Defines routing characteristics specific to App Engine - service, version,
com.google.cloud.tasks.v2beta3.AttemptThe status of a task attempt.
com.google.cloud.tasks.v2beta3.Attempt.BuilderThe 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.CloudTasksGrpcCloud Tasks allows developers to manage the execution of background work in their applications.
com.google.cloud.tasks.v2beta3.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.v2beta3.CloudTasksProto
com.google.cloud.tasks.v2beta3.CloudTasksSettings.BuilderBuilder for CloudTasksSettings.
com.google.cloud.tasks.v2beta3.CreateQueueRequestRequest message for CreateQueue.
com.google.cloud.tasks.v2beta3.CreateQueueRequest.BuilderRequest message for CreateQueue.
com.google.cloud.tasks.v2beta3.CreateTaskRequestRequest message for CreateTask.
com.google.cloud.tasks.v2beta3.CreateTaskRequest.BuilderRequest message for CreateTask.
com.google.cloud.tasks.v2beta3.DeleteQueueRequestRequest message for DeleteQueue.
com.google.cloud.tasks.v2beta3.DeleteQueueRequest.BuilderRequest message for DeleteQueue.
com.google.cloud.tasks.v2beta3.DeleteTaskRequestRequest message for deleting a task using DeleteTask.
com.google.cloud.tasks.v2beta3.DeleteTaskRequest.BuilderRequest message for deleting a task using DeleteTask.
com.google.cloud.tasks.v2beta3.GetQueueRequestRequest message for GetQueue.
com.google.cloud.tasks.v2beta3.GetQueueRequest.BuilderRequest message for GetQueue.
com.google.cloud.tasks.v2beta3.GetTaskRequestRequest message for getting a task using GetTask.
com.google.cloud.tasks.v2beta3.GetTaskRequest.BuilderRequest message for getting a task using GetTask.
com.google.cloud.tasks.v2beta3.HttpRequestHTTP request. The task will be pushed to the worker as an HTTP request. If the worker
com.google.cloud.tasks.v2beta3.HttpRequest.BuilderHTTP request. The task will be pushed to the worker as an HTTP request. If the worker
com.google.cloud.tasks.v2beta3.HttpTargetHTTP target. When specified as a Queue, all the tasks with [HttpRequest]
com.google.cloud.tasks.v2beta3.HttpTarget.BuilderHTTP target. When specified as a Queue, all the tasks with [HttpRequest]
com.google.cloud.tasks.v2beta3.HttpTarget.HeaderDefines a header message. A header can have a key and a value.
com.google.cloud.tasks.v2beta3.HttpTarget.Header.BuilderDefines a header message. A header can have a key and a value.
com.google.cloud.tasks.v2beta3.HttpTarget.HeaderOverrideWraps the Header object.
com.google.cloud.tasks.v2beta3.HttpTarget.HeaderOverride.BuilderWraps the Header object.
com.google.cloud.tasks.v2beta3.ListQueuesRequestRequest message for ListQueues.
com.google.cloud.tasks.v2beta3.ListQueuesRequest.BuilderRequest message for ListQueues.
com.google.cloud.tasks.v2beta3.ListQueuesResponseResponse message for ListQueues.
com.google.cloud.tasks.v2beta3.ListQueuesResponse.BuilderResponse message for ListQueues.
com.google.cloud.tasks.v2beta3.ListTasksRequestRequest message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta3.ListTasksRequest.BuilderRequest message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta3.ListTasksResponseResponse message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta3.ListTasksResponse.BuilderResponse message for listing tasks using ListTasks.
com.google.cloud.tasks.v2beta3.LocationName
com.google.cloud.tasks.v2beta3.LocationName.BuilderBuilder for projects/{project}/locations/{location}.
com.google.cloud.tasks.v2beta3.OAuthTokenContains 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.BuilderContains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google
com.google.cloud.tasks.v2beta3.OidcTokenContains information needed for generating an OpenID Connect token.
com.google.cloud.tasks.v2beta3.OidcToken.BuilderContains information needed for generating an OpenID Connect token.
com.google.cloud.tasks.v2beta3.PathOverridePathOverride. Path message defines path override for HTTP targets.
com.google.cloud.tasks.v2beta3.PathOverride.BuilderPathOverride. Path message defines path override for HTTP targets.
com.google.cloud.tasks.v2beta3.PauseQueueRequestRequest message for PauseQueue.
com.google.cloud.tasks.v2beta3.PauseQueueRequest.BuilderRequest message for PauseQueue.
com.google.cloud.tasks.v2beta3.ProjectName
com.google.cloud.tasks.v2beta3.ProjectName.BuilderBuilder for ProjectName.
com.google.cloud.tasks.v2beta3.PullMessagePull Message. This proto can only be used for tasks in a queue which has
com.google.cloud.tasks.v2beta3.PullMessage.BuilderPull Message. This proto can only be used for tasks in a queue which has
com.google.cloud.tasks.v2beta3.PurgeQueueRequestRequest message for PurgeQueue.
com.google.cloud.tasks.v2beta3.PurgeQueueRequest.BuilderRequest message for PurgeQueue.
com.google.cloud.tasks.v2beta3.QueryOverrideQueryOverride. Query message defines query override for HTTP targets.
com.google.cloud.tasks.v2beta3.QueryOverride.BuilderQueryOverride. Query message defines query override for HTTP targets.
com.google.cloud.tasks.v2beta3.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, queue types, and others.
com.google.cloud.tasks.v2beta3.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, queue types, and others.
com.google.cloud.tasks.v2beta3.QueueName
com.google.cloud.tasks.v2beta3.QueueName.BuilderBuilder for projects/{project}/locations/{location}/queues/{queue}.
com.google.cloud.tasks.v2beta3.QueueProto
com.google.cloud.tasks.v2beta3.QueueStatsStatistics for a queue.
com.google.cloud.tasks.v2beta3.QueueStats.BuilderStatistics for a queue.
com.google.cloud.tasks.v2beta3.RateLimitsRate limits. This message determines the maximum rate that tasks can be dised by a
com.google.cloud.tasks.v2beta3.RateLimits.BuilderRate limits. This message determines the maximum rate that tasks can be dised by a
com.google.cloud.tasks.v2beta3.ResumeQueueRequestRequest message for ResumeQueue.
com.google.cloud.tasks.v2beta3.ResumeQueueRequest.BuilderRequest message for ResumeQueue.
com.google.cloud.tasks.v2beta3.RetryConfigRetry config. These settings determine when a failed task attempt is retried.
com.google.cloud.tasks.v2beta3.RetryConfig.BuilderRetry config. These settings determine when a failed task attempt is retried.
com.google.cloud.tasks.v2beta3.RunTaskRequestRequest message for forcing a task to run now using RunTask.
com.google.cloud.tasks.v2beta3.RunTaskRequest.BuilderRequest message for forcing a task to run now using RunTask.
com.google.cloud.tasks.v2beta3.StackdriverLoggingConfigConfiguration options for writing logs to Stackdriver Logging.
com.google.cloud.tasks.v2beta3.StackdriverLoggingConfig.BuilderConfiguration options for writing logs to Stackdriver Logging.
com.google.cloud.tasks.v2beta3.TargetProto
com.google.cloud.tasks.v2beta3.TaskA unit of scheduled work.
com.google.cloud.tasks.v2beta3.Task.BuilderA unit of scheduled work.
com.google.cloud.tasks.v2beta3.TaskName
com.google.cloud.tasks.v2beta3.TaskName.BuilderBuilder for projects/{project}/locations/{location}/queues/{queue}/tasks/{task}.
com.google.cloud.tasks.v2beta3.TaskProto
com.google.cloud.tasks.v2beta3.UpdateQueueRequestRequest message for UpdateQueue.
com.google.cloud.tasks.v2beta3.UpdateQueueRequest.BuilderRequest message for UpdateQueue.
com.google.cloud.tasks.v2beta3.UriOverrideURI Override. When specified, all the HTTP tasks inside the queue will be partially or
com.google.cloud.tasks.v2beta3.UriOverride.BuilderURI Override. When specified, all the HTTP tasks inside the queue will be partially or

Interfaces

InterfaceDescription
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.AsyncServiceCloud 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

EnumDescription
com.google.cloud.tasks.v2beta3.HttpMethodThe 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.StateState of the queue.
com.google.cloud.tasks.v2beta3.Queue.TypeThe type of the queue.
com.google.cloud.tasks.v2beta3.Task.PayloadTypeCase
com.google.cloud.tasks.v2beta3.Task.ViewThe view specifies a subset of Task data.
com.google.cloud.tasks.v2beta3.UriOverride.SchemeThe Scheme for an HTTP request. By default, it is HTTPS.
com.google.cloud.tasks.v2beta3.UriOverride.UriOverrideEnforceModeUriOverrideEnforceMode mode is to define enforcing mode for the override modes.