Class FirestoreSettings

public class FirestoreSettings extends 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 total timeout of getDocument to 30 seconds:


 FirestoreSettings.Builder firestoreSettingsBuilder = FirestoreSettings.newBuilder();
 firestoreSettingsBuilder
     .getDocumentSettings()
     .setRetrySettings(
         firestoreSettingsBuilder
             .getDocumentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 FirestoreSettings firestoreSettings = firestoreSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > FirestoreSettings

Constructors

FirestoreSettings(FirestoreSettings.Builder settingsBuilder)

protected FirestoreSettings(FirestoreSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderFirestoreSettings.Builder

Methods

batchGetDocumentsSettings()

public ServerStreamingCallSettings<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsSettings()

Returns the object with the settings used for calls to batchGetDocuments.

Returns
TypeDescription
ServerStreamingCallSettings<BatchGetDocumentsRequest,BatchGetDocumentsResponse>

batchWriteSettings()

public UnaryCallSettings<BatchWriteRequest,BatchWriteResponse> batchWriteSettings()

Returns the object with the settings used for calls to batchWrite.

Returns
TypeDescription
UnaryCallSettings<BatchWriteRequest,BatchWriteResponse>

beginTransactionSettings()

public UnaryCallSettings<BeginTransactionRequest,BeginTransactionResponse> beginTransactionSettings()

Returns the object with the settings used for calls to beginTransaction.

Returns
TypeDescription
UnaryCallSettings<BeginTransactionRequest,BeginTransactionResponse>

commitSettings()

public UnaryCallSettings<CommitRequest,CommitResponse> commitSettings()

Returns the object with the settings used for calls to commit.

Returns
TypeDescription
UnaryCallSettings<CommitRequest,CommitResponse>

create(FirestoreStubSettings stub)

public static final FirestoreSettings create(FirestoreStubSettings stub)
Parameter
NameDescription
stubFirestoreStubSettings
Returns
TypeDescription
FirestoreSettings
Exceptions
TypeDescription
IOException

createDocumentSettings()

public UnaryCallSettings<CreateDocumentRequest,Document> createDocumentSettings()

Returns the object with the settings used for calls to createDocument.

Returns
TypeDescription
UnaryCallSettings<CreateDocumentRequest,Document>

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

deleteDocumentSettings()

public UnaryCallSettings<DeleteDocumentRequest,Empty> deleteDocumentSettings()

Returns the object with the settings used for calls to deleteDocument.

Returns
TypeDescription
UnaryCallSettings<DeleteDocumentRequest,Empty>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

getDocumentSettings()

public UnaryCallSettings<GetDocumentRequest,Document> getDocumentSettings()

Returns the object with the settings used for calls to getDocument.

Returns
TypeDescription
UnaryCallSettings<GetDocumentRequest,Document>

listCollectionIdsSettings()

public PagedCallSettings<ListCollectionIdsRequest,ListCollectionIdsResponse,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsSettings()

Returns the object with the settings used for calls to listCollectionIds.

Returns
TypeDescription
PagedCallSettings<ListCollectionIdsRequest,ListCollectionIdsResponse,ListCollectionIdsPagedResponse>

listDocumentsSettings()

public PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,FirestoreClient.ListDocumentsPagedResponse> listDocumentsSettings()

Returns the object with the settings used for calls to listDocuments.

Returns
TypeDescription
PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,ListDocumentsPagedResponse>

listenSettings()

public StreamingCallSettings<ListenRequest,ListenResponse> listenSettings()

Returns the object with the settings used for calls to listen.

Returns
TypeDescription
StreamingCallSettings<ListenRequest,ListenResponse>

newBuilder()

public static FirestoreSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
FirestoreSettings.Builder

newBuilder(ClientContext clientContext)

public static FirestoreSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
FirestoreSettings.Builder

partitionQuerySettings()

public PagedCallSettings<PartitionQueryRequest,PartitionQueryResponse,FirestoreClient.PartitionQueryPagedResponse> partitionQuerySettings()

Returns the object with the settings used for calls to partitionQuery.

Returns
TypeDescription
PagedCallSettings<PartitionQueryRequest,PartitionQueryResponse,PartitionQueryPagedResponse>

rollbackSettings()

public UnaryCallSettings<RollbackRequest,Empty> rollbackSettings()

Returns the object with the settings used for calls to rollback.

Returns
TypeDescription
UnaryCallSettings<RollbackRequest,Empty>

runQuerySettings()

public ServerStreamingCallSettings<RunQueryRequest,RunQueryResponse> runQuerySettings()

Returns the object with the settings used for calls to runQuery.

Returns
TypeDescription
ServerStreamingCallSettings<RunQueryRequest,RunQueryResponse>

toBuilder()

public FirestoreSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
TypeDescription
FirestoreSettings.Builder
Overrides

updateDocumentSettings()

public UnaryCallSettings<UpdateDocumentRequest,Document> updateDocumentSettings()

Returns the object with the settings used for calls to updateDocument.

Returns
TypeDescription
UnaryCallSettings<UpdateDocumentRequest,Document>

writeSettings()

public StreamingCallSettings<WriteRequest,WriteResponse> writeSettings()

Returns the object with the settings used for calls to write.

Returns
TypeDescription
StreamingCallSettings<WriteRequest,WriteResponse>