com.google.cloud.firestore.v1.stub

Class GrpcFirestoreStub

java.lang.Object

com.google.cloud.firestore.v1.stub.FirestoreStub

com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public class GrpcFirestoreStub
extends FirestoreStub

gRPC stub implementation for Google Cloud Firestore API.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GrpcFirestoreStub(FirestoreStubSettings settings, ClientContext clientContext) Constructs an instance of GrpcFirestoreStub, using the given settings.
protected	GrpcFirestoreStub(FirestoreStubSettings settings, ClientContext clientContext, GrpcStubCallableFactory callableFactory) Constructs an instance of GrpcFirestoreStub, using the given settings.

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
ServerStreamingCallable<com.google.firestore.v1.BatchGetDocumentsRequest,com.google.firestore.v1.BatchGetDocumentsResponse>	batchGetDocumentsCallable()
UnaryCallable<com.google.firestore.v1.BeginTransactionRequest,com.google.firestore.v1.BeginTransactionResponse>	beginTransactionCallable()
void	close()
UnaryCallable<com.google.firestore.v1.CommitRequest,com.google.firestore.v1.CommitResponse>	commitCallable()
static GrpcFirestoreStub	create(ClientContext clientContext)
static GrpcFirestoreStub	create(ClientContext clientContext, GrpcStubCallableFactory callableFactory)
static GrpcFirestoreStub	create(FirestoreStubSettings settings)
UnaryCallable<com.google.firestore.v1.CreateDocumentRequest,com.google.firestore.v1.Document>	createDocumentCallable()
UnaryCallable<com.google.firestore.v1.DeleteDocumentRequest,Empty>	deleteDocumentCallable()
UnaryCallable<com.google.firestore.v1.GetDocumentRequest,com.google.firestore.v1.Document>	getDocumentCallable()
boolean	isShutdown()
boolean	isTerminated()
UnaryCallable<com.google.firestore.v1.ListCollectionIdsRequest,com.google.firestore.v1.ListCollectionIdsResponse>	listCollectionIdsCallable()
UnaryCallable<com.google.firestore.v1.ListCollectionIdsRequest,FirestoreClient.ListCollectionIdsPagedResponse>	listCollectionIdsPagedCallable()
UnaryCallable<com.google.firestore.v1.ListDocumentsRequest,com.google.firestore.v1.ListDocumentsResponse>	listDocumentsCallable()
UnaryCallable<com.google.firestore.v1.ListDocumentsRequest,FirestoreClient.ListDocumentsPagedResponse>	listDocumentsPagedCallable()
BidiStreamingCallable<com.google.firestore.v1.ListenRequest,com.google.firestore.v1.ListenResponse>	listenCallable()
UnaryCallable<com.google.firestore.v1.RollbackRequest,Empty>	rollbackCallable()
ServerStreamingCallable<com.google.firestore.v1.RunQueryRequest,com.google.firestore.v1.RunQueryResponse>	runQueryCallable()
void	shutdown()
void	shutdownNow()
UnaryCallable<com.google.firestore.v1.UpdateDocumentRequest,com.google.firestore.v1.Document>	updateDocumentCallable()
BidiStreamingCallable<com.google.firestore.v1.WriteRequest,com.google.firestore.v1.WriteResponse>	writeCallable()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GrpcFirestoreStub

protected GrpcFirestoreStub(FirestoreStubSettings settings,
                            ClientContext clientContext)
                     throws IOException

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.

Throws:

IOException

GrpcFirestoreStub

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

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.

Throws:

IOException

Method Detail

create

public static final GrpcFirestoreStub create(FirestoreStubSettings settings)
                                      throws IOException

Throws:

IOException

create

public static final GrpcFirestoreStub create(ClientContext clientContext)
                                      throws IOException

Throws:

IOException

create

public static final GrpcFirestoreStub create(ClientContext clientContext,
                                             GrpcStubCallableFactory callableFactory)
                                      throws IOException

Throws:

IOException

getDocumentCallable

public UnaryCallable<com.google.firestore.v1.GetDocumentRequest,com.google.firestore.v1.Document> getDocumentCallable()

Overrides:

getDocumentCallable in class FirestoreStub

listDocumentsPagedCallable

public UnaryCallable<com.google.firestore.v1.ListDocumentsRequest,FirestoreClient.ListDocumentsPagedResponse> listDocumentsPagedCallable()

Overrides:

listDocumentsPagedCallable in class FirestoreStub

listDocumentsCallable

public UnaryCallable<com.google.firestore.v1.ListDocumentsRequest,com.google.firestore.v1.ListDocumentsResponse> listDocumentsCallable()

Overrides:

listDocumentsCallable in class FirestoreStub

createDocumentCallable

public UnaryCallable<com.google.firestore.v1.CreateDocumentRequest,com.google.firestore.v1.Document> createDocumentCallable()

Overrides:

createDocumentCallable in class FirestoreStub

updateDocumentCallable

public UnaryCallable<com.google.firestore.v1.UpdateDocumentRequest,com.google.firestore.v1.Document> updateDocumentCallable()

Overrides:

updateDocumentCallable in class FirestoreStub

deleteDocumentCallable

public UnaryCallable<com.google.firestore.v1.DeleteDocumentRequest,Empty> deleteDocumentCallable()

Overrides:

deleteDocumentCallable in class FirestoreStub

batchGetDocumentsCallable

public ServerStreamingCallable<com.google.firestore.v1.BatchGetDocumentsRequest,com.google.firestore.v1.BatchGetDocumentsResponse> batchGetDocumentsCallable()

Overrides:

batchGetDocumentsCallable in class FirestoreStub

beginTransactionCallable

public UnaryCallable<com.google.firestore.v1.BeginTransactionRequest,com.google.firestore.v1.BeginTransactionResponse> beginTransactionCallable()

Overrides:

beginTransactionCallable in class FirestoreStub

commitCallable

public UnaryCallable<com.google.firestore.v1.CommitRequest,com.google.firestore.v1.CommitResponse> commitCallable()

Overrides:

commitCallable in class FirestoreStub

rollbackCallable

public UnaryCallable<com.google.firestore.v1.RollbackRequest,Empty> rollbackCallable()

Overrides:

rollbackCallable in class FirestoreStub

runQueryCallable

public ServerStreamingCallable<com.google.firestore.v1.RunQueryRequest,com.google.firestore.v1.RunQueryResponse> runQueryCallable()

Overrides:

runQueryCallable in class FirestoreStub

writeCallable

public BidiStreamingCallable<com.google.firestore.v1.WriteRequest,com.google.firestore.v1.WriteResponse> writeCallable()

Overrides:

writeCallable in class FirestoreStub

listenCallable

public BidiStreamingCallable<com.google.firestore.v1.ListenRequest,com.google.firestore.v1.ListenResponse> listenCallable()

Overrides:

listenCallable in class FirestoreStub

listCollectionIdsPagedCallable

public UnaryCallable<com.google.firestore.v1.ListCollectionIdsRequest,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsPagedCallable()

Overrides:

listCollectionIdsPagedCallable in class FirestoreStub

listCollectionIdsCallable

public UnaryCallable<com.google.firestore.v1.ListCollectionIdsRequest,com.google.firestore.v1.ListCollectionIdsResponse> listCollectionIdsCallable()

Overrides:

listCollectionIdsCallable in class FirestoreStub

close

public final void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in class FirestoreStub

shutdown

public void shutdown()

isShutdown

public boolean isShutdown()

isTerminated

public boolean isTerminated()

shutdownNow

public void shutdownNow()

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Throws:

InterruptedException