public class CloudTasksSettings extends ClientSettings<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.Builder cloudTasksSettingsBuilder = CloudTasksSettings.newBuilder();
cloudTasksSettingsBuilder
.getQueueSettings()
.setRetrySettings(
cloudTasksSettingsBuilder
.getQueueSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
CloudTasksSettings cloudTasksSettings = cloudTasksSettingsBuilder.build();
Static Methods
create(CloudTasksStubSettings stub)
public static final CloudTasksSettings create(CloudTasksStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
CloudTasksStubSettings |
| Returns | |
|---|---|
| Type | Description |
CloudTasksSettings |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default gRPC ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Returns | |
|---|---|
| Type | Description |
TransportChannelProvider |
|
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Returns | |
|---|---|
| Type | Description |
String |
|
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Returns | |
|---|---|
| Type | Description |
List<String> |
|
newBuilder()
public static CloudTasksSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
CloudTasksSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static CloudTasksSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
CloudTasksSettings.Builder |
|
newHttpJsonBuilder()
public static CloudTasksSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
CloudTasksSettings.Builder |
|
Constructors
CloudTasksSettings(CloudTasksSettings.Builder settingsBuilder)
protected CloudTasksSettings(CloudTasksSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
CloudTasksSettings.Builder |
Methods
acknowledgeTaskSettings()
public UnaryCallSettings<AcknowledgeTaskRequest,Empty> acknowledgeTaskSettings()Returns the object with the settings used for calls to acknowledgeTask.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<AcknowledgeTaskRequest,Empty> |
|
cancelLeaseSettings()
public UnaryCallSettings<CancelLeaseRequest,Task> cancelLeaseSettings()Returns the object with the settings used for calls to cancelLease.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CancelLeaseRequest,Task> |
|
createQueueSettings()
public UnaryCallSettings<CreateQueueRequest,Queue> createQueueSettings()Returns the object with the settings used for calls to createQueue.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateQueueRequest,Queue> |
|
createTaskSettings()
public UnaryCallSettings<CreateTaskRequest,Task> createTaskSettings()Returns the object with the settings used for calls to createTask.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateTaskRequest,Task> |
|
deleteQueueSettings()
public UnaryCallSettings<DeleteQueueRequest,Empty> deleteQueueSettings()Returns the object with the settings used for calls to deleteQueue.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteQueueRequest,Empty> |
|
deleteTaskSettings()
public UnaryCallSettings<DeleteTaskRequest,Empty> deleteTaskSettings()Returns the object with the settings used for calls to deleteTask.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteTaskRequest,Empty> |
|
getIamPolicySettings()
public UnaryCallSettings<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()
public UnaryCallSettings<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()
public UnaryCallSettings<GetQueueRequest,Queue> getQueueSettings()Returns the object with the settings used for calls to getQueue.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetQueueRequest,Queue> |
|
getTaskSettings()
public UnaryCallSettings<GetTaskRequest,Task> getTaskSettings()Returns the object with the settings used for calls to getTask.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetTaskRequest,Task> |
|
leaseTasksSettings()
public UnaryCallSettings<LeaseTasksRequest,LeaseTasksResponse> leaseTasksSettings()Returns the object with the settings used for calls to leaseTasks.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<LeaseTasksRequest,LeaseTasksResponse> |
|
listLocationsSettings()
public PagedCallSettings<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()
public PagedCallSettings<ListQueuesRequest,ListQueuesResponse,CloudTasksClient.ListQueuesPagedResponse> listQueuesSettings()Returns the object with the settings used for calls to listQueues.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListQueuesRequest,ListQueuesResponse,ListQueuesPagedResponse> |
|
listTasksSettings()
public PagedCallSettings<ListTasksRequest,ListTasksResponse,CloudTasksClient.ListTasksPagedResponse> listTasksSettings()Returns the object with the settings used for calls to listTasks.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListTasksRequest,ListTasksResponse,ListTasksPagedResponse> |
|
pauseQueueSettings()
public UnaryCallSettings<PauseQueueRequest,Queue> pauseQueueSettings()Returns the object with the settings used for calls to pauseQueue.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<PauseQueueRequest,Queue> |
|
purgeQueueSettings()
public UnaryCallSettings<PurgeQueueRequest,Queue> purgeQueueSettings()Returns the object with the settings used for calls to purgeQueue.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<PurgeQueueRequest,Queue> |
|
renewLeaseSettings()
public UnaryCallSettings<RenewLeaseRequest,Task> renewLeaseSettings()Returns the object with the settings used for calls to renewLease.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<RenewLeaseRequest,Task> |
|
resumeQueueSettings()
public UnaryCallSettings<ResumeQueueRequest,Queue> resumeQueueSettings()Returns the object with the settings used for calls to resumeQueue.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ResumeQueueRequest,Queue> |
|
runTaskSettings()
public UnaryCallSettings<RunTaskRequest,Task> runTaskSettings()Returns the object with the settings used for calls to runTask.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<RunTaskRequest,Task> |
|
setIamPolicySettings()
public UnaryCallSettings<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()
public UnaryCallSettings<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()
public CloudTasksSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
CloudTasksSettings.Builder |
|
updateQueueSettings()
public UnaryCallSettings<UpdateQueueRequest,Queue> updateQueueSettings()Returns the object with the settings used for calls to updateQueue.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateQueueRequest,Queue> |
|
uploadQueueYamlSettings()
public UnaryCallSettings<UploadQueueYamlRequest,Empty> uploadQueueYamlSettings()Returns the object with the settings used for calls to uploadQueueYaml.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UploadQueueYamlRequest,Empty> |
|