Class FirestoreGrpc.FirestoreFutureStub (3.28.0)

public static final class FirestoreGrpc.FirestoreFutureStub extends AbstractFutureStub<FirestoreGrpc.FirestoreFutureStub>

A stub to allow clients to do ListenableFuture-style 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.AbstractFutureStub > FirestoreGrpc.FirestoreFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<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.withOnReadyThreshold(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

batchWrite(BatchWriteRequest request)

public ListenableFuture<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
`com.google.common.util.concurrent.ListenableFuture<BatchWriteResponse>`

beginTransaction(BeginTransactionRequest request)

public ListenableFuture<BeginTransactionResponse> beginTransaction(BeginTransactionRequest request)

Starts a new transaction.

Parameter
Name	Description
`request`	`BeginTransactionRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<BeginTransactionResponse>`

build(Channel channel, CallOptions callOptions)

protected FirestoreGrpc.FirestoreFutureStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`FirestoreGrpc.FirestoreFutureStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

commit(CommitRequest request)

public ListenableFuture<CommitResponse> commit(CommitRequest request)

Commits a transaction, while optionally updating documents.

Parameter
Name	Description
`request`	`CommitRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<CommitResponse>`

createDocument(CreateDocumentRequest request)

public ListenableFuture<Document> createDocument(CreateDocumentRequest request)

Creates a new document.

Parameter
Name	Description
`request`	`CreateDocumentRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Document>`

deleteDocument(DeleteDocumentRequest request)

public ListenableFuture<Empty> deleteDocument(DeleteDocumentRequest request)

Deletes a document.

Parameter
Name	Description
`request`	`DeleteDocumentRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

getDocument(GetDocumentRequest request)

public ListenableFuture<Document> getDocument(GetDocumentRequest request)

Gets a single document.

Parameter
Name	Description
`request`	`GetDocumentRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Document>`

listCollectionIds(ListCollectionIdsRequest request)

public ListenableFuture<ListCollectionIdsResponse> listCollectionIds(ListCollectionIdsRequest request)

Lists all the collection IDs underneath a document.

Parameter
Name	Description
`request`	`ListCollectionIdsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListCollectionIdsResponse>`

listDocuments(ListDocumentsRequest request)

public ListenableFuture<ListDocumentsResponse> listDocuments(ListDocumentsRequest request)

Lists documents.

Parameter
Name	Description
`request`	`ListDocumentsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListDocumentsResponse>`

partitionQuery(PartitionQueryRequest request)

public ListenableFuture<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
`com.google.common.util.concurrent.ListenableFuture<PartitionQueryResponse>`

rollback(RollbackRequest request)

public ListenableFuture<Empty> rollback(RollbackRequest request)

Rolls back a transaction.

Parameter
Name	Description
`request`	`RollbackRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

updateDocument(UpdateDocumentRequest request)

public ListenableFuture<Document> updateDocument(UpdateDocumentRequest request)

Updates or inserts a document.

Parameter
Name	Description
`request`	`UpdateDocumentRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Document>`