com.google.cloud.tasks.v2

Class CloudTasksSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<CloudTasksSettings>

com.google.cloud.tasks.v2.CloudTasksSettings

@Generated(value="by gapic-generator-java")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudTasksSettings.Builder Builder for CloudTasksSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudTasksSettings(CloudTasksSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static CloudTasksSettings	create(CloudTasksStubSettings stub)
UnaryCallSettings<CreateQueueRequest,Queue>	createQueueSettings() Returns the object with the settings used for calls to createQueue.
UnaryCallSettings<CreateTaskRequest,Task>	createTaskSettings() Returns the object with the settings used for calls to createTask.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<DeleteQueueRequest,Empty>	deleteQueueSettings() Returns the object with the settings used for calls to deleteQueue.
UnaryCallSettings<DeleteTaskRequest,Empty>	deleteTaskSettings() Returns the object with the settings used for calls to deleteTask.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
UnaryCallSettings<GetQueueRequest,Queue>	getQueueSettings() Returns the object with the settings used for calls to getQueue.
UnaryCallSettings<GetTaskRequest,Task>	getTaskSettings() Returns the object with the settings used for calls to getTask.
PagedCallSettings<ListQueuesRequest,ListQueuesResponse,CloudTasksClient.ListQueuesPagedResponse>	listQueuesSettings() Returns the object with the settings used for calls to listQueues.
PagedCallSettings<ListTasksRequest,ListTasksResponse,CloudTasksClient.ListTasksPagedResponse>	listTasksSettings() Returns the object with the settings used for calls to listTasks.
static CloudTasksSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static CloudTasksSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
static CloudTasksSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
UnaryCallSettings<PauseQueueRequest,Queue>	pauseQueueSettings() Returns the object with the settings used for calls to pauseQueue.
UnaryCallSettings<PurgeQueueRequest,Queue>	purgeQueueSettings() Returns the object with the settings used for calls to purgeQueue.
UnaryCallSettings<ResumeQueueRequest,Queue>	resumeQueueSettings() Returns the object with the settings used for calls to resumeQueue.
UnaryCallSettings<RunTaskRequest,Task>	runTaskSettings() Returns the object with the settings used for calls to runTask.
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
CloudTasksSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<UpdateQueueRequest,Queue>	updateQueueSettings() Returns the object with the settings used for calls to updateQueue.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CloudTasksSettings

protected CloudTasksSettings(CloudTasksSettings.Builder settingsBuilder)
                      throws IOException

Throws:

IOException

Method Detail

listQueuesSettings

public PagedCallSettings<ListQueuesRequest,ListQueuesResponse,CloudTasksClient.ListQueuesPagedResponse> listQueuesSettings()

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

getQueueSettings

public UnaryCallSettings<GetQueueRequest,Queue> getQueueSettings()

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

createQueueSettings

public UnaryCallSettings<CreateQueueRequest,Queue> createQueueSettings()

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

updateQueueSettings

public UnaryCallSettings<UpdateQueueRequest,Queue> updateQueueSettings()

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

deleteQueueSettings

public UnaryCallSettings<DeleteQueueRequest,Empty> deleteQueueSettings()

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

purgeQueueSettings

public UnaryCallSettings<PurgeQueueRequest,Queue> purgeQueueSettings()

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

pauseQueueSettings

public UnaryCallSettings<PauseQueueRequest,Queue> pauseQueueSettings()

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

resumeQueueSettings

public UnaryCallSettings<ResumeQueueRequest,Queue> resumeQueueSettings()

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

getIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

setIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

testIamPermissionsSettings

public UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

listTasksSettings

public PagedCallSettings<ListTasksRequest,ListTasksResponse,CloudTasksClient.ListTasksPagedResponse> listTasksSettings()

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

getTaskSettings

public UnaryCallSettings<GetTaskRequest,Task> getTaskSettings()

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

createTaskSettings

public UnaryCallSettings<CreateTaskRequest,Task> createTaskSettings()

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

deleteTaskSettings

public UnaryCallSettings<DeleteTaskRequest,Empty> deleteTaskSettings()

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

runTaskSettings

public UnaryCallSettings<RunTaskRequest,Task> runTaskSettings()

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

create

public static final CloudTasksSettings create(CloudTasksStubSettings stub)
                                       throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static CloudTasksSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static CloudTasksSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static CloudTasksSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public CloudTasksSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<CloudTasksSettings>