Package com.google.firestore.v1

Class FirestoreGrpc.FirestoreBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

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

com.google.firestore.v1.FirestoreGrpc.FirestoreBlockingStub

Enclosing class:

FirestoreGrpc

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

A stub to allow clients to do limited 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.
 

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 Type	Method	Description
Iterator<BatchGetDocumentsResponse>	batchGetDocuments(BatchGetDocumentsRequest request)	Gets multiple documents.
BatchWriteResponse	batchWrite(BatchWriteRequest request)	Applies a batch of write operations.
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.
com.google.protobuf.Empty	deleteDocument(DeleteDocumentRequest request)	Deletes a document.
Iterator<ExecutePipelineResponse>	executePipeline(ExecutePipelineRequest request)	Executes a pipeline query.
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.
PartitionQueryResponse	partitionQuery(PartitionQueryRequest request)	Partitions a query by returning partition cursors that can be used to run the query in parallel.
com.google.protobuf.Empty	rollback(RollbackRequest request)	Rolls back a transaction.
Iterator<RunAggregationQueryResponse>	runAggregationQuery(RunAggregationQueryRequest request)	Runs an aggregation query.
Iterator<RunQueryResponse>	runQuery(RunQueryRequest request)	Runs a query.
Document	updateDocument(UpdateDocumentRequest request)	Updates or inserts a document.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

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

Methods inherited from class java.lang.Object

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

Method Details

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.
 

updateDocument

public Document updateDocument(UpdateDocumentRequest request)

 Updates or inserts a document.
 

deleteDocument

public com.google.protobuf.Empty deleteDocument(DeleteDocumentRequest request)

 Deletes a document.
 

batchGetDocuments

public 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 com.google.protobuf.Empty rollback(RollbackRequest request)

 Rolls back a transaction.
 

runQuery

public Iterator<RunQueryResponse> runQuery(RunQueryRequest request)

 Runs a query.
 

executePipeline

public Iterator<ExecutePipelineResponse> executePipeline(ExecutePipelineRequest request)

 Executes a pipeline query.
 

runAggregationQuery

public Iterator<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)

 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 ListCollectionIdsResponse listCollectionIds(ListCollectionIdsRequest request)

 Lists all the collection IDs underneath a document.
 

batchWrite

public 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 Document createDocument(CreateDocumentRequest request)

 Creates a new document.