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

Class GrpcFirestoreRpc

java.lang.Object

com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

All Implemented Interfaces:

FirestoreRpc, com.google.cloud.ServiceRpc, AutoCloseable

public class GrpcFirestoreRpc
extends Object
implements FirestoreRpc

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

Constructor Summary

Constructors

Constructor	Description
GrpcFirestoreRpc(FirestoreOptions options)

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.
void	close()
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GrpcFirestoreRpc

public GrpcFirestoreRpc(FirestoreOptions options)
                 throws IOException

Throws:

IOException

Method Details

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

shutdown

public void shutdown()

Specified by:

shutdown in interface FirestoreRpc

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface FirestoreRpc

getExecutor

public ScheduledExecutorService getExecutor()

Description copied from interface: FirestoreRpc

Returns the executor used by the GAPIC client.

Specified by:

getExecutor in interface FirestoreRpc

commitCallable

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

Description copied from interface: FirestoreRpc

Commits a transaction, while optionally updating documents.

Specified by:

commitCallable in interface FirestoreRpc

batchWriteCallable

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

Specified by:

batchWriteCallable in interface FirestoreRpc

batchGetDocumentsCallable

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

Description copied from interface: FirestoreRpc

Gets multiple documents.

Specified by:

batchGetDocumentsCallable in interface FirestoreRpc

runQueryCallable

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

Description copied from interface: FirestoreRpc

Runs a query.

Specified by:

runQueryCallable in interface FirestoreRpc

runAggregationQueryCallable

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

Description copied from interface: FirestoreRpc

Runs an aggregation query.

Specified by:

runAggregationQueryCallable in interface FirestoreRpc

beginTransactionCallable

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

Description copied from interface: FirestoreRpc

Starts a new transaction.

Specified by:

beginTransactionCallable in interface FirestoreRpc

rollbackCallable

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

Description copied from interface: FirestoreRpc

Rolls back a transaction.

Specified by:

rollbackCallable in interface FirestoreRpc

listCollectionIdsPagedCallable

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

Description copied from interface: FirestoreRpc

Returns a list of collections IDs.

Specified by:

listCollectionIdsPagedCallable in interface FirestoreRpc

partitionQueryPagedCallable

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

Specified by:

partitionQueryPagedCallable in interface FirestoreRpc

listDocumentsPagedCallable

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

Description copied from interface: FirestoreRpc

Returns a list of documents.

Specified by:

listDocumentsPagedCallable in interface FirestoreRpc

listenCallable

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

Description copied from interface: FirestoreRpc

Returns a bi-directional watch stream.

Specified by:

listenCallable in interface FirestoreRpc