Class FirestoreGrpc.FirestoreImplBase

public abstract static class FirestoreGrpc.FirestoreImplBase implements BindableService

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 > FirestoreGrpc.FirestoreImplBase

Implements

io.grpc.BindableService

Constructors

FirestoreImplBase()

public FirestoreImplBase()

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
NameDescription
requestBatchGetDocumentsRequest
responseObserverio.grpc.stub.StreamObserver<BatchGetDocumentsResponse>

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
NameDescription
requestBatchWriteRequest
responseObserverio.grpc.stub.StreamObserver<BatchWriteResponse>

beginTransaction(BeginTransactionRequest request, StreamObserver<BeginTransactionResponse> responseObserver)

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

Starts a new transaction.

Parameters
NameDescription
requestBeginTransactionRequest
responseObserverio.grpc.stub.StreamObserver<BeginTransactionResponse>

bindService()

public final ServerServiceDefinition bindService()
Returns
TypeDescription
io.grpc.ServerServiceDefinition

commit(CommitRequest request, StreamObserver<CommitResponse> responseObserver)

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

Commits a transaction, while optionally updating documents.

Parameters
NameDescription
requestCommitRequest
responseObserverio.grpc.stub.StreamObserver<CommitResponse>

createDocument(CreateDocumentRequest request, StreamObserver<Document> responseObserver)

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

Creates a new document.

Parameters
NameDescription
requestCreateDocumentRequest
responseObserverio.grpc.stub.StreamObserver<Document>

deleteDocument(DeleteDocumentRequest request, StreamObserver<Empty> responseObserver)

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

Deletes a document.

Parameters
NameDescription
requestDeleteDocumentRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

getDocument(GetDocumentRequest request, StreamObserver<Document> responseObserver)

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

Gets a single document.

Parameters
NameDescription
requestGetDocumentRequest
responseObserverio.grpc.stub.StreamObserver<Document>

listCollectionIds(ListCollectionIdsRequest request, StreamObserver<ListCollectionIdsResponse> responseObserver)

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

Lists all the collection IDs underneath a document.

Parameters
NameDescription
requestListCollectionIdsRequest
responseObserverio.grpc.stub.StreamObserver<ListCollectionIdsResponse>

listDocuments(ListDocumentsRequest request, StreamObserver<ListDocumentsResponse> responseObserver)

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

Lists documents.

Parameters
NameDescription
requestListDocumentsRequest
responseObserverio.grpc.stub.StreamObserver<ListDocumentsResponse>

listen(StreamObserver<ListenResponse> responseObserver)

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

Listens to changes.

Parameter
NameDescription
responseObserverio.grpc.stub.StreamObserver<ListenResponse>
Returns
TypeDescription
io.grpc.stub.StreamObserver<ListenRequest>

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
NameDescription
requestPartitionQueryRequest
responseObserverio.grpc.stub.StreamObserver<PartitionQueryResponse>

rollback(RollbackRequest request, StreamObserver<Empty> responseObserver)

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

Rolls back a transaction.

Parameters
NameDescription
requestRollbackRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

runQuery(RunQueryRequest request, StreamObserver<RunQueryResponse> responseObserver)

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

Runs a query.

Parameters
NameDescription
requestRunQueryRequest
responseObserverio.grpc.stub.StreamObserver<RunQueryResponse>

updateDocument(UpdateDocumentRequest request, StreamObserver<Document> responseObserver)

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

Updates or inserts a document.

Parameters
NameDescription
requestUpdateDocumentRequest
responseObserverio.grpc.stub.StreamObserver<Document>

write(StreamObserver<WriteResponse> responseObserver)

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

Streams batches of document updates and deletes, in order.

Parameter
NameDescription
responseObserverio.grpc.stub.StreamObserver<WriteResponse>
Returns
TypeDescription
io.grpc.stub.StreamObserver<WriteRequest>