Class FirestoreGrpc.FirestoreStub (3.2.0)
Version 3.2.0keyboard_arrow_down
public static final class FirestoreGrpc . FirestoreStub extends AbstractAsyncStub<FirestoreGrpc . FirestoreStub >
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.AbstractAsyncStub >
FirestoreGrpc.FirestoreStub
Inherited Members
io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractAsyncStub.<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, StreamObserver<BatchGetDocumentsResponse> responseObserver)
public 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
batchWrite(BatchWriteRequest request, StreamObserver<BatchWriteResponse> responseObserver)
public 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
beginTransaction(BeginTransactionRequest request, StreamObserver<BeginTransactionResponse> responseObserver)
public void beginTransaction ( BeginTransactionRequest request , StreamObserver<BeginTransactionResponse> responseObserver )
Starts a new transaction.
Parameters
build(Channel channel, CallOptions callOptions)
protected FirestoreGrpc . FirestoreStub 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, StreamObserver<CommitResponse> responseObserver)
public void commit ( CommitRequest request , StreamObserver<CommitResponse> responseObserver )
Commits a transaction, while optionally updating documents.
Parameters
createDocument(CreateDocumentRequest request, StreamObserver<Document> responseObserver)
public void createDocument ( CreateDocumentRequest request , StreamObserver<Document> responseObserver )
Parameters
deleteDocument(DeleteDocumentRequest request, StreamObserver<Empty> responseObserver)
public void deleteDocument ( DeleteDocumentRequest request , StreamObserver<Empty> responseObserver )
Parameters
getDocument(GetDocumentRequest request, StreamObserver<Document> responseObserver)
public void getDocument ( GetDocumentRequest request , StreamObserver<Document> responseObserver )
Parameters
listCollectionIds(ListCollectionIdsRequest request, StreamObserver<ListCollectionIdsResponse> responseObserver)
public void listCollectionIds ( ListCollectionIdsRequest request , StreamObserver<ListCollectionIdsResponse> responseObserver )
Lists all the collection IDs underneath a document.
Parameters
listDocuments(ListDocumentsRequest request, StreamObserver<ListDocumentsResponse> responseObserver)
public void listDocuments ( ListDocumentsRequest request , StreamObserver<ListDocumentsResponse> responseObserver )
Parameters
listen(StreamObserver<ListenResponse> responseObserver)
public StreamObserver<ListenRequest> listen ( StreamObserver<ListenResponse> responseObserver )
Parameter
Name Description
responseObserver io.grpc.stub.StreamObserver <ListenResponse >
Returns
partitionQuery(PartitionQueryRequest request, StreamObserver<PartitionQueryResponse> responseObserver)
public 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
rollback(RollbackRequest request, StreamObserver<Empty> responseObserver)
public void rollback ( RollbackRequest request , StreamObserver<Empty> responseObserver )
Rolls back a transaction.
Parameters
runQuery(RunQueryRequest request, StreamObserver<RunQueryResponse> responseObserver)
public void runQuery ( RunQueryRequest request , StreamObserver<RunQueryResponse> responseObserver )
Parameters
updateDocument(UpdateDocumentRequest request, StreamObserver<Document> responseObserver)
public void updateDocument ( UpdateDocumentRequest request , StreamObserver<Document> responseObserver )
Updates or inserts a document.
Parameters
write(StreamObserver<WriteResponse> responseObserver)
public StreamObserver<WriteRequest> write ( StreamObserver<WriteResponse> responseObserver )
Streams batches of document updates and deletes, in order.
Parameter
Name Description
responseObserver io.grpc.stub.StreamObserver <WriteResponse >
Returns
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
