public class HttpJsonFirestoreStub extends FirestoreStub
REST stub implementation for the Firestore service API.
This class is for advanced usage and reflects the underlying API directly.
Static Methods
create(ClientContext clientContext)
public static final HttpJsonFirestoreStub create(ClientContext clientContext)
Name | Description |
clientContext | ClientContext |
Type | Description |
HttpJsonFirestoreStub |
Type | Description |
IOException |
create(ClientContext clientContext, HttpJsonStubCallableFactory callableFactory)
public static final HttpJsonFirestoreStub create(ClientContext clientContext, HttpJsonStubCallableFactory callableFactory)
Name | Description |
clientContext | ClientContext |
callableFactory | HttpJsonStubCallableFactory |
Type | Description |
HttpJsonFirestoreStub |
Type | Description |
IOException |
create(FirestoreStubSettings settings)
public static final HttpJsonFirestoreStub create(FirestoreStubSettings settings)
Name | Description |
settings | FirestoreStubSettings |
Type | Description |
HttpJsonFirestoreStub |
Type | Description |
IOException |
getMethodDescriptors()
public static List<ApiMethodDescriptor> getMethodDescriptors()
Type | Description |
List<ApiMethodDescriptor> |
Constructors
HttpJsonFirestoreStub(FirestoreStubSettings settings, ClientContext clientContext)
protected HttpJsonFirestoreStub(FirestoreStubSettings settings, ClientContext clientContext)
Constructs an instance of HttpJsonFirestoreStub, 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.
Name | Description |
settings | FirestoreStubSettings |
clientContext | ClientContext |
HttpJsonFirestoreStub(FirestoreStubSettings settings, ClientContext clientContext, HttpJsonStubCallableFactory callableFactory)
protected HttpJsonFirestoreStub(FirestoreStubSettings settings, ClientContext clientContext, HttpJsonStubCallableFactory callableFactory)
Constructs an instance of HttpJsonFirestoreStub, 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.
Name | Description |
settings | FirestoreStubSettings |
clientContext | ClientContext |
callableFactory | HttpJsonStubCallableFactory |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
batchGetDocumentsCallable()
public ServerStreamingCallable<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsCallable()
Type | Description |
ServerStreamingCallable<BatchGetDocumentsRequest,BatchGetDocumentsResponse> |
batchWriteCallable()
public UnaryCallable<BatchWriteRequest,BatchWriteResponse> batchWriteCallable()
Type | Description |
UnaryCallable<BatchWriteRequest,BatchWriteResponse> |
beginTransactionCallable()
public UnaryCallable<BeginTransactionRequest,BeginTransactionResponse> beginTransactionCallable()
Type | Description |
UnaryCallable<BeginTransactionRequest,BeginTransactionResponse> |
close()
public final void close()
commitCallable()
public UnaryCallable<CommitRequest,CommitResponse> commitCallable()
Type | Description |
UnaryCallable<CommitRequest,CommitResponse> |
createDocumentCallable()
public UnaryCallable<CreateDocumentRequest,Document> createDocumentCallable()
Type | Description |
UnaryCallable<CreateDocumentRequest,Document> |
deleteDocumentCallable()
public UnaryCallable<DeleteDocumentRequest,Empty> deleteDocumentCallable()
Type | Description |
UnaryCallable<DeleteDocumentRequest,Empty> |
getDocumentCallable()
public UnaryCallable<GetDocumentRequest,Document> getDocumentCallable()
Type | Description |
UnaryCallable<GetDocumentRequest,Document> |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listCollectionIdsCallable()
public UnaryCallable<ListCollectionIdsRequest,ListCollectionIdsResponse> listCollectionIdsCallable()
Type | Description |
UnaryCallable<ListCollectionIdsRequest,ListCollectionIdsResponse> |
listCollectionIdsPagedCallable()
public UnaryCallable<ListCollectionIdsRequest,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsPagedCallable()
Type | Description |
UnaryCallable<ListCollectionIdsRequest,ListCollectionIdsPagedResponse> |
listDocumentsCallable()
public UnaryCallable<ListDocumentsRequest,ListDocumentsResponse> listDocumentsCallable()
Type | Description |
UnaryCallable<ListDocumentsRequest,ListDocumentsResponse> |
listDocumentsPagedCallable()
public UnaryCallable<ListDocumentsRequest,FirestoreClient.ListDocumentsPagedResponse> listDocumentsPagedCallable()
Type | Description |
UnaryCallable<ListDocumentsRequest,ListDocumentsPagedResponse> |
partitionQueryCallable()
public UnaryCallable<PartitionQueryRequest,PartitionQueryResponse> partitionQueryCallable()
Type | Description |
UnaryCallable<PartitionQueryRequest,PartitionQueryResponse> |
partitionQueryPagedCallable()
public UnaryCallable<PartitionQueryRequest,FirestoreClient.PartitionQueryPagedResponse> partitionQueryPagedCallable()
Type | Description |
UnaryCallable<PartitionQueryRequest,PartitionQueryPagedResponse> |
rollbackCallable()
public UnaryCallable<RollbackRequest,Empty> rollbackCallable()
Type | Description |
UnaryCallable<RollbackRequest,Empty> |
runAggregationQueryCallable()
public ServerStreamingCallable<RunAggregationQueryRequest,RunAggregationQueryResponse> runAggregationQueryCallable()
Type | Description |
ServerStreamingCallable<RunAggregationQueryRequest,RunAggregationQueryResponse> |
runQueryCallable()
public ServerStreamingCallable<RunQueryRequest,RunQueryResponse> runQueryCallable()
Type | Description |
ServerStreamingCallable<RunQueryRequest,RunQueryResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateDocumentCallable()
public UnaryCallable<UpdateDocumentRequest,Document> updateDocumentCallable()
Type | Description |
UnaryCallable<UpdateDocumentRequest,Document> |