com.google.firestore.v1beta1

Class FirestoreGrpc.FirestoreBlockingStub

java.lang.Object

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

com.google.firestore.v1beta1.FirestoreGrpc.FirestoreBlockingStub

Enclosing class:

FirestoreGrpc

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

 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
java.util.Iterator<BatchGetDocumentsResponse>	batchGetDocuments(BatchGetDocumentsRequest request) Gets multiple documents.
BeginTransactionResponse	beginTransaction(BeginTransactionRequest request) Starts a new transaction.
protected FirestoreGrpc.FirestoreBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
CommitResponse	commit(CommitRequest request) Commits a transaction, while optionally updating documents.
Document	createDocument(CreateDocumentRequest request) Creates a new document.
Empty	deleteDocument(DeleteDocumentRequest request) Deletes a document.
Document	getDocument(GetDocumentRequest request) Gets a single document.
ListCollectionIdsResponse	listCollectionIds(ListCollectionIdsRequest request) Lists all the collection IDs underneath a document.
ListDocumentsResponse	listDocuments(ListDocumentsRequest request) Lists documents.
Empty	rollback(RollbackRequest request) Rolls back a transaction.
java.util.Iterator<RunQueryResponse>	runQuery(RunQueryRequest request) Runs a query.
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.FirestoreBlockingStub build(io.grpc.Channel channel,
                                                    io.grpc.CallOptions callOptions)

Specified by:

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

getDocument

public Document getDocument(GetDocumentRequest request)

 Gets a single document.
 

listDocuments

public ListDocumentsResponse listDocuments(ListDocumentsRequest request)

 Lists documents.
 

createDocument

public Document createDocument(CreateDocumentRequest request)

 Creates a new document.
 

updateDocument

public Document updateDocument(UpdateDocumentRequest request)

 Updates or inserts a document.
 

deleteDocument

public Empty deleteDocument(DeleteDocumentRequest request)

 Deletes a document.
 

batchGetDocuments

public java.util.Iterator<BatchGetDocumentsResponse> batchGetDocuments(BatchGetDocumentsRequest request)

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

beginTransaction

public BeginTransactionResponse beginTransaction(BeginTransactionRequest request)

 Starts a new transaction.
 

commit

public CommitResponse commit(CommitRequest request)

 Commits a transaction, while optionally updating documents.
 

rollback

public Empty rollback(RollbackRequest request)

 Rolls back a transaction.
 

runQuery

public java.util.Iterator<RunQueryResponse> runQuery(RunQueryRequest request)

 Runs a query.
 

listCollectionIds

public ListCollectionIdsResponse listCollectionIds(ListCollectionIdsRequest request)

 Lists all the collection IDs underneath a document.