Class FirestoreStubSettings.Builder (3.28.0) 

public static class FirestoreStubSettings.Builder extends StubSettings.Builder<FirestoreStubSettings,FirestoreStubSettings.Builder>

Builder for FirestoreStubSettings.

Inheritance

java.lang.Object > StubSettings.Builder > FirestoreStubSettings.Builder

Constructors

Builder()

protected Builder()

Builder(ClientContext clientContext)

protected Builder(ClientContext clientContext)
Parameter
Name Description
clientContext ClientContext

Builder(FirestoreStubSettings settings)

protected Builder(FirestoreStubSettings settings)
Parameter
Name Description
settings FirestoreStubSettings

Methods

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

public FirestoreStubSettings.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
Name Description
settingsUpdater ApiFunction<Builder<?,?>,Void>
Returns
Type Description
FirestoreStubSettings.Builder

batchGetDocumentsSettings()

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

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

Returns
Type Description
Builder<BatchGetDocumentsRequest,BatchGetDocumentsResponse>

batchWriteSettings()

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

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

Returns
Type Description
Builder<BatchWriteRequest,BatchWriteResponse>

beginTransactionSettings()

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

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

Returns
Type Description
Builder<BeginTransactionRequest,BeginTransactionResponse>

build()

public FirestoreStubSettings build()
Returns
Type Description
FirestoreStubSettings
Overrides
Exceptions
Type Description
IOException

commitSettings()

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

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

Returns
Type Description
Builder<CommitRequest,CommitResponse>

createDocumentSettings()

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

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

Returns
Type Description
Builder<CreateDocumentRequest,Document>

deleteDocumentSettings()

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

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

Returns
Type Description
Builder<DeleteDocumentRequest,Empty>

getDocumentSettings()

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

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

Returns
Type Description
Builder<GetDocumentRequest,Document>

listCollectionIdsSettings()

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

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

Returns
Type Description
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
Type Description
Builder<ListDocumentsRequest,ListDocumentsResponse,ListDocumentsPagedResponse>

listenSettings()

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

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

Returns
Type Description
Builder<ListenRequest,ListenResponse>

partitionQuerySettings()

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

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

Returns
Type Description
Builder<PartitionQueryRequest,PartitionQueryResponse,PartitionQueryPagedResponse>

rollbackSettings()

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

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

Returns
Type Description
Builder<RollbackRequest,Empty>

runAggregationQuerySettings()

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

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

Returns
Type Description
Builder<RunAggregationQueryRequest,RunAggregationQueryResponse>

runQuerySettings()

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

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

Returns
Type Description
Builder<RunQueryRequest,RunQueryResponse>

unaryMethodSettingsBuilders()

public ImmutableList<UnaryCallSettings.Builder<?,?>> unaryMethodSettingsBuilders()
Returns
Type Description
com.google.common.collect.ImmutableList<Builder<?,?>>

updateDocumentSettings()

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

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

Returns
Type Description
Builder<UpdateDocumentRequest,Document>

writeSettings()

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

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

Returns
Type Description
Builder<WriteRequest,WriteResponse>