Class GrpcFirestoreAdminStub

public class GrpcFirestoreAdminStub extends FirestoreAdminStub

gRPC stub implementation for the FirestoreAdmin service API.

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

Inheritance

java.lang.Object > FirestoreAdminStub > GrpcFirestoreAdminStub

Constructors

GrpcFirestoreAdminStub(FirestoreAdminStubSettings settings, ClientContext clientContext)

protected GrpcFirestoreAdminStub(FirestoreAdminStubSettings settings, ClientContext clientContext)

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.

Parameters
NameDescription
settingsFirestoreAdminStubSettings
clientContextClientContext

GrpcFirestoreAdminStub(FirestoreAdminStubSettings settings, ClientContext clientContext, GrpcStubCallableFactory callableFactory)

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

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.

Parameters
NameDescription
settingsFirestoreAdminStubSettings
clientContextClientContext
callableFactoryGrpcStubCallableFactory

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()
Overrides

create(ClientContext clientContext)

public static final GrpcFirestoreAdminStub create(ClientContext clientContext)
Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
GrpcFirestoreAdminStub
Exceptions
TypeDescription
IOException

create(ClientContext clientContext, GrpcStubCallableFactory callableFactory)

public static final GrpcFirestoreAdminStub create(ClientContext clientContext, GrpcStubCallableFactory callableFactory)
Parameters
NameDescription
clientContextClientContext
callableFactoryGrpcStubCallableFactory
Returns
TypeDescription
GrpcFirestoreAdminStub
Exceptions
TypeDescription
IOException

create(FirestoreAdminStubSettings settings)

public static final GrpcFirestoreAdminStub create(FirestoreAdminStubSettings settings)
Parameter
NameDescription
settingsFirestoreAdminStubSettings
Returns
TypeDescription
GrpcFirestoreAdminStub
Exceptions
TypeDescription
IOException

createIndexCallable()

public UnaryCallable<CreateIndexRequest,Operation> createIndexCallable()
Returns
TypeDescription
UnaryCallable<CreateIndexRequest,Operation>
Overrides

createIndexOperationCallable()

public OperationCallable<CreateIndexRequest,Index,IndexOperationMetadata> createIndexOperationCallable()
Returns
TypeDescription
OperationCallable<CreateIndexRequest,Index,IndexOperationMetadata>
Overrides

deleteIndexCallable()

public UnaryCallable<DeleteIndexRequest,Empty> deleteIndexCallable()
Returns
TypeDescription
UnaryCallable<DeleteIndexRequest,Empty>
Overrides

exportDocumentsCallable()

public UnaryCallable<ExportDocumentsRequest,Operation> exportDocumentsCallable()
Returns
TypeDescription
UnaryCallable<ExportDocumentsRequest,Operation>
Overrides

exportDocumentsOperationCallable()

public OperationCallable<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata> exportDocumentsOperationCallable()
Returns
TypeDescription
OperationCallable<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata>
Overrides

getFieldCallable()

public UnaryCallable<GetFieldRequest,Field> getFieldCallable()
Returns
TypeDescription
UnaryCallable<GetFieldRequest,Field>
Overrides

getIndexCallable()

public UnaryCallable<GetIndexRequest,Index> getIndexCallable()
Returns
TypeDescription
UnaryCallable<GetIndexRequest,Index>
Overrides

getOperationsStub()

public GrpcOperationsStub getOperationsStub()
Returns
TypeDescription
GrpcOperationsStub
Overrides

importDocumentsCallable()

public UnaryCallable<ImportDocumentsRequest,Operation> importDocumentsCallable()
Returns
TypeDescription
UnaryCallable<ImportDocumentsRequest,Operation>
Overrides

importDocumentsOperationCallable()

public OperationCallable<ImportDocumentsRequest,Empty,ImportDocumentsMetadata> importDocumentsOperationCallable()
Returns
TypeDescription
OperationCallable<ImportDocumentsRequest,Empty,ImportDocumentsMetadata>
Overrides

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listFieldsCallable()

public UnaryCallable<ListFieldsRequest,ListFieldsResponse> listFieldsCallable()
Returns
TypeDescription
UnaryCallable<ListFieldsRequest,ListFieldsResponse>
Overrides

listFieldsPagedCallable()

public UnaryCallable<ListFieldsRequest,FirestoreAdminClient.ListFieldsPagedResponse> listFieldsPagedCallable()
Returns
TypeDescription
UnaryCallable<ListFieldsRequest,ListFieldsPagedResponse>
Overrides

listIndexesCallable()

public UnaryCallable<ListIndexesRequest,ListIndexesResponse> listIndexesCallable()
Returns
TypeDescription
UnaryCallable<ListIndexesRequest,ListIndexesResponse>
Overrides

listIndexesPagedCallable()

public UnaryCallable<ListIndexesRequest,FirestoreAdminClient.ListIndexesPagedResponse> listIndexesPagedCallable()
Returns
TypeDescription
UnaryCallable<ListIndexesRequest,ListIndexesPagedResponse>
Overrides

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateFieldCallable()

public UnaryCallable<UpdateFieldRequest,Operation> updateFieldCallable()
Returns
TypeDescription
UnaryCallable<UpdateFieldRequest,Operation>
Overrides

updateFieldOperationCallable()

public OperationCallable<UpdateFieldRequest,Field,FieldOperationMetadata> updateFieldOperationCallable()
Returns
TypeDescription
OperationCallable<UpdateFieldRequest,Field,FieldOperationMetadata>
Overrides