public static final class FirestoreGrpc.FirestoreBlockingStub extends AbstractBlockingStub<FirestoreGrpc.FirestoreBlockingStub>
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 (GCP) accelerate
building truly serverless apps.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractBlockingStub >
FirestoreGrpc.FirestoreBlockingStub
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
batchGetDocuments(BatchGetDocumentsRequest request)
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.
batchWrite(BatchWriteRequest request)
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 for the success status of each write.
If you require an atomically applied set of writes, use
Commit instead.
beginTransaction(BeginTransactionRequest request)
public BeginTransactionResponse beginTransaction(BeginTransactionRequest request)
Starts a new transaction.
build(Channel channel, CallOptions callOptions)
protected FirestoreGrpc.FirestoreBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
| Name | Description |
channel | io.grpc.Channel
|
callOptions | io.grpc.CallOptions
|
Returns
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
commit(CommitRequest request)
public CommitResponse commit(CommitRequest request)
Commits a transaction, while optionally updating documents.
createDocument(CreateDocumentRequest request)
public Document createDocument(CreateDocumentRequest request)
Parameter
Returns
deleteDocument(DeleteDocumentRequest request)
public Empty deleteDocument(DeleteDocumentRequest request)
Parameter
Returns
getDocument(GetDocumentRequest request)
public Document getDocument(GetDocumentRequest request)
Parameter
Returns
listCollectionIds(ListCollectionIdsRequest request)
public ListCollectionIdsResponse listCollectionIds(ListCollectionIdsRequest request)
Lists all the collection IDs underneath a document.
listDocuments(ListDocumentsRequest request)
public ListDocumentsResponse listDocuments(ListDocumentsRequest request)
Parameter
Returns
partitionQuery(PartitionQueryRequest request)
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.
rollback(RollbackRequest request)
public Empty rollback(RollbackRequest request)
Rolls back a transaction.
runAggregationQuery(RunAggregationQueryRequest request)
public Iterator<RunAggregationQueryResponse> runAggregationQuery(RunAggregationQueryRequest request)
Runs an aggregation query.
Rather than producing Document results like Firestore.RunQuery,
this API allows running an aggregation to produce a series of
AggregationResult server-side.
High-Level Example:
<code><code>
-- Return the number of documents in table given a filter.
SELECT COUNT(*) FROM ( SELECT * FROM k where a = true );
</code></code>
runQuery(RunQueryRequest request)
public Iterator<RunQueryResponse> runQuery(RunQueryRequest request)
Parameter
Returns
updateDocument(UpdateDocumentRequest request)
public Document updateDocument(UpdateDocumentRequest request)
Updates or inserts a document.
