Class GrpcFirestoreStub (3.30.2)

public class GrpcFirestoreStub extends FirestoreStub

gRPC stub implementation for the Firestore service API.

This class is for advanced usage and reflects the underlying API directly.

Inheritance

java.lang.Object > FirestoreStub > GrpcFirestoreStub

Static Methods

create(ClientContext clientContext)

public static final GrpcFirestoreStub create(ClientContext clientContext)
Parameter
Name Description
clientContext ClientContext
Returns
Type Description
GrpcFirestoreStub
Exceptions
Type Description
IOException

create(ClientContext clientContext, GrpcStubCallableFactory callableFactory)

public static final GrpcFirestoreStub create(ClientContext clientContext, GrpcStubCallableFactory callableFactory)
Parameters
Name Description
clientContext ClientContext
callableFactory GrpcStubCallableFactory
Returns
Type Description
GrpcFirestoreStub
Exceptions
Type Description
IOException

create(FirestoreStubSettings settings)

public static final GrpcFirestoreStub create(FirestoreStubSettings settings)
Parameter
Name Description
settings FirestoreStubSettings
Returns
Type Description
GrpcFirestoreStub
Exceptions
Type Description
IOException

Constructors

GrpcFirestoreStub(FirestoreStubSettings settings, ClientContext clientContext)

protected GrpcFirestoreStub(FirestoreStubSettings settings, ClientContext clientContext)

Constructs an instance of GrpcFirestoreStub, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameters
Name Description
settings FirestoreStubSettings
clientContext ClientContext

GrpcFirestoreStub(FirestoreStubSettings settings, ClientContext clientContext, GrpcStubCallableFactory callableFactory)

protected GrpcFirestoreStub(FirestoreStubSettings settings, ClientContext clientContext, GrpcStubCallableFactory callableFactory)

Constructs an instance of GrpcFirestoreStub, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameters
Name Description
settings FirestoreStubSettings
clientContext ClientContext
callableFactory GrpcStubCallableFactory

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

batchGetDocumentsCallable()

public ServerStreamingCallable<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsCallable()
Returns
Type Description
ServerStreamingCallable<BatchGetDocumentsRequest,BatchGetDocumentsResponse>
Overrides

batchWriteCallable()

public UnaryCallable<BatchWriteRequest,BatchWriteResponse> batchWriteCallable()
Returns
Type Description
UnaryCallable<BatchWriteRequest,BatchWriteResponse>
Overrides

beginTransactionCallable()

public UnaryCallable<BeginTransactionRequest,BeginTransactionResponse> beginTransactionCallable()
Returns
Type Description
UnaryCallable<BeginTransactionRequest,BeginTransactionResponse>
Overrides

close()

public final void close()
Overrides

commitCallable()

public UnaryCallable<CommitRequest,CommitResponse> commitCallable()
Returns
Type Description
UnaryCallable<CommitRequest,CommitResponse>
Overrides

createDocumentCallable()

public UnaryCallable<CreateDocumentRequest,Document> createDocumentCallable()
Returns
Type Description
UnaryCallable<CreateDocumentRequest,Document>
Overrides

deleteDocumentCallable()

public UnaryCallable<DeleteDocumentRequest,Empty> deleteDocumentCallable()
Returns
Type Description
UnaryCallable<DeleteDocumentRequest,Empty>
Overrides

getDocumentCallable()

public UnaryCallable<GetDocumentRequest,Document> getDocumentCallable()
Returns
Type Description
UnaryCallable<GetDocumentRequest,Document>
Overrides

getOperationsStub()

public GrpcOperationsStub getOperationsStub()
Returns
Type Description
GrpcOperationsStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listCollectionIdsCallable()

public UnaryCallable<ListCollectionIdsRequest,ListCollectionIdsResponse> listCollectionIdsCallable()
Returns
Type Description
UnaryCallable<ListCollectionIdsRequest,ListCollectionIdsResponse>
Overrides

listCollectionIdsPagedCallable()

public UnaryCallable<ListCollectionIdsRequest,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsPagedCallable()
Returns
Type Description
UnaryCallable<ListCollectionIdsRequest,ListCollectionIdsPagedResponse>
Overrides

listDocumentsCallable()

public UnaryCallable<ListDocumentsRequest,ListDocumentsResponse> listDocumentsCallable()
Returns
Type Description
UnaryCallable<ListDocumentsRequest,ListDocumentsResponse>
Overrides

listDocumentsPagedCallable()

public UnaryCallable<ListDocumentsRequest,FirestoreClient.ListDocumentsPagedResponse> listDocumentsPagedCallable()
Returns
Type Description
UnaryCallable<ListDocumentsRequest,ListDocumentsPagedResponse>
Overrides

listenCallable()

public BidiStreamingCallable<ListenRequest,ListenResponse> listenCallable()
Returns
Type Description
BidiStreamingCallable<ListenRequest,ListenResponse>
Overrides

partitionQueryCallable()

public UnaryCallable<PartitionQueryRequest,PartitionQueryResponse> partitionQueryCallable()
Returns
Type Description
UnaryCallable<PartitionQueryRequest,PartitionQueryResponse>
Overrides

partitionQueryPagedCallable()

public UnaryCallable<PartitionQueryRequest,FirestoreClient.PartitionQueryPagedResponse> partitionQueryPagedCallable()
Returns
Type Description
UnaryCallable<PartitionQueryRequest,PartitionQueryPagedResponse>
Overrides

rollbackCallable()

public UnaryCallable<RollbackRequest,Empty> rollbackCallable()
Returns
Type Description
UnaryCallable<RollbackRequest,Empty>
Overrides

runAggregationQueryCallable()

public ServerStreamingCallable<RunAggregationQueryRequest,RunAggregationQueryResponse> runAggregationQueryCallable()
Returns
Type Description
ServerStreamingCallable<RunAggregationQueryRequest,RunAggregationQueryResponse>
Overrides

runQueryCallable()

public ServerStreamingCallable<RunQueryRequest,RunQueryResponse> runQueryCallable()
Returns
Type Description
ServerStreamingCallable<RunQueryRequest,RunQueryResponse>
Overrides

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateDocumentCallable()

public UnaryCallable<UpdateDocumentRequest,Document> updateDocumentCallable()
Returns
Type Description
UnaryCallable<UpdateDocumentRequest,Document>
Overrides

writeCallable()

public BidiStreamingCallable<WriteRequest,WriteResponse> writeCallable()
Returns
Type Description
BidiStreamingCallable<WriteRequest,WriteResponse>
Overrides