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();
Static Methods
create(DatabaseAdminStubSettings stub)
public static final DatabaseAdminSettings create(DatabaseAdminStubSettings stub)| Name | Description |
| stub | DatabaseAdminStubSettings |
| Type | Description |
| DatabaseAdminSettings |
| Type | Description |
| IOException |
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Type | Description |
| Builder |
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Type | Description |
| Builder |
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Type | Description |
| Builder |
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.
| Type | Description |
| Builder |
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Type | Description |
| TransportChannelProvider |
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Type | Description |
| String |
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Type | Description |
| List<String> |
newBuilder()
public static DatabaseAdminSettings.Builder newBuilder()Returns a new builder for this class.
| Type | Description |
| DatabaseAdminSettings.Builder |
newBuilder(ClientContext clientContext)
public static DatabaseAdminSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Name | Description |
| clientContext | ClientContext |
| Type | Description |
| DatabaseAdminSettings.Builder |
Constructors
DatabaseAdminSettings(DatabaseAdminSettings.Builder settingsBuilder)
protected DatabaseAdminSettings(DatabaseAdminSettings.Builder settingsBuilder)| Name | Description |
| settingsBuilder | DatabaseAdminSettings.Builder |
Methods
copyBackupOperationSettings()
public OperationCallSettings<CopyBackupRequest,Backup,CopyBackupMetadata> copyBackupOperationSettings()Returns the object with the settings used for calls to copyBackup.
| Type | Description |
| OperationCallSettings<CopyBackupRequest,Backup,CopyBackupMetadata> |
copyBackupSettings()
public UnaryCallSettings<CopyBackupRequest,Operation> copyBackupSettings()Returns the object with the settings used for calls to copyBackup.
| Type | Description |
| UnaryCallSettings<CopyBackupRequest,Operation> |
createBackupOperationSettings()
public OperationCallSettings<CreateBackupRequest,Backup,CreateBackupMetadata> createBackupOperationSettings()Returns the object with the settings used for calls to createBackup.
| Type | Description |
| OperationCallSettings<CreateBackupRequest,Backup,CreateBackupMetadata> |
createBackupSettings()
public UnaryCallSettings<CreateBackupRequest,Operation> createBackupSettings()Returns the object with the settings used for calls to createBackup.
| Type | Description |
| UnaryCallSettings<CreateBackupRequest,Operation> |
createDatabaseOperationSettings()
public OperationCallSettings<CreateDatabaseRequest,Database,CreateDatabaseMetadata> createDatabaseOperationSettings()Returns the object with the settings used for calls to createDatabase.
| Type | Description |
| OperationCallSettings<CreateDatabaseRequest,Database,CreateDatabaseMetadata> |
createDatabaseSettings()
public UnaryCallSettings<CreateDatabaseRequest,Operation> createDatabaseSettings()Returns the object with the settings used for calls to createDatabase.
| Type | Description |
| UnaryCallSettings<CreateDatabaseRequest,Operation> |
deleteBackupSettings()
public UnaryCallSettings<DeleteBackupRequest,Empty> deleteBackupSettings()Returns the object with the settings used for calls to deleteBackup.
| Type | Description |
| UnaryCallSettings<DeleteBackupRequest,Empty> |
dropDatabaseSettings()
public UnaryCallSettings<DropDatabaseRequest,Empty> dropDatabaseSettings()Returns the object with the settings used for calls to dropDatabase.
| Type | Description |
| UnaryCallSettings<DropDatabaseRequest,Empty> |
getBackupSettings()
public UnaryCallSettings<GetBackupRequest,Backup> getBackupSettings()Returns the object with the settings used for calls to getBackup.
| Type | Description |
| UnaryCallSettings<GetBackupRequest,Backup> |
getDatabaseDdlSettings()
public UnaryCallSettings<GetDatabaseDdlRequest,GetDatabaseDdlResponse> getDatabaseDdlSettings()Returns the object with the settings used for calls to getDatabaseDdl.
| Type | Description |
| UnaryCallSettings<GetDatabaseDdlRequest,GetDatabaseDdlResponse> |
getDatabaseSettings()
public UnaryCallSettings<GetDatabaseRequest,Database> getDatabaseSettings()Returns the object with the settings used for calls to getDatabase.
| Type | Description |
| UnaryCallSettings<GetDatabaseRequest,Database> |
getIamPolicySettings()
public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()Returns the object with the settings used for calls to getIamPolicy.
| 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.
| Type | Description |
| PagedCallSettings<ListBackupOperationsRequest,ListBackupOperationsResponse,ListBackupOperationsPagedResponse> |
listBackupsSettings()
public PagedCallSettings<ListBackupsRequest,ListBackupsResponse,DatabaseAdminClient.ListBackupsPagedResponse> listBackupsSettings()Returns the object with the settings used for calls to listBackups.
| 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.
| Type | Description |
| PagedCallSettings<ListDatabaseOperationsRequest,ListDatabaseOperationsResponse,ListDatabaseOperationsPagedResponse> |
listDatabasesSettings()
public PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse,DatabaseAdminClient.ListDatabasesPagedResponse> listDatabasesSettings()Returns the object with the settings used for calls to listDatabases.
| Type | Description |
| PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse,ListDatabasesPagedResponse> |
restoreDatabaseOperationSettings()
public OperationCallSettings<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata> restoreDatabaseOperationSettings()Returns the object with the settings used for calls to restoreDatabase.
| Type | Description |
| OperationCallSettings<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata> |
restoreDatabaseSettings()
public UnaryCallSettings<RestoreDatabaseRequest,Operation> restoreDatabaseSettings()Returns the object with the settings used for calls to restoreDatabase.
| Type | Description |
| UnaryCallSettings<RestoreDatabaseRequest,Operation> |
setIamPolicySettings()
public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()Returns the object with the settings used for calls to setIamPolicy.
| 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.
| 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.
| Type | Description |
| DatabaseAdminSettings.Builder |
updateBackupSettings()
public UnaryCallSettings<UpdateBackupRequest,Backup> updateBackupSettings()Returns the object with the settings used for calls to updateBackup.
| Type | Description |
| UnaryCallSettings<UpdateBackupRequest,Backup> |
updateDatabaseDdlOperationSettings()
public OperationCallSettings<UpdateDatabaseDdlRequest,Empty,UpdateDatabaseDdlMetadata> updateDatabaseDdlOperationSettings()Returns the object with the settings used for calls to updateDatabaseDdl.
| Type | Description |
| OperationCallSettings<UpdateDatabaseDdlRequest,Empty,UpdateDatabaseDdlMetadata> |
updateDatabaseDdlSettings()
public UnaryCallSettings<UpdateDatabaseDdlRequest,Operation> updateDatabaseDdlSettings()Returns the object with the settings used for calls to updateDatabaseDdl.
| Type | Description |
| UnaryCallSettings<UpdateDatabaseDdlRequest,Operation> |