Class FirestoreGrpc.FirestoreBlockingStub (3.27.2)

public static final class FirestoreGrpc.FirestoreBlockingStub extends AbstractBlockingStub<FirestoreGrpc.FirestoreBlockingStub>

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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > FirestoreGrpc.FirestoreBlockingStub

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.

Parameter
Name Description
request BatchGetDocumentsRequest
Returns
Type Description
Iterator<BatchGetDocumentsResponse>

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.

Parameter
Name Description
request BatchWriteRequest
Returns
Type Description
BatchWriteResponse

beginTransaction(BeginTransactionRequest request)

public BeginTransactionResponse beginTransaction(BeginTransactionRequest request)

Starts a new transaction.

Parameter
Name Description
request BeginTransactionRequest
Returns
Type Description
BeginTransactionResponse

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
Type Description
FirestoreGrpc.FirestoreBlockingStub
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.

Parameter
Name Description
request CommitRequest
Returns
Type Description
CommitResponse

createDocument(CreateDocumentRequest request)

public Document createDocument(CreateDocumentRequest request)

Creates a new document.

Parameter
Name Description
request CreateDocumentRequest
Returns
Type Description
Document

deleteDocument(DeleteDocumentRequest request)

public Empty deleteDocument(DeleteDocumentRequest request)

Deletes a document.

Parameter
Name Description
request DeleteDocumentRequest
Returns
Type Description
Empty

getDocument(GetDocumentRequest request)

public Document getDocument(GetDocumentRequest request)

Gets a single document.

Parameter
Name Description
request GetDocumentRequest
Returns
Type Description
Document

listCollectionIds(ListCollectionIdsRequest request)

public ListCollectionIdsResponse listCollectionIds(ListCollectionIdsRequest request)

Lists all the collection IDs underneath a document.

Parameter
Name Description
request ListCollectionIdsRequest
Returns
Type Description
ListCollectionIdsResponse

listDocuments(ListDocumentsRequest request)

public ListDocumentsResponse listDocuments(ListDocumentsRequest request)

Lists documents.

Parameter
Name Description
request ListDocumentsRequest
Returns
Type Description
ListDocumentsResponse

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.

Parameter
Name Description
request PartitionQueryRequest
Returns
Type Description
PartitionQueryResponse

rollback(RollbackRequest request)

public Empty rollback(RollbackRequest request)

Rolls back a transaction.

Parameter
Name Description
request RollbackRequest
Returns
Type Description
Empty

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>

Parameter
Name Description
request RunAggregationQueryRequest
Returns
Type Description
Iterator<RunAggregationQueryResponse>

runQuery(RunQueryRequest request)

public Iterator<RunQueryResponse> runQuery(RunQueryRequest request)

Runs a query.

Parameter
Name Description
request RunQueryRequest
Returns
Type Description
Iterator<RunQueryResponse>

updateDocument(UpdateDocumentRequest request)

public Document updateDocument(UpdateDocumentRequest request)

Updates or inserts a document.

Parameter
Name Description
request UpdateDocumentRequest
Returns
Type Description
Document