Interface FirestoreGrpc.AsyncService (3.9.6)

public static interface FirestoreGrpc.AsyncService

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.

Methods

batchGetDocuments(BatchGetDocumentsRequest request, StreamObserver<BatchGetDocumentsResponse> responseObserver)

public default void batchGetDocuments(BatchGetDocumentsRequest request, StreamObserver<BatchGetDocumentsResponse> responseObserver)

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

Parameters
Name	Description
`request`	`BatchGetDocumentsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<BatchGetDocumentsResponse>`

batchWrite(BatchWriteRequest request, StreamObserver<BatchWriteResponse> responseObserver)

public default void batchWrite(BatchWriteRequest request, StreamObserver<BatchWriteResponse> responseObserver)

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.

Parameters
Name	Description
`request`	`BatchWriteRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<BatchWriteResponse>`

beginTransaction(BeginTransactionRequest request, StreamObserver<BeginTransactionResponse> responseObserver)

public default void beginTransaction(BeginTransactionRequest request, StreamObserver<BeginTransactionResponse> responseObserver)

Starts a new transaction.

Parameters
Name	Description
`request`	`BeginTransactionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<BeginTransactionResponse>`

commit(CommitRequest request, StreamObserver<CommitResponse> responseObserver)

public default void commit(CommitRequest request, StreamObserver<CommitResponse> responseObserver)

Commits a transaction, while optionally updating documents.

Parameters
Name	Description
`request`	`CommitRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<CommitResponse>`

createDocument(CreateDocumentRequest request, StreamObserver<Document> responseObserver)

public default void createDocument(CreateDocumentRequest request, StreamObserver<Document> responseObserver)

Creates a new document.

Parameters
Name	Description
`request`	`CreateDocumentRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Document>`

deleteDocument(DeleteDocumentRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDocument(DeleteDocumentRequest request, StreamObserver<Empty> responseObserver)

Deletes a document.

Parameters
Name	Description
`request`	`DeleteDocumentRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

getDocument(GetDocumentRequest request, StreamObserver<Document> responseObserver)

public default void getDocument(GetDocumentRequest request, StreamObserver<Document> responseObserver)

Gets a single document.

Parameters
Name	Description
`request`	`GetDocumentRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Document>`

listCollectionIds(ListCollectionIdsRequest request, StreamObserver<ListCollectionIdsResponse> responseObserver)

public default void listCollectionIds(ListCollectionIdsRequest request, StreamObserver<ListCollectionIdsResponse> responseObserver)

Lists all the collection IDs underneath a document.

Parameters
Name	Description
`request`	`ListCollectionIdsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListCollectionIdsResponse>`

listDocuments(ListDocumentsRequest request, StreamObserver<ListDocumentsResponse> responseObserver)

public default void listDocuments(ListDocumentsRequest request, StreamObserver<ListDocumentsResponse> responseObserver)

Lists documents.

Parameters
Name	Description
`request`	`ListDocumentsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListDocumentsResponse>`

listen(StreamObserver<ListenResponse> responseObserver)

public default StreamObserver<ListenRequest> listen(StreamObserver<ListenResponse> responseObserver)

Listens to changes. This method is only available via the gRPC API (not REST).

Parameter
Name	Description
`responseObserver`	`io.grpc.stub.StreamObserver<ListenResponse>`

Returns
Type	Description
`io.grpc.stub.StreamObserver<ListenRequest>`

partitionQuery(PartitionQueryRequest request, StreamObserver<PartitionQueryResponse> responseObserver)

public default void partitionQuery(PartitionQueryRequest request, StreamObserver<PartitionQueryResponse> responseObserver)

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.

Parameters
Name	Description
`request`	`PartitionQueryRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<PartitionQueryResponse>`

rollback(RollbackRequest request, StreamObserver<Empty> responseObserver)

public default void rollback(RollbackRequest request, StreamObserver<Empty> responseObserver)

Rolls back a transaction.

Parameters
Name	Description
`request`	`RollbackRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

runAggregationQuery(RunAggregationQueryRequest request, StreamObserver<RunAggregationQueryResponse> responseObserver)

public default void runAggregationQuery(RunAggregationQueryRequest request, StreamObserver<RunAggregationQueryResponse> responseObserver)

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>

Parameters
Name	Description
`request`	`RunAggregationQueryRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<RunAggregationQueryResponse>`

runQuery(RunQueryRequest request, StreamObserver<RunQueryResponse> responseObserver)

public default void runQuery(RunQueryRequest request, StreamObserver<RunQueryResponse> responseObserver)

Runs a query.

Parameters
Name	Description
`request`	`RunQueryRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<RunQueryResponse>`

updateDocument(UpdateDocumentRequest request, StreamObserver<Document> responseObserver)

public default void updateDocument(UpdateDocumentRequest request, StreamObserver<Document> responseObserver)

Updates or inserts a document.

Parameters
Name	Description
`request`	`UpdateDocumentRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Document>`

write(StreamObserver<WriteResponse> responseObserver)

public default StreamObserver<WriteRequest> write(StreamObserver<WriteResponse> responseObserver)

Streams batches of document updates and deletes, in order. This method is only available via the gRPC API (not REST).

Parameter
Name	Description
`responseObserver`	`io.grpc.stub.StreamObserver<WriteResponse>`

Returns
Type	Description
`io.grpc.stub.StreamObserver<WriteRequest>`