com.google.cloud.firestore.spi.v1

Class GrpcFirestoreRpc

java.lang.Object

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

All Implemented Interfaces:

FirestoreRpc, 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 and Description
GrpcFirestoreRpc(FirestoreOptions options)

Method Summary

Modifier and Type	Method and Description
ServerStreamingCallable<com.google.firestore.v1.BatchGetDocumentsRequest,com.google.firestore.v1.BatchGetDocumentsResponse>	batchGetDocumentsCallable() Gets multiple documents.
UnaryCallable<com.google.firestore.v1.BeginTransactionRequest,com.google.firestore.v1.BeginTransactionResponse>	beginTransactionCallable() Starts a new transaction.
void	close()
UnaryCallable<com.google.firestore.v1.CommitRequest,com.google.firestore.v1.CommitResponse>	commitCallable() Commits a transaction, while optionally updating documents.
ScheduledExecutorService	getExecutor() Returns the executor used by the GAPIC client.
UnaryCallable<com.google.firestore.v1.ListCollectionIdsRequest,FirestoreClient.ListCollectionIdsPagedResponse>	listCollectionIdsPagedCallable() Returns a list of collections IDs.
UnaryCallable<com.google.firestore.v1.ListDocumentsRequest,FirestoreClient.ListDocumentsPagedResponse>	listDocumentsPagedCallable() Returns a list of documents.
BidiStreamingCallable<com.google.firestore.v1.ListenRequest,com.google.firestore.v1.ListenResponse>	listenCallable() Returns a bi-directional watch stream.
UnaryCallable<com.google.firestore.v1.RollbackRequest,Empty>	rollbackCallable() Rolls back a transaction.
ServerStreamingCallable<com.google.firestore.v1.RunQueryRequest,com.google.firestore.v1.RunQueryResponse>	runQueryCallable() Runs a query.

Methods inherited from class java.lang.Object

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

Constructor Detail

GrpcFirestoreRpc

public GrpcFirestoreRpc(FirestoreOptions options)
                 throws IOException

Throws:

IOException

Method Detail

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

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 UnaryCallable<com.google.firestore.v1.CommitRequest,com.google.firestore.v1.CommitResponse> commitCallable()

Description copied from interface: FirestoreRpc

Commits a transaction, while optionally updating documents.

Specified by:

commitCallable in interface FirestoreRpc

batchGetDocumentsCallable

public ServerStreamingCallable<com.google.firestore.v1.BatchGetDocumentsRequest,com.google.firestore.v1.BatchGetDocumentsResponse> batchGetDocumentsCallable()

Description copied from interface: FirestoreRpc

Gets multiple documents.

Specified by:

batchGetDocumentsCallable in interface FirestoreRpc

runQueryCallable

public ServerStreamingCallable<com.google.firestore.v1.RunQueryRequest,com.google.firestore.v1.RunQueryResponse> runQueryCallable()

Description copied from interface: FirestoreRpc

Runs a query.

Specified by:

runQueryCallable in interface FirestoreRpc

beginTransactionCallable

public UnaryCallable<com.google.firestore.v1.BeginTransactionRequest,com.google.firestore.v1.BeginTransactionResponse> beginTransactionCallable()

Description copied from interface: FirestoreRpc

Starts a new transaction.

Specified by:

beginTransactionCallable in interface FirestoreRpc

rollbackCallable

public UnaryCallable<com.google.firestore.v1.RollbackRequest,Empty> rollbackCallable()

Description copied from interface: FirestoreRpc

Rolls back a transaction.

Specified by:

rollbackCallable in interface FirestoreRpc

listCollectionIdsPagedCallable

public UnaryCallable<com.google.firestore.v1.ListCollectionIdsRequest,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsPagedCallable()

Description copied from interface: FirestoreRpc

Returns a list of collections IDs.

Specified by:

listCollectionIdsPagedCallable in interface FirestoreRpc

listDocumentsPagedCallable

public UnaryCallable<com.google.firestore.v1.ListDocumentsRequest,FirestoreClient.ListDocumentsPagedResponse> listDocumentsPagedCallable()

Description copied from interface: FirestoreRpc

Returns a list of documents.

Specified by:

listDocumentsPagedCallable in interface FirestoreRpc

listenCallable

public BidiStreamingCallable<com.google.firestore.v1.ListenRequest,com.google.firestore.v1.ListenResponse> listenCallable()

Description copied from interface: FirestoreRpc

Returns a bi-directional watch stream.

Specified by:

listenCallable in interface FirestoreRpc