Package com.google.cloud.spanner.admin.database.v1

Class DatabaseAdminSettings

java.lang.Object
com.google.api.gax.rpc.ClientSettings<DatabaseAdminSettings>
com.google.cloud.spanner.admin.database.v1.DatabaseAdminSettings
@Generated("by gapic-generator-java") public class DatabaseAdminSettings extends com.google.api.gax.rpc.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 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()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DatabaseAdminSettings databaseAdminSettings = databaseAdminSettingsBuilder.build();

  • Constructor Details

  • Method Details

    • listDatabasesSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse,DatabaseAdminClient.ListDatabasesPagedResponse> listDatabasesSettings()
      Returns the object with the settings used for calls to listDatabases.

    • createDatabaseSettings

      public com.google.api.gax.rpc.UnaryCallSettings<CreateDatabaseRequest,com.google.longrunning.Operation> createDatabaseSettings()
      Returns the object with the settings used for calls to createDatabase.

    • createDatabaseOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<CreateDatabaseRequest,Database,CreateDatabaseMetadata> createDatabaseOperationSettings()
      Returns the object with the settings used for calls to createDatabase.

    • getDatabaseSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetDatabaseRequest,Database> getDatabaseSettings()
      Returns the object with the settings used for calls to getDatabase.

    • updateDatabaseSettings

      public com.google.api.gax.rpc.UnaryCallSettings<UpdateDatabaseRequest,com.google.longrunning.Operation> updateDatabaseSettings()
      Returns the object with the settings used for calls to updateDatabase.

    • updateDatabaseOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata> updateDatabaseOperationSettings()
      Returns the object with the settings used for calls to updateDatabase.

    • updateDatabaseDdlSettings

      public com.google.api.gax.rpc.UnaryCallSettings<UpdateDatabaseDdlRequest,com.google.longrunning.Operation> updateDatabaseDdlSettings()
      Returns the object with the settings used for calls to updateDatabaseDdl.

    • updateDatabaseDdlOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<UpdateDatabaseDdlRequest,com.google.protobuf.Empty,UpdateDatabaseDdlMetadata> updateDatabaseDdlOperationSettings()
      Returns the object with the settings used for calls to updateDatabaseDdl.

    • dropDatabaseSettings

      public com.google.api.gax.rpc.UnaryCallSettings<DropDatabaseRequest,com.google.protobuf.Empty> dropDatabaseSettings()
      Returns the object with the settings used for calls to dropDatabase.

    • getDatabaseDdlSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetDatabaseDdlRequest,GetDatabaseDdlResponse> getDatabaseDdlSettings()
      Returns the object with the settings used for calls to getDatabaseDdl.

    • setIamPolicySettings

      public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()
      Returns the object with the settings used for calls to setIamPolicy.

    • getIamPolicySettings

      public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()
      Returns the object with the settings used for calls to getIamPolicy.

    • testIamPermissionsSettings

      public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()
      Returns the object with the settings used for calls to testIamPermissions.

    • createBackupSettings

      public com.google.api.gax.rpc.UnaryCallSettings<CreateBackupRequest,com.google.longrunning.Operation> createBackupSettings()
      Returns the object with the settings used for calls to createBackup.

    • createBackupOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<CreateBackupRequest,Backup,CreateBackupMetadata> createBackupOperationSettings()
      Returns the object with the settings used for calls to createBackup.

    • copyBackupSettings

      public com.google.api.gax.rpc.UnaryCallSettings<CopyBackupRequest,com.google.longrunning.Operation> copyBackupSettings()
      Returns the object with the settings used for calls to copyBackup.

    • copyBackupOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<CopyBackupRequest,Backup,CopyBackupMetadata> copyBackupOperationSettings()
      Returns the object with the settings used for calls to copyBackup.

    • getBackupSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetBackupRequest,Backup> getBackupSettings()
      Returns the object with the settings used for calls to getBackup.

    • updateBackupSettings

      public com.google.api.gax.rpc.UnaryCallSettings<UpdateBackupRequest,Backup> updateBackupSettings()
      Returns the object with the settings used for calls to updateBackup.

    • deleteBackupSettings

      public com.google.api.gax.rpc.UnaryCallSettings<DeleteBackupRequest,com.google.protobuf.Empty> deleteBackupSettings()
      Returns the object with the settings used for calls to deleteBackup.

    • listBackupsSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListBackupsRequest,ListBackupsResponse,DatabaseAdminClient.ListBackupsPagedResponse> listBackupsSettings()
      Returns the object with the settings used for calls to listBackups.

    • restoreDatabaseSettings

      public com.google.api.gax.rpc.UnaryCallSettings<RestoreDatabaseRequest,com.google.longrunning.Operation> restoreDatabaseSettings()
      Returns the object with the settings used for calls to restoreDatabase.

    • restoreDatabaseOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata> restoreDatabaseOperationSettings()
      Returns the object with the settings used for calls to restoreDatabase.

    • listDatabaseOperationsSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListDatabaseOperationsRequest,ListDatabaseOperationsResponse,DatabaseAdminClient.ListDatabaseOperationsPagedResponse> listDatabaseOperationsSettings()
      Returns the object with the settings used for calls to listDatabaseOperations.

    • listBackupOperationsSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListBackupOperationsRequest,ListBackupOperationsResponse,DatabaseAdminClient.ListBackupOperationsPagedResponse> listBackupOperationsSettings()
      Returns the object with the settings used for calls to listBackupOperations.

    • listDatabaseRolesSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListDatabaseRolesRequest,ListDatabaseRolesResponse,DatabaseAdminClient.ListDatabaseRolesPagedResponse> listDatabaseRolesSettings()
      Returns the object with the settings used for calls to listDatabaseRoles.

    • create

      public static final DatabaseAdminSettings create(DatabaseAdminStubSettings stub) throws IOException
      Throws:
      IOException

    • defaultExecutorProviderBuilder

      public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
      Returns a builder for the default ExecutorProvider for this service.

    • getDefaultEndpoint

      public static String getDefaultEndpoint()
      Returns the default service endpoint.

    • getDefaultServiceScopes

      public static List<String> getDefaultServiceScopes()
      Returns the default service scopes.

    • defaultCredentialsProviderBuilder

      public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
      Returns a builder for the default credentials for this service.

    • defaultGrpcTransportProviderBuilder

      public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
      Returns a builder for the default gRPC ChannelProvider for this service.

    • defaultHttpJsonTransportProviderBuilder

      @BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
      Returns a builder for the default REST ChannelProvider for this service.

    • defaultTransportChannelProvider

      public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

    • defaultApiClientHeaderProviderBuilder

      @BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

    • newBuilder

      public static DatabaseAdminSettings.Builder newBuilder()
      Returns a new gRPC builder for this class.

    • newHttpJsonBuilder

      @BetaApi public static DatabaseAdminSettings.Builder newHttpJsonBuilder()
      Returns a new REST builder for this class.

    • newBuilder

      public static DatabaseAdminSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
      Returns a new builder for this class.

    • toBuilder

      public DatabaseAdminSettings.Builder toBuilder()
      Returns a builder containing all the values of this settings class.
      Specified by:
      toBuilder in class com.google.api.gax.rpc.ClientSettings<DatabaseAdminSettings>