Package com.google.cloud.firestore.v1.stub

Class FirestoreAdminStubSettings

java.lang.Object
com.google.api.gax.rpc.StubSettings<FirestoreAdminStubSettings>
com.google.cloud.firestore.v1.stub.FirestoreAdminStubSettings
@Generated("by gapic-generator-java") public class FirestoreAdminStubSettings extends com.google.api.gax.rpc.StubSettings<FirestoreAdminStubSettings>
Settings class to configure an instance of FirestoreAdminStub.

The default instance has everything set to sensible defaults:

  • The default service address (firestore.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 getIndex: 


 // 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
 FirestoreAdminStubSettings.Builder firestoreAdminSettingsBuilder =
     FirestoreAdminStubSettings.newBuilder();
 firestoreAdminSettingsBuilder
     .getIndexSettings()
     .setRetrySettings(
         firestoreAdminSettingsBuilder
             .getIndexSettings()
             .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());
 FirestoreAdminStubSettings firestoreAdminSettings = firestoreAdminSettingsBuilder.build();
Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) 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 createIndex: 


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

  • Constructor Details

  • Method Details

    • createIndexSettings

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

    • createIndexOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<CreateIndexRequest,Index,IndexOperationMetadata> createIndexOperationSettings()
      Returns the object with the settings used for calls to createIndex.

    • listIndexesSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListIndexesRequest,ListIndexesResponse,FirestoreAdminClient.ListIndexesPagedResponse> listIndexesSettings()
      Returns the object with the settings used for calls to listIndexes.

    • getIndexSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetIndexRequest,Index> getIndexSettings()
      Returns the object with the settings used for calls to getIndex.

    • deleteIndexSettings

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

    • getFieldSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetFieldRequest,Field> getFieldSettings()
      Returns the object with the settings used for calls to getField.

    • updateFieldSettings

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

    • updateFieldOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<UpdateFieldRequest,Field,FieldOperationMetadata> updateFieldOperationSettings()
      Returns the object with the settings used for calls to updateField.

    • listFieldsSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListFieldsRequest,ListFieldsResponse,FirestoreAdminClient.ListFieldsPagedResponse> listFieldsSettings()
      Returns the object with the settings used for calls to listFields.

    • exportDocumentsSettings

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

    • exportDocumentsOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata> exportDocumentsOperationSettings()
      Returns the object with the settings used for calls to exportDocuments.

    • importDocumentsSettings

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

    • importDocumentsOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<ImportDocumentsRequest,com.google.protobuf.Empty,ImportDocumentsMetadata> importDocumentsOperationSettings()
      Returns the object with the settings used for calls to importDocuments.

    • bulkDeleteDocumentsSettings

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

    • bulkDeleteDocumentsOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<BulkDeleteDocumentsRequest,BulkDeleteDocumentsResponse,BulkDeleteDocumentsMetadata> bulkDeleteDocumentsOperationSettings()
      Returns the object with the settings used for calls to bulkDeleteDocuments.

    • 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.

    • listDatabasesSettings

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

    • 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.

    • deleteDatabaseSettings

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

    • deleteDatabaseOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<DeleteDatabaseRequest,Database,DeleteDatabaseMetadata> deleteDatabaseOperationSettings()
      Returns the object with the settings used for calls to deleteDatabase.

    • createUserCredsSettings

      public com.google.api.gax.rpc.UnaryCallSettings<CreateUserCredsRequest,UserCreds> createUserCredsSettings()
      Returns the object with the settings used for calls to createUserCreds.

    • getUserCredsSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetUserCredsRequest,UserCreds> getUserCredsSettings()
      Returns the object with the settings used for calls to getUserCreds.

    • listUserCredsSettings

      public com.google.api.gax.rpc.UnaryCallSettings<ListUserCredsRequest,ListUserCredsResponse> listUserCredsSettings()
      Returns the object with the settings used for calls to listUserCreds.

    • enableUserCredsSettings

      public com.google.api.gax.rpc.UnaryCallSettings<EnableUserCredsRequest,UserCreds> enableUserCredsSettings()
      Returns the object with the settings used for calls to enableUserCreds.

    • disableUserCredsSettings

      public com.google.api.gax.rpc.UnaryCallSettings<DisableUserCredsRequest,UserCreds> disableUserCredsSettings()
      Returns the object with the settings used for calls to disableUserCreds.

    • resetUserPasswordSettings

      public com.google.api.gax.rpc.UnaryCallSettings<ResetUserPasswordRequest,UserCreds> resetUserPasswordSettings()
      Returns the object with the settings used for calls to resetUserPassword.

    • deleteUserCredsSettings

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

    • getBackupSettings

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

    • listBackupsSettings

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

    • 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.

    • 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.

    • createBackupScheduleSettings

      public com.google.api.gax.rpc.UnaryCallSettings<CreateBackupScheduleRequest,BackupSchedule> createBackupScheduleSettings()
      Returns the object with the settings used for calls to createBackupSchedule.

    • getBackupScheduleSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetBackupScheduleRequest,BackupSchedule> getBackupScheduleSettings()
      Returns the object with the settings used for calls to getBackupSchedule.

    • listBackupSchedulesSettings

      public com.google.api.gax.rpc.UnaryCallSettings<ListBackupSchedulesRequest,ListBackupSchedulesResponse> listBackupSchedulesSettings()
      Returns the object with the settings used for calls to listBackupSchedules.

    • updateBackupScheduleSettings

      public com.google.api.gax.rpc.UnaryCallSettings<UpdateBackupScheduleRequest,BackupSchedule> updateBackupScheduleSettings()
      Returns the object with the settings used for calls to updateBackupSchedule.

    • deleteBackupScheduleSettings

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

    • cloneDatabaseSettings

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

    • cloneDatabaseOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<CloneDatabaseRequest,Database,CloneDatabaseMetadata> cloneDatabaseOperationSettings()
      Returns the object with the settings used for calls to cloneDatabase.

    • createStub

      public FirestoreAdminStub createStub() throws IOException
      Throws:
      IOException

    • getServiceName

      public String getServiceName()
      Returns the default service name.
      Overrides:
      getServiceName in class com.google.api.gax.rpc.StubSettings<FirestoreAdminStubSettings>

    • defaultExecutorProviderBuilder

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

    • getDefaultEndpoint

      @ObsoleteApi("Use getEndpoint() instead") public static String getDefaultEndpoint()
      Returns the default service endpoint.

    • getDefaultMtlsEndpoint

      public static String getDefaultMtlsEndpoint()
      Returns the default mTLS 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()

    • defaultGrpcApiClientHeaderProviderBuilder

      public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

    • defaultHttpJsonApiClientHeaderProviderBuilder

      public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

    • defaultApiClientHeaderProviderBuilder

      public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

    • newBuilder

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

    • newHttpJsonBuilder

      public static FirestoreAdminStubSettings.Builder newHttpJsonBuilder()
      Returns a new REST builder for this class.

    • newBuilder

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

    • toBuilder

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