Class FirestoreSettings.Builder (3.8.2)

public static class FirestoreSettings.Builder extends ClientSettings.Builder<FirestoreSettings,FirestoreSettings.Builder>

Builder for FirestoreSettings.

Inheritance

java.lang.Object > ClientSettings.Builder > FirestoreSettings.Builder

Constructors

Builder()

protected Builder()

Builder(ClientContext clientContext)

protected Builder(ClientContext clientContext)
Parameter
NameDescription
clientContextClientContext

Builder(FirestoreSettings settings)

protected Builder(FirestoreSettings settings)
Parameter
NameDescription
settingsFirestoreSettings

Builder(FirestoreStubSettings.Builder stubSettings)

protected Builder(FirestoreStubSettings.Builder stubSettings)
Parameter
NameDescription
stubSettingsFirestoreStubSettings.Builder

Methods

applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)

public FirestoreSettings.Builder applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)

Applies the given settings updater function to all of the unary API methods in this service.

Note: This method does not support applying settings to streaming methods.

Parameter
NameDescription
settingsUpdaterApiFunction<Builder<?,?>,Void>
Returns
TypeDescription
FirestoreSettings.Builder

batchGetDocumentsSettings()

public ServerStreamingCallSettings.Builder<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsSettings()

Returns the builder for the settings used for calls to batchGetDocuments.

Returns
TypeDescription
Builder<BatchGetDocumentsRequest,BatchGetDocumentsResponse>

batchWriteSettings()

public UnaryCallSettings.Builder<BatchWriteRequest,BatchWriteResponse> batchWriteSettings()

Returns the builder for the settings used for calls to batchWrite.

Returns
TypeDescription
Builder<BatchWriteRequest,BatchWriteResponse>

beginTransactionSettings()

public UnaryCallSettings.Builder<BeginTransactionRequest,BeginTransactionResponse> beginTransactionSettings()

Returns the builder for the settings used for calls to beginTransaction.

Returns
TypeDescription
Builder<BeginTransactionRequest,BeginTransactionResponse>

build()

public FirestoreSettings build()
Returns
TypeDescription
FirestoreSettings
Overrides Exceptions
TypeDescription
IOException

commitSettings()

public UnaryCallSettings.Builder<CommitRequest,CommitResponse> commitSettings()

Returns the builder for the settings used for calls to commit.

Returns
TypeDescription
Builder<CommitRequest,CommitResponse>

createDocumentSettings()

public UnaryCallSettings.Builder<CreateDocumentRequest,Document> createDocumentSettings()

Returns the builder for the settings used for calls to createDocument.

Returns
TypeDescription
Builder<CreateDocumentRequest,Document>

deleteDocumentSettings()

public UnaryCallSettings.Builder<DeleteDocumentRequest,Empty> deleteDocumentSettings()

Returns the builder for the settings used for calls to deleteDocument.

Returns
TypeDescription
Builder<DeleteDocumentRequest,Empty>

getDocumentSettings()

public UnaryCallSettings.Builder<GetDocumentRequest,Document> getDocumentSettings()

Returns the builder for the settings used for calls to getDocument.

Returns
TypeDescription
Builder<GetDocumentRequest,Document>

getStubSettingsBuilder()

public FirestoreStubSettings.Builder getStubSettingsBuilder()
Returns
TypeDescription
FirestoreStubSettings.Builder

listCollectionIdsSettings()

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

Returns the builder for the settings used for calls to listCollectionIds.

Returns
TypeDescription
Builder<ListCollectionIdsRequest,ListCollectionIdsResponse,ListCollectionIdsPagedResponse>

listDocumentsSettings()

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

Returns the builder for the settings used for calls to listDocuments.

Returns
TypeDescription
Builder<ListDocumentsRequest,ListDocumentsResponse,ListDocumentsPagedResponse>

listenSettings()

public StreamingCallSettings.Builder<ListenRequest,ListenResponse> listenSettings()

Returns the builder for the settings used for calls to listen.

Returns
TypeDescription
Builder<ListenRequest,ListenResponse>

partitionQuerySettings()

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

Returns the builder for the settings used for calls to partitionQuery.

Returns
TypeDescription
Builder<PartitionQueryRequest,PartitionQueryResponse,PartitionQueryPagedResponse>

rollbackSettings()

public UnaryCallSettings.Builder<RollbackRequest,Empty> rollbackSettings()

Returns the builder for the settings used for calls to rollback.

Returns
TypeDescription
Builder<RollbackRequest,Empty>

runAggregationQuerySettings()

public ServerStreamingCallSettings.Builder<RunAggregationQueryRequest,RunAggregationQueryResponse> runAggregationQuerySettings()

Returns the builder for the settings used for calls to runAggregationQuery.

Returns
TypeDescription
Builder<RunAggregationQueryRequest,RunAggregationQueryResponse>

runQuerySettings()

public ServerStreamingCallSettings.Builder<RunQueryRequest,RunQueryResponse> runQuerySettings()

Returns the builder for the settings used for calls to runQuery.

Returns
TypeDescription
Builder<RunQueryRequest,RunQueryResponse>

updateDocumentSettings()

public UnaryCallSettings.Builder<UpdateDocumentRequest,Document> updateDocumentSettings()

Returns the builder for the settings used for calls to updateDocument.

Returns
TypeDescription
Builder<UpdateDocumentRequest,Document>

writeSettings()

public StreamingCallSettings.Builder<WriteRequest,WriteResponse> writeSettings()

Returns the builder for the settings used for calls to write.

Returns
TypeDescription
Builder<WriteRequest,WriteResponse>