com.google.firestore.v1beta1

Class FirestoreGrpc.FirestoreFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<FirestoreGrpc.FirestoreFutureStub>

com.google.firestore.v1beta1.FirestoreGrpc.FirestoreFutureStub

Enclosing class:

FirestoreGrpc

public static final class FirestoreGrpc.FirestoreFutureStub
extends io.grpc.stub.AbstractStub<FirestoreGrpc.FirestoreFutureStub>

 The Cloud Firestore service.
 This service exposes several types of comparable timestamps:
 *    `create_time` - The time at which a document was created. Changes only
      when a document is deleted, then re-created. Increases in a strict
       monotonic fashion.
 *    `update_time` - The time at which a document was last updated. Changes
      every time a document is modified. Does not change when a write results
      in no modifications. Increases in a strict monotonic fashion.
 *    `read_time` - The time at which a particular state was observed. Used
      to denote a consistent snapshot of the database or the time at which a
      Document was observed to not exist.
 *    `commit_time` - The time at which the writes in a transaction were
      committed. Any read with an equal or greater `read_time` is guaranteed
      to see the effects of the transaction.
 

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<BeginTransactionResponse>	beginTransaction(BeginTransactionRequest request) Starts a new transaction.
protected FirestoreGrpc.FirestoreFutureStub	build(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<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>	listCollectionIds(ListCollectionIdsRequest request) 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<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.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected FirestoreGrpc.FirestoreFutureStub build(io.grpc.Channel channel,
                                                  io.grpc.CallOptions callOptions)

Specified by:

build in class io.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.
 

createDocument

public com.google.common.util.concurrent.ListenableFuture<Document> createDocument(CreateDocumentRequest request)

 Creates a new document.
 

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<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<Empty> rollback(RollbackRequest request)

 Rolls back a transaction.
 

listCollectionIds

public com.google.common.util.concurrent.ListenableFuture<ListCollectionIdsResponse> listCollectionIds(ListCollectionIdsRequest request)

 Lists all the collection IDs underneath a document.