Class CloudTasksSettings (2.70.0)

publicclass CloudTasksSettingsextendsClientSettings<CloudTasksSettings>

Settings class to configure an instance of CloudTasksClient.

The default instance has everything set to sensible defaults:

  • The default service address (cloudtasks.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the RetrySettings of getQueue:


// 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
CloudTasksSettings.BuildercloudTasksSettingsBuilder=CloudTasksSettings.newBuilder();
cloudTasksSettingsBuilder
.getQueueSettings()
.setRetrySettings(
cloudTasksSettingsBuilder
.getQueueSettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
CloudTasksSettingscloudTasksSettings=cloudTasksSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > ClientSettings > CloudTasksSettings

Inherited Members

Static Methods

create(CloudTasksStubSettings stub)

publicstaticfinalCloudTasksSettingscreate(CloudTasksStubSettingsstub)
Parameter
Name Description
stub CloudTasksStubSettings
Returns
Type Description
CloudTasksSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

publicstaticGoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

publicstaticInstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

publicstaticInstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

publicstaticInstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

publicstaticTransportChannelProviderdefaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

publicstaticStringgetDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

publicstaticList<String>getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

publicstaticCloudTasksSettings.BuildernewBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
CloudTasksSettings.Builder

newBuilder(ClientContext clientContext)

publicstaticCloudTasksSettings.BuildernewBuilder(ClientContextclientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
CloudTasksSettings.Builder

newHttpJsonBuilder()

publicstaticCloudTasksSettings.BuildernewHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
CloudTasksSettings.Builder

Constructors

CloudTasksSettings(CloudTasksSettings.Builder settingsBuilder)

protectedCloudTasksSettings(CloudTasksSettings.BuildersettingsBuilder)
Parameter
Name Description
settingsBuilder CloudTasksSettings.Builder

Methods

createQueueSettings()

publicUnaryCallSettings<CreateQueueRequest,Queue>createQueueSettings()

Returns the object with the settings used for calls to createQueue.

Returns
Type Description
UnaryCallSettings<CreateQueueRequest,Queue>

createTaskSettings()

publicUnaryCallSettings<CreateTaskRequest,Task>createTaskSettings()

Returns the object with the settings used for calls to createTask.

Returns
Type Description
UnaryCallSettings<CreateTaskRequest,Task>

deleteQueueSettings()

publicUnaryCallSettings<DeleteQueueRequest,Empty>deleteQueueSettings()

Returns the object with the settings used for calls to deleteQueue.

Returns
Type Description
UnaryCallSettings<DeleteQueueRequest,Empty>

deleteTaskSettings()

publicUnaryCallSettings<DeleteTaskRequest,Empty>deleteTaskSettings()

Returns the object with the settings used for calls to deleteTask.

Returns
Type Description
UnaryCallSettings<DeleteTaskRequest,Empty>

getIamPolicySettings()

publicUnaryCallSettings<GetIamPolicyRequest,Policy>getIamPolicySettings()

Returns the object with the settings used for calls to getIamPolicy.

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocationSettings()

publicUnaryCallSettings<GetLocationRequest,Location>getLocationSettings()

Returns the object with the settings used for calls to getLocation.

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getQueueSettings()

publicUnaryCallSettings<GetQueueRequest,Queue>getQueueSettings()

Returns the object with the settings used for calls to getQueue.

Returns
Type Description
UnaryCallSettings<GetQueueRequest,Queue>

getTaskSettings()

publicUnaryCallSettings<GetTaskRequest,Task>getTaskSettings()

Returns the object with the settings used for calls to getTask.

Returns
Type Description
UnaryCallSettings<GetTaskRequest,Task>

listLocationsSettings()

publicPagedCallSettings<ListLocationsRequest,ListLocationsResponse,CloudTasksClient.ListLocationsPagedResponse>listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listQueuesSettings()

publicPagedCallSettings<ListQueuesRequest,ListQueuesResponse,CloudTasksClient.ListQueuesPagedResponse>listQueuesSettings()

Returns the object with the settings used for calls to listQueues.

Returns
Type Description
PagedCallSettings<ListQueuesRequest,ListQueuesResponse,ListQueuesPagedResponse>

listTasksSettings()

publicPagedCallSettings<ListTasksRequest,ListTasksResponse,CloudTasksClient.ListTasksPagedResponse>listTasksSettings()

Returns the object with the settings used for calls to listTasks.

Returns
Type Description
PagedCallSettings<ListTasksRequest,ListTasksResponse,ListTasksPagedResponse>

pauseQueueSettings()

publicUnaryCallSettings<PauseQueueRequest,Queue>pauseQueueSettings()

Returns the object with the settings used for calls to pauseQueue.

Returns
Type Description
UnaryCallSettings<PauseQueueRequest,Queue>

purgeQueueSettings()

publicUnaryCallSettings<PurgeQueueRequest,Queue>purgeQueueSettings()

Returns the object with the settings used for calls to purgeQueue.

Returns
Type Description
UnaryCallSettings<PurgeQueueRequest,Queue>

resumeQueueSettings()

publicUnaryCallSettings<ResumeQueueRequest,Queue>resumeQueueSettings()

Returns the object with the settings used for calls to resumeQueue.

Returns
Type Description
UnaryCallSettings<ResumeQueueRequest,Queue>

runTaskSettings()

publicUnaryCallSettings<RunTaskRequest,Task>runTaskSettings()

Returns the object with the settings used for calls to runTask.

Returns
Type Description
UnaryCallSettings<RunTaskRequest,Task>

setIamPolicySettings()

publicUnaryCallSettings<SetIamPolicyRequest,Policy>setIamPolicySettings()

Returns the object with the settings used for calls to setIamPolicy.

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

publicUnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse>testIamPermissionsSettings()

Returns the object with the settings used for calls to testIamPermissions.

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

publicCloudTasksSettings.BuildertoBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
CloudTasksSettings.Builder
Overrides

updateQueueSettings()

publicUnaryCallSettings<UpdateQueueRequest,Queue>updateQueueSettings()

Returns the object with the settings used for calls to updateQueue.

Returns
Type Description
UnaryCallSettings<UpdateQueueRequest,Queue>

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.