Some or all of the information on this page might not apply to Trusted Cloud by S3NS. See Differences from Google Cloud for more details.

Interface FirestoreRpc (3.8.2)

public interface FirestoreRpc extends AutoCloseable, ServiceRpc

Contains the RPC stubs used by the manual Cloud Firestore client.

Implements

AutoCloseable, com.google.cloud.ServiceRpc

Methods

batchGetDocumentsCallable()

public abstract ServerStreamingCallable<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsCallable()

Gets multiple documents.

Returns

Type	Description
`ServerStreamingCallable<BatchGetDocumentsRequest,BatchGetDocumentsResponse>`

batchWriteCallable()

public abstract UnaryCallable<BatchWriteRequest,BatchWriteResponse> batchWriteCallable()

Returns

Type	Description
`UnaryCallable<BatchWriteRequest,BatchWriteResponse>`

beginTransactionCallable()

public abstract UnaryCallable<BeginTransactionRequest,BeginTransactionResponse> beginTransactionCallable()

Starts a new transaction.

Returns

Type	Description
`UnaryCallable<BeginTransactionRequest,BeginTransactionResponse>`

commitCallable()

public abstract UnaryCallable<CommitRequest,CommitResponse> commitCallable()

Commits a transaction, while optionally updating documents.

Returns

Type	Description
`UnaryCallable<CommitRequest,CommitResponse>`

getExecutor()

public abstract ScheduledExecutorService getExecutor()

Returns the executor used by the GAPIC client.

Returns

Type	Description
`ScheduledExecutorService`

listCollectionIdsPagedCallable()

public abstract UnaryCallable<ListCollectionIdsRequest,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsPagedCallable()

Returns a list of collections IDs.

Returns

Type	Description
`UnaryCallable<ListCollectionIdsRequest,ListCollectionIdsPagedResponse>`

listDocumentsPagedCallable()

public abstract UnaryCallable<ListDocumentsRequest,FirestoreClient.ListDocumentsPagedResponse> listDocumentsPagedCallable()

Returns a list of documents.

Returns

Type	Description
`UnaryCallable<ListDocumentsRequest,ListDocumentsPagedResponse>`

listenCallable()

public abstract BidiStreamingCallable<ListenRequest,ListenResponse> listenCallable()

Returns a bi-directional watch stream.

Returns

Type	Description
`BidiStreamingCallable<ListenRequest,ListenResponse>`

partitionQueryPagedCallable()

public abstract UnaryCallable<PartitionQueryRequest,FirestoreClient.PartitionQueryPagedResponse> partitionQueryPagedCallable()

Returns

Type	Description
`UnaryCallable<PartitionQueryRequest,PartitionQueryPagedResponse>`

rollbackCallable()

public abstract UnaryCallable<RollbackRequest,Empty> rollbackCallable()

Rolls back a transaction.

Returns

Type	Description
`UnaryCallable<RollbackRequest,Empty>`

runAggregationQueryCallable()

public abstract ServerStreamingCallable<RunAggregationQueryRequest,RunAggregationQueryResponse> runAggregationQueryCallable()

Runs an aggregation query.

Returns

Type	Description
`ServerStreamingCallable<RunAggregationQueryRequest,RunAggregationQueryResponse>`

runQueryCallable()

public abstract ServerStreamingCallable<RunQueryRequest,RunQueryResponse> runQueryCallable()

Runs a query.

Returns

Type	Description
`ServerStreamingCallable<RunQueryRequest,RunQueryResponse>`

shutdown()

public abstract void shutdown()

shutdownNow()

public abstract void shutdownNow()