Class GrpcFirestoreRpc (3.20.0)

public class GrpcFirestoreRpc implements FirestoreRpc

GRPC client implementation of the Firestore RPC methods. Exposes FirestoreOptions on top of the GRPC-based Firestore GAPIC client.

Inheritance

java.lang.Object > GrpcFirestoreRpc

Implements

FirestoreRpc

Constructors

GrpcFirestoreRpc(FirestoreOptions options)

public GrpcFirestoreRpc(FirestoreOptions options)
Parameter
NameDescription
optionsFirestoreOptions

Methods

batchGetDocumentsCallable()

public ServerStreamingCallable<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsCallable()

Gets multiple documents.

Returns
TypeDescription
ServerStreamingCallable<BatchGetDocumentsRequest,BatchGetDocumentsResponse>

batchWriteCallable()

public UnaryCallable<BatchWriteRequest,BatchWriteResponse> batchWriteCallable()
Returns
TypeDescription
UnaryCallable<BatchWriteRequest,BatchWriteResponse>

beginTransactionCallable()

public UnaryCallable<BeginTransactionRequest,BeginTransactionResponse> beginTransactionCallable()

Starts a new transaction.

Returns
TypeDescription
UnaryCallable<BeginTransactionRequest,BeginTransactionResponse>

close()

public void close()
Exceptions
TypeDescription
Exception

commitCallable()

public UnaryCallable<CommitRequest,CommitResponse> commitCallable()

Commits a transaction, while optionally updating documents.

Returns
TypeDescription
UnaryCallable<CommitRequest,CommitResponse>

getExecutor()

public ScheduledExecutorService getExecutor()

Returns the executor used by the GAPIC client.

Returns
TypeDescription
ScheduledExecutorService

listCollectionIdsPagedCallable()

public UnaryCallable<ListCollectionIdsRequest,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsPagedCallable()

Returns a list of collections IDs.

Returns
TypeDescription
UnaryCallable<ListCollectionIdsRequest,ListCollectionIdsPagedResponse>

listDocumentsPagedCallable()

public UnaryCallable<ListDocumentsRequest,FirestoreClient.ListDocumentsPagedResponse> listDocumentsPagedCallable()

Returns a list of documents.

Returns
TypeDescription
UnaryCallable<ListDocumentsRequest,ListDocumentsPagedResponse>

listenCallable()

public BidiStreamingCallable<ListenRequest,ListenResponse> listenCallable()

Returns a bi-directional watch stream.

Returns
TypeDescription
BidiStreamingCallable<ListenRequest,ListenResponse>

partitionQueryPagedCallable()

public UnaryCallable<PartitionQueryRequest,FirestoreClient.PartitionQueryPagedResponse> partitionQueryPagedCallable()
Returns
TypeDescription
UnaryCallable<PartitionQueryRequest,PartitionQueryPagedResponse>

rollbackCallable()

public UnaryCallable<RollbackRequest,Empty> rollbackCallable()

Rolls back a transaction.

Returns
TypeDescription
UnaryCallable<RollbackRequest,Empty>

runAggregationQueryCallable()

public ServerStreamingCallable<RunAggregationQueryRequest,RunAggregationQueryResponse> runAggregationQueryCallable()

Runs an aggregation query.

Returns
TypeDescription
ServerStreamingCallable<RunAggregationQueryRequest,RunAggregationQueryResponse>

runQueryCallable()

public ServerStreamingCallable<RunQueryRequest,RunQueryResponse> runQueryCallable()

Runs a query.

Returns
TypeDescription
ServerStreamingCallable<RunQueryRequest,RunQueryResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()