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();
Static Methods
create(CloudTasksStubSettings stub)
publicstaticfinalCloudTasksSettingscreate(CloudTasksStubSettingsstub)
publicstaticApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()
defaultCredentialsProviderBuilder()
publicstaticGoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
defaultExecutorProviderBuilder()
publicstaticInstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
defaultGrpcTransportProviderBuilder()
publicstaticInstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
defaultHttpJsonTransportProviderBuilder()
publicstaticInstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
defaultTransportChannelProvider()
publicstaticTransportChannelProviderdefaultTransportChannelProvider()
getDefaultEndpoint()
publicstaticStringgetDefaultEndpoint()
Returns the default service endpoint.
| Returns |
| Type |
Description |
String |
getDefaultServiceScopes()
publicstaticList<String>getDefaultServiceScopes()
Returns the default service scopes.
newBuilder()
publicstaticCloudTasksSettings.BuildernewBuilder()
Returns a new gRPC builder for this class.
newBuilder(ClientContext clientContext)
publicstaticCloudTasksSettings.BuildernewBuilder(ClientContextclientContext)
Returns a new builder for this class.
newHttpJsonBuilder()
publicstaticCloudTasksSettings.BuildernewHttpJsonBuilder()
Returns a new REST builder for this class.
Constructors
CloudTasksSettings(CloudTasksSettings.Builder settingsBuilder)
protectedCloudTasksSettings(CloudTasksSettings.BuildersettingsBuilder)
Methods
bufferTaskSettings()
publicUnaryCallSettings<BufferTaskRequest,BufferTaskResponse>bufferTaskSettings()
Returns the object with the settings used for calls to bufferTask.
createQueueSettings()
publicUnaryCallSettings<CreateQueueRequest,Queue>createQueueSettings()
Returns the object with the settings used for calls to createQueue.
createTaskSettings()
publicUnaryCallSettings<CreateTaskRequest,Task>createTaskSettings()
Returns the object with the settings used for calls to createTask.
deleteQueueSettings()
publicUnaryCallSettings<DeleteQueueRequest,Empty>deleteQueueSettings()
Returns the object with the settings used for calls to deleteQueue.
deleteTaskSettings()
publicUnaryCallSettings<DeleteTaskRequest,Empty>deleteTaskSettings()
Returns the object with the settings used for calls to deleteTask.
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.
getTaskSettings()
publicUnaryCallSettings<GetTaskRequest,Task>getTaskSettings()
Returns the object with the settings used for calls to getTask.
listLocationsSettings()
publicPagedCallSettings<ListLocationsRequest,ListLocationsResponse,CloudTasksClient.ListLocationsPagedResponse>listLocationsSettings()
Returns the object with the settings used for calls to listLocations.
listQueuesSettings()
publicPagedCallSettings<ListQueuesRequest,ListQueuesResponse,CloudTasksClient.ListQueuesPagedResponse>listQueuesSettings()
Returns the object with the settings used for calls to listQueues.
listTasksSettings()
publicPagedCallSettings<ListTasksRequest,ListTasksResponse,CloudTasksClient.ListTasksPagedResponse>listTasksSettings()
Returns the object with the settings used for calls to listTasks.
pauseQueueSettings()
publicUnaryCallSettings<PauseQueueRequest,Queue>pauseQueueSettings()
Returns the object with the settings used for calls to pauseQueue.
purgeQueueSettings()
publicUnaryCallSettings<PurgeQueueRequest,Queue>purgeQueueSettings()
Returns the object with the settings used for calls to purgeQueue.
resumeQueueSettings()
publicUnaryCallSettings<ResumeQueueRequest,Queue>resumeQueueSettings()
Returns the object with the settings used for calls to resumeQueue.
runTaskSettings()
publicUnaryCallSettings<RunTaskRequest,Task>runTaskSettings()
Returns the object with the settings used for calls to runTask.
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.
updateQueueSettings()
publicUnaryCallSettings<UpdateQueueRequest,Queue>updateQueueSettings()
Returns the object with the settings used for calls to updateQueue.