Class HttpJsonFirestoreAdminStub (3.22.0) 

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
Name Description
clientContext ClientContext
Returns
Type Description
HttpJsonFirestoreAdminStub
Exceptions
Type Description
IOException

create(ClientContext clientContext, HttpJsonStubCallableFactory callableFactory)

public static final HttpJsonFirestoreAdminStub create(ClientContext clientContext, HttpJsonStubCallableFactory callableFactory)
Parameters
Name Description
clientContext ClientContext
callableFactory HttpJsonStubCallableFactory
Returns
Type Description
HttpJsonFirestoreAdminStub
Exceptions
Type Description
IOException

create(FirestoreAdminStubSettings settings)

public static final HttpJsonFirestoreAdminStub create(FirestoreAdminStubSettings settings)
Parameter
Name Description
settings FirestoreAdminStubSettings
Returns
Type Description
HttpJsonFirestoreAdminStub
Exceptions
Type Description
IOException

getMethodDescriptors()

public static List<ApiMethodDescriptor> getMethodDescriptors()
Returns
Type Description
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
Name Description
settings FirestoreAdminStubSettings
clientContext ClientContext

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
Name Description
settings FirestoreAdminStubSettings
clientContext ClientContext
callableFactory HttpJsonStubCallableFactory

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

bulkDeleteDocumentsCallable()

public UnaryCallable<BulkDeleteDocumentsRequest,Operation> bulkDeleteDocumentsCallable()
Returns
Type Description
UnaryCallable<BulkDeleteDocumentsRequest,Operation>
Overrides

bulkDeleteDocumentsOperationCallable()

public OperationCallable<BulkDeleteDocumentsRequest,BulkDeleteDocumentsResponse,BulkDeleteDocumentsMetadata> bulkDeleteDocumentsOperationCallable()
Returns
Type Description
OperationCallable<BulkDeleteDocumentsRequest,BulkDeleteDocumentsResponse,BulkDeleteDocumentsMetadata>
Overrides

close()

public final void close()
Overrides

createBackupScheduleCallable()

public UnaryCallable<CreateBackupScheduleRequest,BackupSchedule> createBackupScheduleCallable()
Returns
Type Description
UnaryCallable<CreateBackupScheduleRequest,BackupSchedule>
Overrides

createDatabaseCallable()

public UnaryCallable<CreateDatabaseRequest,Operation> createDatabaseCallable()
Returns
Type Description
UnaryCallable<CreateDatabaseRequest,Operation>
Overrides

createDatabaseOperationCallable()

public OperationCallable<CreateDatabaseRequest,Database,CreateDatabaseMetadata> createDatabaseOperationCallable()
Returns
Type Description
OperationCallable<CreateDatabaseRequest,Database,CreateDatabaseMetadata>
Overrides

createIndexCallable()

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

createIndexOperationCallable()

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

deleteBackupCallable()

public UnaryCallable<DeleteBackupRequest,Empty> deleteBackupCallable()
Returns
Type Description
UnaryCallable<DeleteBackupRequest,Empty>
Overrides

deleteBackupScheduleCallable()

public UnaryCallable<DeleteBackupScheduleRequest,Empty> deleteBackupScheduleCallable()
Returns
Type Description
UnaryCallable<DeleteBackupScheduleRequest,Empty>
Overrides

deleteDatabaseCallable()

public UnaryCallable<DeleteDatabaseRequest,Operation> deleteDatabaseCallable()
Returns
Type Description
UnaryCallable<DeleteDatabaseRequest,Operation>
Overrides

deleteDatabaseOperationCallable()

public OperationCallable<DeleteDatabaseRequest,Database,DeleteDatabaseMetadata> deleteDatabaseOperationCallable()
Returns
Type Description
OperationCallable<DeleteDatabaseRequest,Database,DeleteDatabaseMetadata>
Overrides

deleteIndexCallable()

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

exportDocumentsCallable()

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

exportDocumentsOperationCallable()

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

getBackupCallable()

public UnaryCallable<GetBackupRequest,Backup> getBackupCallable()
Returns
Type Description
UnaryCallable<GetBackupRequest,Backup>
Overrides

getBackupScheduleCallable()

public UnaryCallable<GetBackupScheduleRequest,BackupSchedule> getBackupScheduleCallable()
Returns
Type Description
UnaryCallable<GetBackupScheduleRequest,BackupSchedule>
Overrides

getDatabaseCallable()

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

getFieldCallable()

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

getHttpJsonOperationsStub()

public HttpJsonOperationsStub getHttpJsonOperationsStub()
Returns
Type Description
HttpJsonOperationsStub
Overrides

getIndexCallable()

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

importDocumentsCallable()

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

importDocumentsOperationCallable()

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

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listBackupSchedulesCallable()

public UnaryCallable<ListBackupSchedulesRequest,ListBackupSchedulesResponse> listBackupSchedulesCallable()
Returns
Type Description
UnaryCallable<ListBackupSchedulesRequest,ListBackupSchedulesResponse>
Overrides

listBackupsCallable()

public UnaryCallable<ListBackupsRequest,ListBackupsResponse> listBackupsCallable()
Returns
Type Description
UnaryCallable<ListBackupsRequest,ListBackupsResponse>
Overrides

listDatabasesCallable()

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

listFieldsCallable()

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

listFieldsPagedCallable()

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

listIndexesCallable()

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

listIndexesPagedCallable()

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

restoreDatabaseCallable()

public UnaryCallable<RestoreDatabaseRequest,Operation> restoreDatabaseCallable()
Returns
Type Description
UnaryCallable<RestoreDatabaseRequest,Operation>
Overrides

restoreDatabaseOperationCallable()

public OperationCallable<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata> restoreDatabaseOperationCallable()
Returns
Type Description
OperationCallable<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata>
Overrides

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateBackupScheduleCallable()

public UnaryCallable<UpdateBackupScheduleRequest,BackupSchedule> updateBackupScheduleCallable()
Returns
Type Description
UnaryCallable<UpdateBackupScheduleRequest,BackupSchedule>
Overrides

updateDatabaseCallable()

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

updateDatabaseOperationCallable()

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

updateFieldCallable()

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

updateFieldOperationCallable()

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