Package com.google.cloud.firestore.spi.v1

Interface FirestoreRpc

All Superinterfaces:

AutoCloseable, com.google.cloud.ServiceRpc

All Known Implementing Classes:

GrpcFirestoreRpc

public interface FirestoreRpc
extends AutoCloseable, com.google.cloud.ServiceRpc

Contains the RPC stubs used by the manual Cloud Firestore client.

Method Summary

Modifier and Type	Method	Description
com.google.api.gax.rpc.ServerStreamingCallable<BatchGetDocumentsRequest,BatchGetDocumentsResponse>	batchGetDocumentsCallable()	Gets multiple documents.
com.google.api.gax.rpc.UnaryCallable<BatchWriteRequest,BatchWriteResponse>	batchWriteCallable()
com.google.api.gax.rpc.UnaryCallable<BeginTransactionRequest,BeginTransactionResponse>	beginTransactionCallable()	Starts a new transaction.
com.google.api.gax.rpc.UnaryCallable<CommitRequest,CommitResponse>	commitCallable()	Commits a transaction, while optionally updating documents.
ScheduledExecutorService	getExecutor()	Returns the executor used by the GAPIC client.
com.google.api.gax.rpc.UnaryCallable<ListCollectionIdsRequest,FirestoreClient.ListCollectionIdsPagedResponse>	listCollectionIdsPagedCallable()	Returns a list of collections IDs.
com.google.api.gax.rpc.UnaryCallable<ListDocumentsRequest,FirestoreClient.ListDocumentsPagedResponse>	listDocumentsPagedCallable()	Returns a list of documents.
com.google.api.gax.rpc.BidiStreamingCallable<ListenRequest,ListenResponse>	listenCallable()	Returns a bi-directional watch stream.
com.google.api.gax.rpc.UnaryCallable<PartitionQueryRequest,FirestoreClient.PartitionQueryPagedResponse>	partitionQueryPagedCallable()
com.google.api.gax.rpc.UnaryCallable<RollbackRequest,com.google.protobuf.Empty>	rollbackCallable()	Rolls back a transaction.
com.google.api.gax.rpc.ServerStreamingCallable<RunAggregationQueryRequest,RunAggregationQueryResponse>	runAggregationQueryCallable()	Runs an aggregation query.
com.google.api.gax.rpc.ServerStreamingCallable<RunQueryRequest,RunQueryResponse>	runQueryCallable()	Runs a query.
void	shutdown()
void	shutdownNow()

Methods inherited from interface java.lang.AutoCloseable

close

Method Details

commitCallable

com.google.api.gax.rpc.UnaryCallable<CommitRequest,CommitResponse> commitCallable()

Commits a transaction, while optionally updating documents.

batchWriteCallable

com.google.api.gax.rpc.UnaryCallable<BatchWriteRequest,BatchWriteResponse> batchWriteCallable()

batchGetDocumentsCallable

com.google.api.gax.rpc.ServerStreamingCallable<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsCallable()

Gets multiple documents.

getExecutor

ScheduledExecutorService getExecutor()

Returns the executor used by the GAPIC client.

runQueryCallable

com.google.api.gax.rpc.ServerStreamingCallable<RunQueryRequest,RunQueryResponse> runQueryCallable()

Runs a query.

runAggregationQueryCallable

com.google.api.gax.rpc.ServerStreamingCallable<RunAggregationQueryRequest,RunAggregationQueryResponse> runAggregationQueryCallable()

Runs an aggregation query.

beginTransactionCallable

com.google.api.gax.rpc.UnaryCallable<BeginTransactionRequest,BeginTransactionResponse> beginTransactionCallable()

Starts a new transaction.

rollbackCallable

com.google.api.gax.rpc.UnaryCallable<RollbackRequest,com.google.protobuf.Empty> rollbackCallable()

Rolls back a transaction.

listCollectionIdsPagedCallable

com.google.api.gax.rpc.UnaryCallable<ListCollectionIdsRequest,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsPagedCallable()

Returns a list of collections IDs.

partitionQueryPagedCallable

com.google.api.gax.rpc.UnaryCallable<PartitionQueryRequest,FirestoreClient.PartitionQueryPagedResponse> partitionQueryPagedCallable()

listDocumentsPagedCallable

com.google.api.gax.rpc.UnaryCallable<ListDocumentsRequest,FirestoreClient.ListDocumentsPagedResponse> listDocumentsPagedCallable()

Returns a list of documents.

listenCallable

com.google.api.gax.rpc.BidiStreamingCallable<ListenRequest,ListenResponse> listenCallable()

Returns a bi-directional watch stream.

shutdownNow

void shutdownNow()

shutdown

void shutdown()