Package com.google.firestore.v1
Class FirestoreGrpc.FirestoreFutureStub
java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<FirestoreGrpc.FirestoreFutureStub>
com.google.firestore.v1.FirestoreGrpc.FirestoreFutureStub
- Enclosing class:
- FirestoreGrpc
public static final class FirestoreGrpc.FirestoreFutureStub
extends io.grpc.stub.AbstractFutureStub<FirestoreGrpc.FirestoreFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service Firestore.
The Cloud Firestore service. Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global scale. Its client libraries provide live synchronization and offline support, while its security features and integrations with Firebase and Google Cloud Platform accelerate building truly serverless apps.
-
Nested Class Summary
Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub
io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>> -
Method Summary
Modifier and TypeMethodDescriptioncom.google.common.util.concurrent.ListenableFuture<BatchWriteResponse>batchWrite(BatchWriteRequest request) Applies a batch of write operations.com.google.common.util.concurrent.ListenableFuture<BeginTransactionResponse>beginTransaction(BeginTransactionRequest request) Starts a new transaction.protected FirestoreGrpc.FirestoreFutureStubbuild(io.grpc.Channel channel, io.grpc.CallOptions callOptions) com.google.common.util.concurrent.ListenableFuture<CommitResponse>commit(CommitRequest request) Commits a transaction, while optionally updating documents.com.google.common.util.concurrent.ListenableFuture<Document>createDocument(CreateDocumentRequest request) Creates a new document.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>deleteDocument(DeleteDocumentRequest request) Deletes a document.com.google.common.util.concurrent.ListenableFuture<Document>getDocument(GetDocumentRequest request) Gets a single document.com.google.common.util.concurrent.ListenableFuture<ListCollectionIdsResponse>Lists all the collection IDs underneath a document.com.google.common.util.concurrent.ListenableFuture<ListDocumentsResponse>listDocuments(ListDocumentsRequest request) Lists documents.com.google.common.util.concurrent.ListenableFuture<PartitionQueryResponse>partitionQuery(PartitionQueryRequest request) Partitions a query by returning partition cursors that can be used to run the query in parallel.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>rollback(RollbackRequest request) Rolls back a transaction.com.google.common.util.concurrent.ListenableFuture<Document>updateDocument(UpdateDocumentRequest request) Updates or inserts a document.Methods inherited from class io.grpc.stub.AbstractFutureStub
newStub, newStubMethods inherited from class io.grpc.stub.AbstractStub
getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady
-
Method Details
-
build
protected FirestoreGrpc.FirestoreFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions) - Specified by:
buildin classio.grpc.stub.AbstractStub<FirestoreGrpc.FirestoreFutureStub>
-
getDocument
public com.google.common.util.concurrent.ListenableFuture<Document> getDocument(GetDocumentRequest request) Gets a single document.
-
listDocuments
public com.google.common.util.concurrent.ListenableFuture<ListDocumentsResponse> listDocuments(ListDocumentsRequest request) Lists documents.
-
updateDocument
public com.google.common.util.concurrent.ListenableFuture<Document> updateDocument(UpdateDocumentRequest request) Updates or inserts a document.
-
deleteDocument
public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteDocument(DeleteDocumentRequest request) Deletes a document.
-
beginTransaction
public com.google.common.util.concurrent.ListenableFuture<BeginTransactionResponse> beginTransaction(BeginTransactionRequest request) Starts a new transaction.
-
commit
public com.google.common.util.concurrent.ListenableFuture<CommitResponse> commit(CommitRequest request) Commits a transaction, while optionally updating documents.
-
rollback
public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> rollback(RollbackRequest request) Rolls back a transaction.
-
partitionQuery
public com.google.common.util.concurrent.ListenableFuture<PartitionQueryResponse> partitionQuery(PartitionQueryRequest request) Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results.
-
listCollectionIds
public com.google.common.util.concurrent.ListenableFuture<ListCollectionIdsResponse> listCollectionIds(ListCollectionIdsRequest request) Lists all the collection IDs underneath a document.
-
batchWrite
public com.google.common.util.concurrent.ListenableFuture<BatchWriteResponse> batchWrite(BatchWriteRequest request) Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the success status of each write. If you require an atomically applied set of writes, use [Commit][google.firestore.v1.Firestore.Commit] instead.
-
createDocument
public com.google.common.util.concurrent.ListenableFuture<Document> createDocument(CreateDocumentRequest request) Creates a new document.
-