Class DatabaseAdminSettings (6.25.0)

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();
 

Inheritance

java.lang.Object > ClientSettings > DatabaseAdminSettings

Static Methods

create(DatabaseAdminStubSettings stub)

public static final DatabaseAdminSettings create(DatabaseAdminStubSettings stub)
Parameter
NameDescription
stubDatabaseAdminStubSettings
Returns
TypeDescription
DatabaseAdminSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static DatabaseAdminSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
DatabaseAdminSettings.Builder

newBuilder(ClientContext clientContext)

public static DatabaseAdminSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
DatabaseAdminSettings.Builder

Constructors

DatabaseAdminSettings(DatabaseAdminSettings.Builder settingsBuilder)

protected DatabaseAdminSettings(DatabaseAdminSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderDatabaseAdminSettings.Builder

Methods

copyBackupOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CopyBackupRequest,Backup,CopyBackupMetadata>

copyBackupSettings()

public UnaryCallSettings<CopyBackupRequest,Operation> copyBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<CopyBackupRequest,Operation>

createBackupOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateBackupRequest,Backup,CreateBackupMetadata>

createBackupSettings()

public UnaryCallSettings<CreateBackupRequest,Operation> createBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateBackupRequest,Operation>

createDatabaseOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateDatabaseRequest,Database,CreateDatabaseMetadata>

createDatabaseSettings()

public UnaryCallSettings<CreateDatabaseRequest,Operation> createDatabaseSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateDatabaseRequest,Operation>

deleteBackupSettings()

public UnaryCallSettings<DeleteBackupRequest,Empty> deleteBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteBackupRequest,Empty>

dropDatabaseSettings()

public UnaryCallSettings<DropDatabaseRequest,Empty> dropDatabaseSettings()

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

Returns
TypeDescription
UnaryCallSettings<DropDatabaseRequest,Empty>

getBackupSettings()

public UnaryCallSettings<GetBackupRequest,Backup> getBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetBackupRequest,Backup>

getDatabaseDdlSettings()

public UnaryCallSettings<GetDatabaseDdlRequest,GetDatabaseDdlResponse> getDatabaseDdlSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDatabaseDdlRequest,GetDatabaseDdlResponse>

getDatabaseSettings()

public UnaryCallSettings<GetDatabaseRequest,Database> getDatabaseSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDatabaseRequest,Database>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

listBackupOperationsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListBackupOperationsRequest,ListBackupOperationsResponse,ListBackupOperationsPagedResponse>

listBackupsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListBackupsRequest,ListBackupsResponse,ListBackupsPagedResponse>

listDatabaseOperationsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListDatabaseOperationsRequest,ListDatabaseOperationsResponse,ListDatabaseOperationsPagedResponse>

listDatabasesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse,ListDatabasesPagedResponse>

restoreDatabaseOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata>

restoreDatabaseSettings()

public UnaryCallSettings<RestoreDatabaseRequest,Operation> restoreDatabaseSettings()

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

Returns
TypeDescription
UnaryCallSettings<RestoreDatabaseRequest,Operation>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public DatabaseAdminSettings.Builder toBuilder()

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

Returns
TypeDescription
DatabaseAdminSettings.Builder
Overrides

updateBackupSettings()

public UnaryCallSettings<UpdateBackupRequest,Backup> updateBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateBackupRequest,Backup>

updateDatabaseDdlOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateDatabaseDdlRequest,Empty,UpdateDatabaseDdlMetadata>

updateDatabaseDdlSettings()

public UnaryCallSettings<UpdateDatabaseDdlRequest,Operation> updateDatabaseDdlSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateDatabaseDdlRequest,Operation>