Class DatabaseAdminSettings (6.89.0)

publicclassDatabaseAdminSettingsextendsClientSettings<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_libraryDatabaseAdminSettings.BuilderdatabaseAdminSettingsBuilder=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());DatabaseAdminSettingsdatabaseAdminSettings=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_libraryDatabaseAdminSettings.BuilderdatabaseAdminSettingsBuilder=DatabaseAdminSettings.newBuilder();TimedRetryAlgorithmtimedRetryAlgorithm=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)

publicstaticfinalDatabaseAdminSettingscreate(DatabaseAdminStubSettingsstub)
Parameter
NameDescription
stubDatabaseAdminStubSettings
Returns
TypeDescription
DatabaseAdminSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

publicstaticGoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

publicstaticInstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

publicstaticInstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

publicstaticInstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

publicstaticTransportChannelProviderdefaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

publicstaticStringgetDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

publicstaticList<String>getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

publicstaticDatabaseAdminSettings.BuildernewBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
DatabaseAdminSettings.Builder

newBuilder(ClientContext clientContext)

publicstaticDatabaseAdminSettings.BuildernewBuilder(ClientContextclientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
DatabaseAdminSettings.Builder

newHttpJsonBuilder()

publicstaticDatabaseAdminSettings.BuildernewHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
DatabaseAdminSettings.Builder

Constructors

DatabaseAdminSettings(DatabaseAdminSettings.Builder settingsBuilder)

protectedDatabaseAdminSettings(DatabaseAdminSettings.BuildersettingsBuilder)
Parameter
NameDescription
settingsBuilderDatabaseAdminSettings.Builder

Methods

addSplitPointsSettings()

publicUnaryCallSettings<AddSplitPointsRequest,AddSplitPointsResponse>addSplitPointsSettings()

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

Returns
TypeDescription
UnaryCallSettings<AddSplitPointsRequest,AddSplitPointsResponse>

copyBackupOperationSettings()

publicOperationCallSettings<CopyBackupRequest,Backup,CopyBackupMetadata>copyBackupOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CopyBackupRequest,Backup,CopyBackupMetadata>

copyBackupSettings()

publicUnaryCallSettings<CopyBackupRequest,Operation>copyBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<CopyBackupRequest,Operation>

createBackupOperationSettings()

publicOperationCallSettings<CreateBackupRequest,Backup,CreateBackupMetadata>createBackupOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateBackupRequest,Backup,CreateBackupMetadata>

createBackupScheduleSettings()

publicUnaryCallSettings<CreateBackupScheduleRequest,BackupSchedule>createBackupScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateBackupScheduleRequest,BackupSchedule>

createBackupSettings()

publicUnaryCallSettings<CreateBackupRequest,Operation>createBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateBackupRequest,Operation>

createDatabaseOperationSettings()

publicOperationCallSettings<CreateDatabaseRequest,Database,CreateDatabaseMetadata>createDatabaseOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateDatabaseRequest,Database,CreateDatabaseMetadata>

createDatabaseSettings()

publicUnaryCallSettings<CreateDatabaseRequest,Operation>createDatabaseSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateDatabaseRequest,Operation>

deleteBackupScheduleSettings()

publicUnaryCallSettings<DeleteBackupScheduleRequest,Empty>deleteBackupScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteBackupScheduleRequest,Empty>

deleteBackupSettings()

publicUnaryCallSettings<DeleteBackupRequest,Empty>deleteBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteBackupRequest,Empty>

dropDatabaseSettings()

publicUnaryCallSettings<DropDatabaseRequest,Empty>dropDatabaseSettings()

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

Returns
TypeDescription
UnaryCallSettings<DropDatabaseRequest,Empty>

getBackupScheduleSettings()

publicUnaryCallSettings<GetBackupScheduleRequest,BackupSchedule>getBackupScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetBackupScheduleRequest,BackupSchedule>

getBackupSettings()

publicUnaryCallSettings<GetBackupRequest,Backup>getBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetBackupRequest,Backup>

getDatabaseDdlSettings()

publicUnaryCallSettings<GetDatabaseDdlRequest,GetDatabaseDdlResponse>getDatabaseDdlSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDatabaseDdlRequest,GetDatabaseDdlResponse>

getDatabaseSettings()

publicUnaryCallSettings<GetDatabaseRequest,Database>getDatabaseSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDatabaseRequest,Database>

getIamPolicySettings()

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

publicPagedCallSettings<ListBackupOperationsRequest,ListBackupOperationsResponse,DatabaseAdminClient.ListBackupOperationsPagedResponse>listBackupOperationsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListBackupOperationsRequest,ListBackupOperationsResponse,ListBackupOperationsPagedResponse>

listBackupSchedulesSettings()

publicPagedCallSettings<ListBackupSchedulesRequest,ListBackupSchedulesResponse,DatabaseAdminClient.ListBackupSchedulesPagedResponse>listBackupSchedulesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListBackupSchedulesRequest,ListBackupSchedulesResponse,ListBackupSchedulesPagedResponse>

listBackupsSettings()

publicPagedCallSettings<ListBackupsRequest,ListBackupsResponse,DatabaseAdminClient.ListBackupsPagedResponse>listBackupsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListBackupsRequest,ListBackupsResponse,ListBackupsPagedResponse>

listDatabaseOperationsSettings()

publicPagedCallSettings<ListDatabaseOperationsRequest,ListDatabaseOperationsResponse,DatabaseAdminClient.ListDatabaseOperationsPagedResponse>listDatabaseOperationsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListDatabaseOperationsRequest,ListDatabaseOperationsResponse,ListDatabaseOperationsPagedResponse>

listDatabaseRolesSettings()

publicPagedCallSettings<ListDatabaseRolesRequest,ListDatabaseRolesResponse,DatabaseAdminClient.ListDatabaseRolesPagedResponse>listDatabaseRolesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListDatabaseRolesRequest,ListDatabaseRolesResponse,ListDatabaseRolesPagedResponse>

listDatabasesSettings()

publicPagedCallSettings<ListDatabasesRequest,ListDatabasesResponse,DatabaseAdminClient.ListDatabasesPagedResponse>listDatabasesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse,ListDatabasesPagedResponse>

restoreDatabaseOperationSettings()

publicOperationCallSettings<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata>restoreDatabaseOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata>

restoreDatabaseSettings()

publicUnaryCallSettings<RestoreDatabaseRequest,Operation>restoreDatabaseSettings()

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

Returns
TypeDescription
UnaryCallSettings<RestoreDatabaseRequest,Operation>

setIamPolicySettings()

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

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

publicDatabaseAdminSettings.BuildertoBuilder()

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

Returns
TypeDescription
DatabaseAdminSettings.Builder
Overrides

updateBackupScheduleSettings()

publicUnaryCallSettings<UpdateBackupScheduleRequest,BackupSchedule>updateBackupScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateBackupScheduleRequest,BackupSchedule>

updateBackupSettings()

publicUnaryCallSettings<UpdateBackupRequest,Backup>updateBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateBackupRequest,Backup>

updateDatabaseDdlOperationSettings()

publicOperationCallSettings<UpdateDatabaseDdlRequest,Empty,UpdateDatabaseDdlMetadata>updateDatabaseDdlOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateDatabaseDdlRequest,Empty,UpdateDatabaseDdlMetadata>

updateDatabaseDdlSettings()

publicUnaryCallSettings<UpdateDatabaseDdlRequest,Operation>updateDatabaseDdlSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateDatabaseDdlRequest,Operation>

updateDatabaseOperationSettings()

publicOperationCallSettings<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata>updateDatabaseOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata>

updateDatabaseSettings()

publicUnaryCallSettings<UpdateDatabaseRequest,Operation>updateDatabaseSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateDatabaseRequest,Operation>