com.google.firestore.v1beta1

Class FirestoreGrpc.FirestoreStub

java.lang.Object

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

com.google.firestore.v1beta1.FirestoreGrpc.FirestoreStub

Enclosing class:

FirestoreGrpc

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

 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
void	batchGetDocuments(BatchGetDocumentsRequest request, io.grpc.stub.StreamObserver<BatchGetDocumentsResponse> responseObserver) Gets multiple documents.
void	beginTransaction(BeginTransactionRequest request, io.grpc.stub.StreamObserver<BeginTransactionResponse> responseObserver) Starts a new transaction.
protected FirestoreGrpc.FirestoreStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	commit(CommitRequest request, io.grpc.stub.StreamObserver<CommitResponse> responseObserver) Commits a transaction, while optionally updating documents.
void	createDocument(CreateDocumentRequest request, io.grpc.stub.StreamObserver<Document> responseObserver) Creates a new document.
void	deleteDocument(DeleteDocumentRequest request, io.grpc.stub.StreamObserver<Empty> responseObserver) Deletes a document.
void	getDocument(GetDocumentRequest request, io.grpc.stub.StreamObserver<Document> responseObserver) Gets a single document.
void	listCollectionIds(ListCollectionIdsRequest request, io.grpc.stub.StreamObserver<ListCollectionIdsResponse> responseObserver) Lists all the collection IDs underneath a document.
void	listDocuments(ListDocumentsRequest request, io.grpc.stub.StreamObserver<ListDocumentsResponse> responseObserver) Lists documents.
io.grpc.stub.StreamObserver<ListenRequest>	listen(io.grpc.stub.StreamObserver<ListenResponse> responseObserver) Listens to changes.
void	rollback(RollbackRequest request, io.grpc.stub.StreamObserver<Empty> responseObserver) Rolls back a transaction.
void	runQuery(RunQueryRequest request, io.grpc.stub.StreamObserver<RunQueryResponse> responseObserver) Runs a query.
void	updateDocument(UpdateDocumentRequest request, io.grpc.stub.StreamObserver<Document> responseObserver) Updates or inserts a document.
io.grpc.stub.StreamObserver<WriteRequest>	write(io.grpc.stub.StreamObserver<WriteResponse> responseObserver) Streams batches of document updates and deletes, in order.

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.FirestoreStub build(io.grpc.Channel channel,
                                            io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<FirestoreGrpc.FirestoreStub>

getDocument

public void getDocument(GetDocumentRequest request,
                        io.grpc.stub.StreamObserver<Document> responseObserver)

 Gets a single document.
 

listDocuments

public void listDocuments(ListDocumentsRequest request,
                          io.grpc.stub.StreamObserver<ListDocumentsResponse> responseObserver)

 Lists documents.
 

createDocument

public void createDocument(CreateDocumentRequest request,
                           io.grpc.stub.StreamObserver<Document> responseObserver)

 Creates a new document.
 

updateDocument

public void updateDocument(UpdateDocumentRequest request,
                           io.grpc.stub.StreamObserver<Document> responseObserver)

 Updates or inserts a document.
 

deleteDocument

public void deleteDocument(DeleteDocumentRequest request,
                           io.grpc.stub.StreamObserver<Empty> responseObserver)

 Deletes a document.
 

batchGetDocuments

public void batchGetDocuments(BatchGetDocumentsRequest request,
                              io.grpc.stub.StreamObserver<BatchGetDocumentsResponse> responseObserver)

 Gets multiple documents.
 Documents returned by this method are not guaranteed to be returned in the
 same order that they were requested.
 

beginTransaction

public void beginTransaction(BeginTransactionRequest request,
                             io.grpc.stub.StreamObserver<BeginTransactionResponse> responseObserver)

 Starts a new transaction.
 

commit

public void commit(CommitRequest request,
                   io.grpc.stub.StreamObserver<CommitResponse> responseObserver)

 Commits a transaction, while optionally updating documents.
 

rollback

public void rollback(RollbackRequest request,
                     io.grpc.stub.StreamObserver<Empty> responseObserver)

 Rolls back a transaction.
 

runQuery

public void runQuery(RunQueryRequest request,
                     io.grpc.stub.StreamObserver<RunQueryResponse> responseObserver)

 Runs a query.
 

write

public io.grpc.stub.StreamObserver<WriteRequest> write(io.grpc.stub.StreamObserver<WriteResponse> responseObserver)

 Streams batches of document updates and deletes, in order.
 

listen

public io.grpc.stub.StreamObserver<ListenRequest> listen(io.grpc.stub.StreamObserver<ListenResponse> responseObserver)

 Listens to changes.
 

listCollectionIds

public void listCollectionIds(ListCollectionIdsRequest request,
                              io.grpc.stub.StreamObserver<ListCollectionIdsResponse> responseObserver)

 Lists all the collection IDs underneath a document.