com.google.cloud.spanner.admin.database.v1

Class DatabaseAdminSettings

java.lang.Object

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

com.google.cloud.spanner.admin.database.v1.DatabaseAdminSettings

@Generated(value="by gapic-generator-java")
public class DatabaseAdminSettings
extends ClientSettings<DatabaseAdminSettings>

Settings class to configure an instance of DatabaseAdminClient.

The default instance has everything set to sensible defaults:

• The default service address (spanner.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 getDatabase to 30 seconds:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 DatabaseAdminSettings.Builder databaseAdminSettingsBuilder = DatabaseAdminSettings.newBuilder();
 databaseAdminSettingsBuilder
     .getDatabaseSettings()
     .setRetrySettings(
         databaseAdminSettingsBuilder
             .getDatabaseSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DatabaseAdminSettings databaseAdminSettings = databaseAdminSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
OperationCallSettings<CopyBackupRequest,Backup,CopyBackupMetadata>	copyBackupOperationSettings() Returns the object with the settings used for calls to copyBackup.
UnaryCallSettings<CopyBackupRequest,Operation>	copyBackupSettings() Returns the object with the settings used for calls to copyBackup.
static DatabaseAdminSettings	create(DatabaseAdminStubSettings stub)
OperationCallSettings<CreateBackupRequest,Backup,CreateBackupMetadata>	createBackupOperationSettings() Returns the object with the settings used for calls to createBackup.
UnaryCallSettings<CreateBackupRequest,Operation>	createBackupSettings() Returns the object with the settings used for calls to createBackup.
OperationCallSettings<CreateDatabaseRequest,Database,CreateDatabaseMetadata>	createDatabaseOperationSettings() Returns the object with the settings used for calls to createDatabase.
UnaryCallSettings<CreateDatabaseRequest,Operation>	createDatabaseSettings() Returns the object with the settings used for calls to createDatabase.
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 ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<DeleteBackupRequest,Empty>	deleteBackupSettings() Returns the object with the settings used for calls to deleteBackup.
UnaryCallSettings<DropDatabaseRequest,Empty>	dropDatabaseSettings() Returns the object with the settings used for calls to dropDatabase.
UnaryCallSettings<GetBackupRequest,Backup>	getBackupSettings() Returns the object with the settings used for calls to getBackup.
UnaryCallSettings<GetDatabaseDdlRequest,GetDatabaseDdlResponse>	getDatabaseDdlSettings() Returns the object with the settings used for calls to getDatabaseDdl.
UnaryCallSettings<GetDatabaseRequest,Database>	getDatabaseSettings() Returns the object with the settings used for calls to getDatabase.
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.
PagedCallSettings<ListBackupOperationsRequest,ListBackupOperationsResponse,DatabaseAdminClient.ListBackupOperationsPagedResponse>	listBackupOperationsSettings() Returns the object with the settings used for calls to listBackupOperations.
PagedCallSettings<ListBackupsRequest,ListBackupsResponse,DatabaseAdminClient.ListBackupsPagedResponse>	listBackupsSettings() Returns the object with the settings used for calls to listBackups.
PagedCallSettings<ListDatabaseOperationsRequest,ListDatabaseOperationsResponse,DatabaseAdminClient.ListDatabaseOperationsPagedResponse>	listDatabaseOperationsSettings() Returns the object with the settings used for calls to listDatabaseOperations.
PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse,DatabaseAdminClient.ListDatabasesPagedResponse>	listDatabasesSettings() Returns the object with the settings used for calls to listDatabases.
static DatabaseAdminSettings.Builder	newBuilder() Returns a new builder for this class.
static DatabaseAdminSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
OperationCallSettings<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata>	restoreDatabaseOperationSettings() Returns the object with the settings used for calls to restoreDatabase.
UnaryCallSettings<RestoreDatabaseRequest,Operation>	restoreDatabaseSettings() Returns the object with the settings used for calls to restoreDatabase.
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.
DatabaseAdminSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<UpdateBackupRequest,Backup>	updateBackupSettings() Returns the object with the settings used for calls to updateBackup.
OperationCallSettings<UpdateDatabaseDdlRequest,Empty,UpdateDatabaseDdlMetadata>	updateDatabaseDdlOperationSettings() Returns the object with the settings used for calls to updateDatabaseDdl.
UnaryCallSettings<UpdateDatabaseDdlRequest,Operation>	updateDatabaseDdlSettings() Returns the object with the settings used for calls to updateDatabaseDdl.

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

DatabaseAdminSettings

protected DatabaseAdminSettings(DatabaseAdminSettings.Builder settingsBuilder)
                         throws IOException

Throws:

IOException

Method Detail

listDatabasesSettings

public PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse,DatabaseAdminClient.ListDatabasesPagedResponse> listDatabasesSettings()

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

createDatabaseSettings

public UnaryCallSettings<CreateDatabaseRequest,Operation> createDatabaseSettings()

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

createDatabaseOperationSettings

public OperationCallSettings<CreateDatabaseRequest,Database,CreateDatabaseMetadata> createDatabaseOperationSettings()

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

getDatabaseSettings

public UnaryCallSettings<GetDatabaseRequest,Database> getDatabaseSettings()

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

updateDatabaseDdlSettings

public UnaryCallSettings<UpdateDatabaseDdlRequest,Operation> updateDatabaseDdlSettings()

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

updateDatabaseDdlOperationSettings

public OperationCallSettings<UpdateDatabaseDdlRequest,Empty,UpdateDatabaseDdlMetadata> updateDatabaseDdlOperationSettings()

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

dropDatabaseSettings

public UnaryCallSettings<DropDatabaseRequest,Empty> dropDatabaseSettings()

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

getDatabaseDdlSettings

public UnaryCallSettings<GetDatabaseDdlRequest,GetDatabaseDdlResponse> getDatabaseDdlSettings()

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

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.

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.

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.

createBackupSettings

public UnaryCallSettings<CreateBackupRequest,Operation> createBackupSettings()

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

createBackupOperationSettings

public OperationCallSettings<CreateBackupRequest,Backup,CreateBackupMetadata> createBackupOperationSettings()

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

copyBackupSettings

public UnaryCallSettings<CopyBackupRequest,Operation> copyBackupSettings()

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

copyBackupOperationSettings

public OperationCallSettings<CopyBackupRequest,Backup,CopyBackupMetadata> copyBackupOperationSettings()

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

getBackupSettings

public UnaryCallSettings<GetBackupRequest,Backup> getBackupSettings()

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

updateBackupSettings

public UnaryCallSettings<UpdateBackupRequest,Backup> updateBackupSettings()

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

deleteBackupSettings

public UnaryCallSettings<DeleteBackupRequest,Empty> deleteBackupSettings()

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

listBackupsSettings

public PagedCallSettings<ListBackupsRequest,ListBackupsResponse,DatabaseAdminClient.ListBackupsPagedResponse> listBackupsSettings()

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

restoreDatabaseSettings

public UnaryCallSettings<RestoreDatabaseRequest,Operation> restoreDatabaseSettings()

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

restoreDatabaseOperationSettings

public OperationCallSettings<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata> restoreDatabaseOperationSettings()

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

listDatabaseOperationsSettings

public PagedCallSettings<ListDatabaseOperationsRequest,ListDatabaseOperationsResponse,DatabaseAdminClient.ListDatabaseOperationsPagedResponse> listDatabaseOperationsSettings()

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

listBackupOperationsSettings

public PagedCallSettings<ListBackupOperationsRequest,ListBackupOperationsResponse,DatabaseAdminClient.ListBackupOperationsPagedResponse> listBackupOperationsSettings()

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

create

public static final DatabaseAdminSettings create(DatabaseAdminStubSettings 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 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 DatabaseAdminSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static DatabaseAdminSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public DatabaseAdminSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<DatabaseAdminSettings>