Class HttpJsonFirestoreAdminStub (3.4.2)

Stay organized with collections Save and categorize content based on your preferences.
public class HttpJsonFirestoreAdminStub extends FirestoreAdminStub

REST stub implementation for the FirestoreAdmin service API.

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

Inheritance

java.lang.Object > FirestoreAdminStub > HttpJsonFirestoreAdminStub

Static Methods

create(ClientContext clientContext)

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

create(ClientContext clientContext, HttpJsonStubCallableFactory callableFactory)

public static final HttpJsonFirestoreAdminStub create(ClientContext clientContext, HttpJsonStubCallableFactory callableFactory)
Parameters
NameDescription
clientContextClientContext
callableFactoryHttpJsonStubCallableFactory
Returns
TypeDescription
HttpJsonFirestoreAdminStub
Exceptions
TypeDescription
IOException

create(FirestoreAdminStubSettings settings)

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

getMethodDescriptors()

public static List<ApiMethodDescriptor> getMethodDescriptors()
Returns
TypeDescription
List<ApiMethodDescriptor>

Constructors

HttpJsonFirestoreAdminStub(FirestoreAdminStubSettings settings, ClientContext clientContext)

protected HttpJsonFirestoreAdminStub(FirestoreAdminStubSettings settings, ClientContext clientContext)

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

HttpJsonFirestoreAdminStub(FirestoreAdminStubSettings settings, ClientContext clientContext, HttpJsonStubCallableFactory callableFactory)

protected HttpJsonFirestoreAdminStub(FirestoreAdminStubSettings settings, ClientContext clientContext, HttpJsonStubCallableFactory callableFactory)

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

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

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

getDatabaseCallable()

public UnaryCallable<GetDatabaseRequest,Database> getDatabaseCallable()
Returns
TypeDescription
UnaryCallable<GetDatabaseRequest,Database>
Overrides

getFieldCallable()

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

getHttpJsonOperationsStub()

public HttpJsonOperationsStub getHttpJsonOperationsStub()
Returns
TypeDescription
HttpJsonOperationsStub
Overrides

getIndexCallable()

public UnaryCallable<GetIndexRequest,Index> getIndexCallable()
Returns
TypeDescription
UnaryCallable<GetIndexRequest,Index>
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

listDatabasesCallable()

public UnaryCallable<ListDatabasesRequest,ListDatabasesResponse> listDatabasesCallable()
Returns
TypeDescription
UnaryCallable<ListDatabasesRequest,ListDatabasesResponse>
Overrides

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()

updateDatabaseCallable()

public UnaryCallable<UpdateDatabaseRequest,Operation> updateDatabaseCallable()
Returns
TypeDescription
UnaryCallable<UpdateDatabaseRequest,Operation>
Overrides

updateDatabaseOperationCallable()

public OperationCallable<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata> updateDatabaseOperationCallable()
Returns
TypeDescription
OperationCallable<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata>
Overrides

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