Package com.google.firestore.v1

Class FirestoreGrpc.FirestoreBlockingV2Stub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractBlockingStub<FirestoreGrpc.FirestoreBlockingV2Stub>
com.google.firestore.v1.FirestoreGrpc.FirestoreBlockingV2Stub
Enclosing class:
FirestoreGrpc
public static final class FirestoreGrpc.FirestoreBlockingV2Stub extends io.grpc.stub.AbstractBlockingStub<FirestoreGrpc.FirestoreBlockingV2Stub>
A stub to allow clients to do synchronous 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.

  • Method Details

    • build

      protected FirestoreGrpc.FirestoreBlockingV2Stub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<FirestoreGrpc.FirestoreBlockingV2Stub>

    • getDocument

      public Document getDocument(GetDocumentRequest request) throws io.grpc.StatusException
       Gets a single document.
      Throws:
      io.grpc.StatusException

    • listDocuments

      public ListDocumentsResponse listDocuments(ListDocumentsRequest request) throws io.grpc.StatusException
       Lists documents.
      Throws:
      io.grpc.StatusException

    • updateDocument

      public Document updateDocument(UpdateDocumentRequest request) throws io.grpc.StatusException
       Updates or inserts a document.
      Throws:
      io.grpc.StatusException

    • deleteDocument

      public com.google.protobuf.Empty deleteDocument(DeleteDocumentRequest request) throws io.grpc.StatusException
       Deletes a document.
      Throws:
      io.grpc.StatusException

    • batchGetDocuments

      @ExperimentalApi("https://github.com/grpc/grpc-java/issues/10918") public io.grpc.stub.BlockingClientCall<?,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) throws io.grpc.StatusException
       Starts a new transaction.
      Throws:
      io.grpc.StatusException

    • commit

      public CommitResponse commit(CommitRequest request) throws io.grpc.StatusException
       Commits a transaction, while optionally updating documents.
      Throws:
      io.grpc.StatusException

    • rollback

      public com.google.protobuf.Empty rollback(RollbackRequest request) throws io.grpc.StatusException
       Rolls back a transaction.
      Throws:
      io.grpc.StatusException

    • runQuery

      @ExperimentalApi("https://github.com/grpc/grpc-java/issues/10918") public io.grpc.stub.BlockingClientCall<?,RunQueryResponse> runQuery(RunQueryRequest request)
       Runs a query.

    • executePipeline

      @ExperimentalApi("https://github.com/grpc/grpc-java/issues/10918") public io.grpc.stub.BlockingClientCall<?,ExecutePipelineResponse> executePipeline(ExecutePipelineRequest request)
       Executes a pipeline query.

    • runAggregationQuery

      @ExperimentalApi("https://github.com/grpc/grpc-java/issues/10918") public io.grpc.stub.BlockingClientCall<?,RunAggregationQueryResponse> runAggregationQuery(RunAggregationQueryRequest request)
       Runs an aggregation query.
 Rather than producing [Document][google.firestore.v1.Document] results like
 [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery], this API
 allows running an aggregation to produce a series of
 [AggregationResult][google.firestore.v1.AggregationResult] server-side.
 High-Level Example:
 ```
 -- Return the number of documents in table given a filter.
 SELECT COUNT(*) FROM ( SELECT * FROM k where a = true );
 ```

    • partitionQuery

      public PartitionQueryResponse partitionQuery(PartitionQueryRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • write

      @ExperimentalApi("https://github.com/grpc/grpc-java/issues/10918") public io.grpc.stub.BlockingClientCall<WriteRequest,WriteResponse> write()
       Streams batches of document updates and deletes, in order. This method is
 only available via gRPC or WebChannel (not REST).

    • listen

      @ExperimentalApi("https://github.com/grpc/grpc-java/issues/10918") public io.grpc.stub.BlockingClientCall<ListenRequest,ListenResponse> listen()
       Listens to changes. This method is only available via gRPC or WebChannel
 (not REST).

    • listCollectionIds

      public ListCollectionIdsResponse listCollectionIds(ListCollectionIdsRequest request) throws io.grpc.StatusException
       Lists all the collection IDs underneath a document.
      Throws:
      io.grpc.StatusException

    • batchWrite

      public BatchWriteResponse batchWrite(BatchWriteRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • createDocument

      public Document createDocument(CreateDocumentRequest request) throws io.grpc.StatusException
       Creates a new document.
      Throws:
      io.grpc.StatusException