Package com.google.cloud.firestore.v1

Class FirestoreSettings

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

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 getDocument: 


 // 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
 FirestoreSettings.Builder firestoreSettingsBuilder = FirestoreSettings.newBuilder();
 firestoreSettingsBuilder
     .getDocumentSettings()
     .setRetrySettings(
         firestoreSettingsBuilder
             .getDocumentSettings()
             .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());
 FirestoreSettings firestoreSettings = firestoreSettingsBuilder.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.

  • Constructor Details

  • Method Details

    • getDocumentSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetDocumentRequest,Document> getDocumentSettings()
      Returns the object with the settings used for calls to getDocument.

    • listDocumentsSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,FirestoreClient.ListDocumentsPagedResponse> listDocumentsSettings()
      Returns the object with the settings used for calls to listDocuments.

    • updateDocumentSettings

      public com.google.api.gax.rpc.UnaryCallSettings<UpdateDocumentRequest,Document> updateDocumentSettings()
      Returns the object with the settings used for calls to updateDocument.

    • deleteDocumentSettings

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

    • batchGetDocumentsSettings

      public com.google.api.gax.rpc.ServerStreamingCallSettings<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsSettings()
      Returns the object with the settings used for calls to batchGetDocuments.

    • beginTransactionSettings

      public com.google.api.gax.rpc.UnaryCallSettings<BeginTransactionRequest,BeginTransactionResponse> beginTransactionSettings()
      Returns the object with the settings used for calls to beginTransaction.

    • commitSettings

      public com.google.api.gax.rpc.UnaryCallSettings<CommitRequest,CommitResponse> commitSettings()
      Returns the object with the settings used for calls to commit.

    • rollbackSettings

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

    • runQuerySettings

      public com.google.api.gax.rpc.ServerStreamingCallSettings<RunQueryRequest,RunQueryResponse> runQuerySettings()
      Returns the object with the settings used for calls to runQuery.

    • runAggregationQuerySettings

      public com.google.api.gax.rpc.ServerStreamingCallSettings<RunAggregationQueryRequest,RunAggregationQueryResponse> runAggregationQuerySettings()
      Returns the object with the settings used for calls to runAggregationQuery.

    • partitionQuerySettings

      public com.google.api.gax.rpc.PagedCallSettings<PartitionQueryRequest,PartitionQueryResponse,FirestoreClient.PartitionQueryPagedResponse> partitionQuerySettings()
      Returns the object with the settings used for calls to partitionQuery.

    • writeSettings

      public com.google.api.gax.rpc.StreamingCallSettings<WriteRequest,WriteResponse> writeSettings()
      Returns the object with the settings used for calls to write.

    • listenSettings

      public com.google.api.gax.rpc.StreamingCallSettings<ListenRequest,ListenResponse> listenSettings()
      Returns the object with the settings used for calls to listen.

    • listCollectionIdsSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListCollectionIdsRequest,ListCollectionIdsResponse,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsSettings()
      Returns the object with the settings used for calls to listCollectionIds.

    • batchWriteSettings

      public com.google.api.gax.rpc.UnaryCallSettings<BatchWriteRequest,BatchWriteResponse> batchWriteSettings()
      Returns the object with the settings used for calls to batchWrite.

    • createDocumentSettings

      public com.google.api.gax.rpc.UnaryCallSettings<CreateDocumentRequest,Document> createDocumentSettings()
      Returns the object with the settings used for calls to createDocument.

    • create

      public static final FirestoreSettings create(FirestoreStubSettings 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

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

    • newBuilder

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

    • newHttpJsonBuilder

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

    • newBuilder

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

    • toBuilder

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