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

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

GrpcFirestoreRpc(FirestoreOptions options)

public GrpcFirestoreRpc(FirestoreOptions options)

Parameter
Name	Description
`options`	`FirestoreOptions`

Methods

batchGetDocumentsCallable()

public ServerStreamingCallable<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsCallable()

Gets multiple documents.

Returns
Type	Description
`ServerStreamingCallable<BatchGetDocumentsRequest,BatchGetDocumentsResponse>`

batchWriteCallable()

public UnaryCallable<BatchWriteRequest,BatchWriteResponse> batchWriteCallable()

Returns
Type	Description
`UnaryCallable<BatchWriteRequest,BatchWriteResponse>`

beginTransactionCallable()

public UnaryCallable<BeginTransactionRequest,BeginTransactionResponse> beginTransactionCallable()

Starts a new transaction.

Returns
Type	Description
`UnaryCallable<BeginTransactionRequest,BeginTransactionResponse>`

close()

public void close()

Exceptions
Type	Description
`Exception`

commitCallable()

public UnaryCallable<CommitRequest,CommitResponse> commitCallable()

Commits a transaction, while optionally updating documents.

Returns
Type	Description
`UnaryCallable<CommitRequest,CommitResponse>`

getExecutor()

public ScheduledExecutorService getExecutor()

Returns the executor used by the GAPIC client.

Returns
Type	Description
`ScheduledExecutorService`

listCollectionIdsPagedCallable()

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

Returns a list of collections IDs.

Returns
Type	Description
`UnaryCallable<ListCollectionIdsRequest,ListCollectionIdsPagedResponse>`

listDocumentsPagedCallable()

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

Returns a list of documents.

Returns
Type	Description
`UnaryCallable<ListDocumentsRequest,ListDocumentsPagedResponse>`

listenCallable()

public BidiStreamingCallable<ListenRequest,ListenResponse> listenCallable()

Returns a bi-directional watch stream.

Returns
Type	Description
`BidiStreamingCallable<ListenRequest,ListenResponse>`

partitionQueryPagedCallable()

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

Returns
Type	Description
`UnaryCallable<PartitionQueryRequest,PartitionQueryPagedResponse>`

rollbackCallable()

public UnaryCallable<RollbackRequest,Empty> rollbackCallable()

Rolls back a transaction.

Returns
Type	Description
`UnaryCallable<RollbackRequest,Empty>`

runAggregationQueryCallable()

public ServerStreamingCallable<RunAggregationQueryRequest,RunAggregationQueryResponse> runAggregationQueryCallable()

Runs an aggregation query.

Returns
Type	Description
`ServerStreamingCallable<RunAggregationQueryRequest,RunAggregationQueryResponse>`

runQueryCallable()

public ServerStreamingCallable<RunQueryRequest,RunQueryResponse> runQueryCallable()

Runs a query.

Returns
Type	Description
`ServerStreamingCallable<RunQueryRequest,RunQueryResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()