Class CloudTasksSettings (2.6.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 total timeout of getQueue to 30 seconds:


// 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()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
CloudTasksSettingscloudTasksSettings=cloudTasksSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > CloudTasksSettings

Static Methods

create(CloudTasksStubSettings stub)

publicstaticfinalCloudTasksSettingscreate(CloudTasksStubSettingsstub)
Parameter
Name Description
Returns
Type Description
Exceptions
Type Description

defaultApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()
Returns
Type Description

defaultCredentialsProviderBuilder()

publicstaticGoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description

defaultExecutorProviderBuilder()

publicstaticInstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description

defaultGrpcTransportProviderBuilder()

publicstaticInstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()

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

Returns
Type Description

defaultHttpJsonTransportProviderBuilder()

publicstaticInstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()

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

Returns
Type Description

defaultTransportChannelProvider()

publicstaticTransportChannelProviderdefaultTransportChannelProvider()
Returns
Type Description

getDefaultEndpoint()

publicstaticStringgetDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description

getDefaultServiceScopes()

publicstaticList<String>getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description

newBuilder()

publicstaticCloudTasksSettings.BuildernewBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description

newBuilder(ClientContext clientContext)

publicstaticCloudTasksSettings.BuildernewBuilder(ClientContextclientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description

newHttpJsonBuilder()

publicstaticCloudTasksSettings.BuildernewHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description

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

createTaskSettings()

publicUnaryCallSettings<CreateTaskRequest,Task>createTaskSettings()

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

Returns
Type Description

deleteQueueSettings()

publicUnaryCallSettings<DeleteQueueRequest,Empty>deleteQueueSettings()

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

Returns
Type Description

deleteTaskSettings()

publicUnaryCallSettings<DeleteTaskRequest,Empty>deleteTaskSettings()

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

Returns
Type Description

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>

getQueueSettings()

publicUnaryCallSettings<GetQueueRequest,Queue>getQueueSettings()

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

Returns
Type Description

getTaskSettings()

publicUnaryCallSettings<GetTaskRequest,Task>getTaskSettings()

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

Returns
Type Description

listQueuesSettings()

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

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

Returns
Type Description

listTasksSettings()

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

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

Returns
Type Description

pauseQueueSettings()

publicUnaryCallSettings<PauseQueueRequest,Queue>pauseQueueSettings()

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

Returns
Type Description

purgeQueueSettings()

publicUnaryCallSettings<PurgeQueueRequest,Queue>purgeQueueSettings()

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

Returns
Type Description

resumeQueueSettings()

publicUnaryCallSettings<ResumeQueueRequest,Queue>resumeQueueSettings()

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

Returns
Type Description

runTaskSettings()

publicUnaryCallSettings<RunTaskRequest,Task>runTaskSettings()

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

Returns
Type Description

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
Overrides

updateQueueSettings()

publicUnaryCallSettings<UpdateQueueRequest,Queue>updateQueueSettings()

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

Returns
Type Description

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.