Class FirestoreSettings (3.2.0)

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:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(FirestoreStubSettings stub)

public static final FirestoreSettings create(FirestoreStubSettings stub)

Parameter

Name	Description
stub	`FirestoreStubSettings`

Returns

Type	Description
FirestoreSettings

Exceptions

Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns

Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns

Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns

Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns

Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

newBuilder()

public static FirestoreSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
FirestoreSettings.Builder

newBuilder(ClientContext clientContext)

public static FirestoreSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
FirestoreSettings.Builder

Constructors

FirestoreSettings(FirestoreSettings.Builder settingsBuilder)

protected FirestoreSettings(FirestoreSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`FirestoreSettings.Builder`

Methods

batchGetDocumentsSettings()

public ServerStreamingCallSettings<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsSettings()

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

Returns

Type	Description
ServerStreamingCallSettings<BatchGetDocumentsRequest,BatchGetDocumentsResponse>

batchWriteSettings()

public UnaryCallSettings<BatchWriteRequest,BatchWriteResponse> batchWriteSettings()

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

Returns

Type	Description
UnaryCallSettings<BatchWriteRequest,BatchWriteResponse>

beginTransactionSettings()

public UnaryCallSettings<BeginTransactionRequest,BeginTransactionResponse> beginTransactionSettings()

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

Returns

Type	Description
UnaryCallSettings<BeginTransactionRequest,BeginTransactionResponse>

commitSettings()

public UnaryCallSettings<CommitRequest,CommitResponse> commitSettings()

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

Returns

Type	Description
UnaryCallSettings<CommitRequest,CommitResponse>

createDocumentSettings()

public UnaryCallSettings<CreateDocumentRequest,Document> createDocumentSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateDocumentRequest,Document>

deleteDocumentSettings()

public UnaryCallSettings<DeleteDocumentRequest,Empty> deleteDocumentSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteDocumentRequest,Empty>

getDocumentSettings()

public UnaryCallSettings<GetDocumentRequest,Document> getDocumentSettings()

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

Returns

Type	Description
UnaryCallSettings<GetDocumentRequest,Document>

listCollectionIdsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListCollectionIdsRequest,ListCollectionIdsResponse,ListCollectionIdsPagedResponse>

listDocumentsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,ListDocumentsPagedResponse>

listenSettings()

public StreamingCallSettings<ListenRequest,ListenResponse> listenSettings()

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

Returns

Type	Description
StreamingCallSettings<ListenRequest,ListenResponse>

partitionQuerySettings()

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

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

Returns

Type	Description
PagedCallSettings<PartitionQueryRequest,PartitionQueryResponse,PartitionQueryPagedResponse>

rollbackSettings()

public UnaryCallSettings<RollbackRequest,Empty> rollbackSettings()

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

Returns

Type	Description
UnaryCallSettings<RollbackRequest,Empty>

runQuerySettings()

public ServerStreamingCallSettings<RunQueryRequest,RunQueryResponse> runQuerySettings()

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

Returns

Type	Description
ServerStreamingCallSettings<RunQueryRequest,RunQueryResponse>

toBuilder()

public FirestoreSettings.Builder toBuilder()

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

Returns

Type	Description
FirestoreSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateDocumentSettings()

public UnaryCallSettings<UpdateDocumentRequest,Document> updateDocumentSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateDocumentRequest,Document>

writeSettings()

public StreamingCallSettings<WriteRequest,WriteResponse> writeSettings()

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

Returns

Type	Description
StreamingCallSettings<WriteRequest,WriteResponse>