Class DatabaseAdminSettings (6.82.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 RetrySettings of getDatabase:


 // 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
 DatabaseAdminSettings.Builder databaseAdminSettingsBuilder = DatabaseAdminSettings.newBuilder();
 databaseAdminSettingsBuilder
     .getDatabaseSettings()
     .setRetrySettings(
         databaseAdminSettingsBuilder
             .getDatabaseSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 DatabaseAdminSettings databaseAdminSettings = databaseAdminSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createDatabase:


 // 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
 DatabaseAdminSettings.Builder databaseAdminSettingsBuilder = DatabaseAdminSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 databaseAdminSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > DatabaseAdminSettings

Static Methods

create(DatabaseAdminStubSettings stub)

public static final DatabaseAdminSettings create(DatabaseAdminStubSettings stub)
Parameter
Name Description
stub DatabaseAdminStubSettings
Returns
Type Description
DatabaseAdminSettings
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 DatabaseAdminSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
DatabaseAdminSettings.Builder

newBuilder(ClientContext clientContext)

public static DatabaseAdminSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
DatabaseAdminSettings.Builder

newHttpJsonBuilder()

public static DatabaseAdminSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
DatabaseAdminSettings.Builder

Constructors

DatabaseAdminSettings(DatabaseAdminSettings.Builder settingsBuilder)

protected DatabaseAdminSettings(DatabaseAdminSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder DatabaseAdminSettings.Builder

Methods

copyBackupOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<CopyBackupRequest,Backup,CopyBackupMetadata>

copyBackupSettings()

public UnaryCallSettings<CopyBackupRequest,Operation> copyBackupSettings()

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

Returns
Type Description
UnaryCallSettings<CopyBackupRequest,Operation>

createBackupOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<CreateBackupRequest,Backup,CreateBackupMetadata>

createBackupScheduleSettings()

public UnaryCallSettings<CreateBackupScheduleRequest,BackupSchedule> createBackupScheduleSettings()

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

Returns
Type Description
UnaryCallSettings<CreateBackupScheduleRequest,BackupSchedule>

createBackupSettings()

public UnaryCallSettings<CreateBackupRequest,Operation> createBackupSettings()

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

Returns
Type Description
UnaryCallSettings<CreateBackupRequest,Operation>

createDatabaseOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<CreateDatabaseRequest,Database,CreateDatabaseMetadata>

createDatabaseSettings()

public UnaryCallSettings<CreateDatabaseRequest,Operation> createDatabaseSettings()

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

Returns
Type Description
UnaryCallSettings<CreateDatabaseRequest,Operation>

deleteBackupScheduleSettings()

public UnaryCallSettings<DeleteBackupScheduleRequest,Empty> deleteBackupScheduleSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteBackupScheduleRequest,Empty>

deleteBackupSettings()

public UnaryCallSettings<DeleteBackupRequest,Empty> deleteBackupSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteBackupRequest,Empty>

dropDatabaseSettings()

public UnaryCallSettings<DropDatabaseRequest,Empty> dropDatabaseSettings()

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

Returns
Type Description
UnaryCallSettings<DropDatabaseRequest,Empty>

getBackupScheduleSettings()

public UnaryCallSettings<GetBackupScheduleRequest,BackupSchedule> getBackupScheduleSettings()

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

Returns
Type Description
UnaryCallSettings<GetBackupScheduleRequest,BackupSchedule>

getBackupSettings()

public UnaryCallSettings<GetBackupRequest,Backup> getBackupSettings()

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

Returns
Type Description
UnaryCallSettings<GetBackupRequest,Backup>

getDatabaseDdlSettings()

public UnaryCallSettings<GetDatabaseDdlRequest,GetDatabaseDdlResponse> getDatabaseDdlSettings()

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

Returns
Type Description
UnaryCallSettings<GetDatabaseDdlRequest,GetDatabaseDdlResponse>

getDatabaseSettings()

public UnaryCallSettings<GetDatabaseRequest,Database> getDatabaseSettings()

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

Returns
Type Description
UnaryCallSettings<GetDatabaseRequest,Database>

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>

listBackupOperationsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListBackupOperationsRequest,ListBackupOperationsResponse,ListBackupOperationsPagedResponse>

listBackupSchedulesSettings()

public PagedCallSettings<ListBackupSchedulesRequest,ListBackupSchedulesResponse,DatabaseAdminClient.ListBackupSchedulesPagedResponse> listBackupSchedulesSettings()

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

Returns
Type Description
PagedCallSettings<ListBackupSchedulesRequest,ListBackupSchedulesResponse,ListBackupSchedulesPagedResponse>

listBackupsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListBackupsRequest,ListBackupsResponse,ListBackupsPagedResponse>

listDatabaseOperationsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListDatabaseOperationsRequest,ListDatabaseOperationsResponse,ListDatabaseOperationsPagedResponse>

listDatabaseRolesSettings()

public PagedCallSettings<ListDatabaseRolesRequest,ListDatabaseRolesResponse,DatabaseAdminClient.ListDatabaseRolesPagedResponse> listDatabaseRolesSettings()

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

Returns
Type Description
PagedCallSettings<ListDatabaseRolesRequest,ListDatabaseRolesResponse,ListDatabaseRolesPagedResponse>

listDatabasesSettings()

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

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

Returns
Type Description
PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse,ListDatabasesPagedResponse>

restoreDatabaseOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata>

restoreDatabaseSettings()

public UnaryCallSettings<RestoreDatabaseRequest,Operation> restoreDatabaseSettings()

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

Returns
Type Description
UnaryCallSettings<RestoreDatabaseRequest,Operation>

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 DatabaseAdminSettings.Builder toBuilder()

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

Returns
Type Description
DatabaseAdminSettings.Builder
Overrides

updateBackupScheduleSettings()

public UnaryCallSettings<UpdateBackupScheduleRequest,BackupSchedule> updateBackupScheduleSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateBackupScheduleRequest,BackupSchedule>

updateBackupSettings()

public UnaryCallSettings<UpdateBackupRequest,Backup> updateBackupSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateBackupRequest,Backup>

updateDatabaseDdlOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<UpdateDatabaseDdlRequest,Empty,UpdateDatabaseDdlMetadata>

updateDatabaseDdlSettings()

public UnaryCallSettings<UpdateDatabaseDdlRequest,Operation> updateDatabaseDdlSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateDatabaseDdlRequest,Operation>

updateDatabaseOperationSettings()

public OperationCallSettings<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata> updateDatabaseOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata>

updateDatabaseSettings()

public UnaryCallSettings<UpdateDatabaseRequest,Operation> updateDatabaseSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateDatabaseRequest,Operation>