com.google.cloud.firestore.v1.stub

Class GrpcFirestoreAdminStub

java.lang.Object

com.google.cloud.firestore.v1.stub.FirestoreAdminStub

com.google.cloud.firestore.v1.stub.GrpcFirestoreAdminStub

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 GrpcFirestoreAdminStub
extends FirestoreAdminStub

gRPC stub implementation for Google Cloud Firestore Admin API.

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static GrpcFirestoreAdminStub	create(ClientContext clientContext)
static GrpcFirestoreAdminStub	create(ClientContext clientContext, GrpcStubCallableFactory callableFactory)
static GrpcFirestoreAdminStub	create(FirestoreAdminStubSettings settings)
UnaryCallable<com.google.firestore.admin.v1.CreateIndexRequest,Operation>	createIndexCallable()
UnaryCallable<com.google.firestore.admin.v1.DeleteIndexRequest,Empty>	deleteIndexCallable()
UnaryCallable<com.google.firestore.admin.v1.ExportDocumentsRequest,Operation>	exportDocumentsCallable()
UnaryCallable<com.google.firestore.admin.v1.GetFieldRequest,com.google.firestore.admin.v1.Field>	getFieldCallable()
UnaryCallable<com.google.firestore.admin.v1.GetIndexRequest,com.google.firestore.admin.v1.Index>	getIndexCallable()
UnaryCallable<com.google.firestore.admin.v1.ImportDocumentsRequest,Operation>	importDocumentsCallable()
boolean	isShutdown()
boolean	isTerminated()
UnaryCallable<com.google.firestore.admin.v1.ListFieldsRequest,com.google.firestore.admin.v1.ListFieldsResponse>	listFieldsCallable()
UnaryCallable<com.google.firestore.admin.v1.ListFieldsRequest,FirestoreAdminClient.ListFieldsPagedResponse>	listFieldsPagedCallable()
UnaryCallable<com.google.firestore.admin.v1.ListIndexesRequest,com.google.firestore.admin.v1.ListIndexesResponse>	listIndexesCallable()
UnaryCallable<com.google.firestore.admin.v1.ListIndexesRequest,FirestoreAdminClient.ListIndexesPagedResponse>	listIndexesPagedCallable()
void	shutdown()
void	shutdownNow()
UnaryCallable<com.google.firestore.admin.v1.UpdateFieldRequest,Operation>	updateFieldCallable()

Methods inherited from class java.lang.Object

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

Constructor Detail

GrpcFirestoreAdminStub

protected GrpcFirestoreAdminStub(FirestoreAdminStubSettings settings,
                                 ClientContext clientContext)
                          throws IOException

Constructs an instance of GrpcFirestoreAdminStub, 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

GrpcFirestoreAdminStub

protected GrpcFirestoreAdminStub(FirestoreAdminStubSettings settings,
                                 ClientContext clientContext,
                                 GrpcStubCallableFactory callableFactory)
                          throws IOException

Constructs an instance of GrpcFirestoreAdminStub, 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 GrpcFirestoreAdminStub create(FirestoreAdminStubSettings settings)
                                           throws IOException

Throws:

IOException

create

public static final GrpcFirestoreAdminStub create(ClientContext clientContext)
                                           throws IOException

Throws:

IOException

create

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

Throws:

IOException

createIndexCallable

public UnaryCallable<com.google.firestore.admin.v1.CreateIndexRequest,Operation> createIndexCallable()

Overrides:

createIndexCallable in class FirestoreAdminStub

listIndexesPagedCallable

public UnaryCallable<com.google.firestore.admin.v1.ListIndexesRequest,FirestoreAdminClient.ListIndexesPagedResponse> listIndexesPagedCallable()

Overrides:

listIndexesPagedCallable in class FirestoreAdminStub

listIndexesCallable

public UnaryCallable<com.google.firestore.admin.v1.ListIndexesRequest,com.google.firestore.admin.v1.ListIndexesResponse> listIndexesCallable()

Overrides:

listIndexesCallable in class FirestoreAdminStub

getIndexCallable

public UnaryCallable<com.google.firestore.admin.v1.GetIndexRequest,com.google.firestore.admin.v1.Index> getIndexCallable()

Overrides:

getIndexCallable in class FirestoreAdminStub

deleteIndexCallable

public UnaryCallable<com.google.firestore.admin.v1.DeleteIndexRequest,Empty> deleteIndexCallable()

Overrides:

deleteIndexCallable in class FirestoreAdminStub

importDocumentsCallable

public UnaryCallable<com.google.firestore.admin.v1.ImportDocumentsRequest,Operation> importDocumentsCallable()

Overrides:

importDocumentsCallable in class FirestoreAdminStub

exportDocumentsCallable

public UnaryCallable<com.google.firestore.admin.v1.ExportDocumentsRequest,Operation> exportDocumentsCallable()

Overrides:

exportDocumentsCallable in class FirestoreAdminStub

getFieldCallable

public UnaryCallable<com.google.firestore.admin.v1.GetFieldRequest,com.google.firestore.admin.v1.Field> getFieldCallable()

Overrides:

getFieldCallable in class FirestoreAdminStub

listFieldsPagedCallable

public UnaryCallable<com.google.firestore.admin.v1.ListFieldsRequest,FirestoreAdminClient.ListFieldsPagedResponse> listFieldsPagedCallable()

Overrides:

listFieldsPagedCallable in class FirestoreAdminStub

listFieldsCallable

public UnaryCallable<com.google.firestore.admin.v1.ListFieldsRequest,com.google.firestore.admin.v1.ListFieldsResponse> listFieldsCallable()

Overrides:

listFieldsCallable in class FirestoreAdminStub

updateFieldCallable

public UnaryCallable<com.google.firestore.admin.v1.UpdateFieldRequest,Operation> updateFieldCallable()

Overrides:

updateFieldCallable in class FirestoreAdminStub

close

public final void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in class FirestoreAdminStub

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