Class DatabaseAdminStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<DatabaseAdminStubSettings>
com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings
@Generated("by gapic-generator-java")
public class DatabaseAdminStubSettings
extends StubSettings<DatabaseAdminStubSettings>
Settings class to configure an instance of
DatabaseAdminStub.
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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
DatabaseAdminStubSettings.Builder databaseAdminSettingsBuilder =
DatabaseAdminStubSettings.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());
DatabaseAdminStubSettings databaseAdminSettings = databaseAdminSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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
DatabaseAdminStubSettings.Builder databaseAdminSettingsBuilder =
DatabaseAdminStubSettings.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();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for DatabaseAdminStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDatabaseAdminStubSettings(DatabaseAdminStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to addSplitPoints.Returns the object with the settings used for calls to copyBackup.Returns the object with the settings used for calls to copyBackup.Returns the object with the settings used for calls to createBackup.Returns the object with the settings used for calls to createBackupSchedule.Returns the object with the settings used for calls to createBackup.Returns the object with the settings used for calls to createDatabase.Returns the object with the settings used for calls to createDatabase.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderUnaryCallSettings<DeleteBackupScheduleRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteBackupSchedule.UnaryCallSettings<DeleteBackupRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteBackup.UnaryCallSettings<DropDatabaseRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to dropDatabase.Returns the object with the settings used for calls to getBackupSchedule.Returns the object with the settings used for calls to getBackup.Returns the object with the settings used for calls to getDatabaseDdl.Returns the object with the settings used for calls to getDatabase.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.protected LibraryMetadataReturns the default service name.Returns the object with the settings used for calls to internalUpdateGraph.PagedCallSettings<ListBackupOperationsRequest,ListBackupOperationsResponse, DatabaseAdminClient.ListBackupOperationsPagedResponse> Returns the object with the settings used for calls to listBackupOperations.PagedCallSettings<ListBackupSchedulesRequest,ListBackupSchedulesResponse, DatabaseAdminClient.ListBackupSchedulesPagedResponse> Returns the object with the settings used for calls to listBackupSchedules.PagedCallSettings<ListBackupsRequest,ListBackupsResponse, DatabaseAdminClient.ListBackupsPagedResponse> Returns the object with the settings used for calls to listBackups.PagedCallSettings<ListDatabaseOperationsRequest,ListDatabaseOperationsResponse, DatabaseAdminClient.ListDatabaseOperationsPagedResponse> Returns the object with the settings used for calls to listDatabaseOperations.PagedCallSettings<ListDatabaseRolesRequest,ListDatabaseRolesResponse, DatabaseAdminClient.ListDatabaseRolesPagedResponse> Returns the object with the settings used for calls to listDatabaseRoles.PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse, DatabaseAdminClient.ListDatabasesPagedResponse> Returns the object with the settings used for calls to listDatabases.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns the object with the settings used for calls to restoreDatabase.Returns the object with the settings used for calls to restoreDatabase.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateBackupSchedule.Returns the object with the settings used for calls to updateBackup.OperationCallSettings<UpdateDatabaseDdlRequest,com.google.protobuf.Empty, UpdateDatabaseDdlMetadata> Returns the object with the settings used for calls to updateDatabaseDdl.Returns the object with the settings used for calls to updateDatabaseDdl.Returns the object with the settings used for calls to updateDatabase.Returns the object with the settings used for calls to updateDatabase.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
DatabaseAdminStubSettings
protected DatabaseAdminStubSettings(DatabaseAdminStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listDatabasesSettings
public PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse, listDatabasesSettings()DatabaseAdminClient.ListDatabasesPagedResponse> Returns the object with the settings used for calls to listDatabases. -
createDatabaseSettings
Returns the object with the settings used for calls to createDatabase. -
createDatabaseOperationSettings
public OperationCallSettings<CreateDatabaseRequest,Database, createDatabaseOperationSettings()CreateDatabaseMetadata> Returns the object with the settings used for calls to createDatabase. -
getDatabaseSettings
Returns the object with the settings used for calls to getDatabase. -
updateDatabaseSettings
Returns the object with the settings used for calls to updateDatabase. -
updateDatabaseOperationSettings
public OperationCallSettings<UpdateDatabaseRequest,Database, updateDatabaseOperationSettings()UpdateDatabaseMetadata> Returns the object with the settings used for calls to updateDatabase. -
updateDatabaseDdlSettings
Returns the object with the settings used for calls to updateDatabaseDdl. -
updateDatabaseDdlOperationSettings
public OperationCallSettings<UpdateDatabaseDdlRequest,com.google.protobuf.Empty, updateDatabaseDdlOperationSettings()UpdateDatabaseDdlMetadata> Returns the object with the settings used for calls to updateDatabaseDdl. -
dropDatabaseSettings
Returns the object with the settings used for calls to dropDatabase. -
getDatabaseDdlSettings
Returns the object with the settings used for calls to getDatabaseDdl. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
createBackupSettings
Returns the object with the settings used for calls to createBackup. -
createBackupOperationSettings
public OperationCallSettings<CreateBackupRequest,Backup, createBackupOperationSettings()CreateBackupMetadata> Returns the object with the settings used for calls to createBackup. -
copyBackupSettings
Returns the object with the settings used for calls to copyBackup. -
copyBackupOperationSettings
public OperationCallSettings<CopyBackupRequest,Backup, copyBackupOperationSettings()CopyBackupMetadata> Returns the object with the settings used for calls to copyBackup. -
getBackupSettings
Returns the object with the settings used for calls to getBackup. -
updateBackupSettings
Returns the object with the settings used for calls to updateBackup. -
deleteBackupSettings
Returns the object with the settings used for calls to deleteBackup. -
listBackupsSettings
public PagedCallSettings<ListBackupsRequest,ListBackupsResponse, listBackupsSettings()DatabaseAdminClient.ListBackupsPagedResponse> Returns the object with the settings used for calls to listBackups. -
restoreDatabaseSettings
Returns the object with the settings used for calls to restoreDatabase. -
restoreDatabaseOperationSettings
public OperationCallSettings<RestoreDatabaseRequest,Database, restoreDatabaseOperationSettings()RestoreDatabaseMetadata> Returns the object with the settings used for calls to restoreDatabase. -
listDatabaseOperationsSettings
public PagedCallSettings<ListDatabaseOperationsRequest,ListDatabaseOperationsResponse, listDatabaseOperationsSettings()DatabaseAdminClient.ListDatabaseOperationsPagedResponse> Returns the object with the settings used for calls to listDatabaseOperations. -
listBackupOperationsSettings
public PagedCallSettings<ListBackupOperationsRequest,ListBackupOperationsResponse, listBackupOperationsSettings()DatabaseAdminClient.ListBackupOperationsPagedResponse> Returns the object with the settings used for calls to listBackupOperations. -
listDatabaseRolesSettings
public PagedCallSettings<ListDatabaseRolesRequest,ListDatabaseRolesResponse, listDatabaseRolesSettings()DatabaseAdminClient.ListDatabaseRolesPagedResponse> Returns the object with the settings used for calls to listDatabaseRoles. -
addSplitPointsSettings
Returns the object with the settings used for calls to addSplitPoints. -
createBackupScheduleSettings
Returns the object with the settings used for calls to createBackupSchedule. -
getBackupScheduleSettings
Returns the object with the settings used for calls to getBackupSchedule. -
updateBackupScheduleSettings
Returns the object with the settings used for calls to updateBackupSchedule. -
deleteBackupScheduleSettings
public UnaryCallSettings<DeleteBackupScheduleRequest,com.google.protobuf.Empty> deleteBackupScheduleSettings()Returns the object with the settings used for calls to deleteBackupSchedule. -
listBackupSchedulesSettings
public PagedCallSettings<ListBackupSchedulesRequest,ListBackupSchedulesResponse, listBackupSchedulesSettings()DatabaseAdminClient.ListBackupSchedulesPagedResponse> Returns the object with the settings used for calls to listBackupSchedules. -
internalUpdateGraphOperationSettings
public UnaryCallSettings<InternalUpdateGraphOperationRequest,InternalUpdateGraphOperationResponse> internalUpdateGraphOperationSettings()Returns the object with the settings used for calls to internalUpdateGraph. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<DatabaseAdminStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
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
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<DatabaseAdminStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<DatabaseAdminStubSettings>
-