Class GrpcFirestoreAdminStub (3.22.0)

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

Inherited Members

FirestoreAdminStub.bulkDeleteDocumentsCallable()

FirestoreAdminStub.bulkDeleteDocumentsOperationCallable()

FirestoreAdminStub.close()

FirestoreAdminStub.createBackupScheduleCallable()

FirestoreAdminStub.createDatabaseCallable()

FirestoreAdminStub.createDatabaseOperationCallable()

FirestoreAdminStub.createIndexCallable()

FirestoreAdminStub.createIndexOperationCallable()

FirestoreAdminStub.deleteBackupCallable()

FirestoreAdminStub.deleteBackupScheduleCallable()

FirestoreAdminStub.deleteDatabaseCallable()

FirestoreAdminStub.deleteDatabaseOperationCallable()

FirestoreAdminStub.deleteIndexCallable()

FirestoreAdminStub.exportDocumentsCallable()

FirestoreAdminStub.exportDocumentsOperationCallable()

FirestoreAdminStub.getBackupCallable()

FirestoreAdminStub.getBackupScheduleCallable()

FirestoreAdminStub.getDatabaseCallable()

FirestoreAdminStub.getFieldCallable()

FirestoreAdminStub.getHttpJsonOperationsStub()

FirestoreAdminStub.getIndexCallable()

FirestoreAdminStub.getOperationsStub()

FirestoreAdminStub.importDocumentsCallable()

FirestoreAdminStub.importDocumentsOperationCallable()

FirestoreAdminStub.listBackupSchedulesCallable()

FirestoreAdminStub.listBackupsCallable()

FirestoreAdminStub.listDatabasesCallable()

FirestoreAdminStub.listFieldsCallable()

FirestoreAdminStub.listFieldsPagedCallable()

FirestoreAdminStub.listIndexesCallable()

FirestoreAdminStub.listIndexesPagedCallable()

FirestoreAdminStub.restoreDatabaseCallable()

FirestoreAdminStub.restoreDatabaseOperationCallable()

FirestoreAdminStub.updateBackupScheduleCallable()

FirestoreAdminStub.updateDatabaseCallable()

FirestoreAdminStub.updateDatabaseOperationCallable()

FirestoreAdminStub.updateFieldCallable()

FirestoreAdminStub.updateFieldOperationCallable()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(ClientContext clientContext)

public static final GrpcFirestoreAdminStub create(ClientContext clientContext)

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`GrpcFirestoreAdminStub`

Exceptions
Type	Description
`IOException`

create(ClientContext clientContext, GrpcStubCallableFactory callableFactory)

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

Parameters
Name	Description
`clientContext`	`ClientContext`
`callableFactory`	`GrpcStubCallableFactory`

Returns
Type	Description
`GrpcFirestoreAdminStub`

Exceptions
Type	Description
`IOException`

create(FirestoreAdminStubSettings settings)

public static final GrpcFirestoreAdminStub create(FirestoreAdminStubSettings settings)

Parameter
Name	Description
`settings`	`FirestoreAdminStubSettings`

Returns
Type	Description
`GrpcFirestoreAdminStub`

Exceptions
Type	Description
`IOException`

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

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

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

FirestoreAdminStub.bulkDeleteDocumentsCallable()

bulkDeleteDocumentsOperationCallable()

public OperationCallable<BulkDeleteDocumentsRequest,BulkDeleteDocumentsResponse,BulkDeleteDocumentsMetadata> bulkDeleteDocumentsOperationCallable()

Returns
Type	Description
`OperationCallable<BulkDeleteDocumentsRequest,BulkDeleteDocumentsResponse,BulkDeleteDocumentsMetadata>`

Overrides

FirestoreAdminStub.bulkDeleteDocumentsOperationCallable()

close()

public final void close()

Overrides

FirestoreAdminStub.close()

createBackupScheduleCallable()

public UnaryCallable<CreateBackupScheduleRequest,BackupSchedule> createBackupScheduleCallable()

Returns
Type	Description
`UnaryCallable<CreateBackupScheduleRequest,BackupSchedule>`

Overrides

FirestoreAdminStub.createBackupScheduleCallable()

createDatabaseCallable()

public UnaryCallable<CreateDatabaseRequest,Operation> createDatabaseCallable()

Returns
Type	Description
`UnaryCallable<CreateDatabaseRequest,Operation>`

Overrides

FirestoreAdminStub.createDatabaseCallable()

createDatabaseOperationCallable()

public OperationCallable<CreateDatabaseRequest,Database,CreateDatabaseMetadata> createDatabaseOperationCallable()

Returns
Type	Description
`OperationCallable<CreateDatabaseRequest,Database,CreateDatabaseMetadata>`

Overrides

FirestoreAdminStub.createDatabaseOperationCallable()

createIndexCallable()

public UnaryCallable<CreateIndexRequest,Operation> createIndexCallable()

Returns
Type	Description
`UnaryCallable<CreateIndexRequest,Operation>`

Overrides

FirestoreAdminStub.createIndexCallable()

createIndexOperationCallable()

public OperationCallable<CreateIndexRequest,Index,IndexOperationMetadata> createIndexOperationCallable()

Returns
Type	Description
`OperationCallable<CreateIndexRequest,Index,IndexOperationMetadata>`

Overrides

FirestoreAdminStub.createIndexOperationCallable()

deleteBackupCallable()

public UnaryCallable<DeleteBackupRequest,Empty> deleteBackupCallable()

Returns
Type	Description
`UnaryCallable<DeleteBackupRequest,Empty>`

Overrides

FirestoreAdminStub.deleteBackupCallable()

deleteBackupScheduleCallable()

public UnaryCallable<DeleteBackupScheduleRequest,Empty> deleteBackupScheduleCallable()

Returns
Type	Description
`UnaryCallable<DeleteBackupScheduleRequest,Empty>`

Overrides

FirestoreAdminStub.deleteBackupScheduleCallable()

deleteDatabaseCallable()

public UnaryCallable<DeleteDatabaseRequest,Operation> deleteDatabaseCallable()

Returns
Type	Description
`UnaryCallable<DeleteDatabaseRequest,Operation>`

Overrides

FirestoreAdminStub.deleteDatabaseCallable()

deleteDatabaseOperationCallable()

public OperationCallable<DeleteDatabaseRequest,Database,DeleteDatabaseMetadata> deleteDatabaseOperationCallable()

Returns
Type	Description
`OperationCallable<DeleteDatabaseRequest,Database,DeleteDatabaseMetadata>`

Overrides

FirestoreAdminStub.deleteDatabaseOperationCallable()

deleteIndexCallable()

public UnaryCallable<DeleteIndexRequest,Empty> deleteIndexCallable()

Returns
Type	Description
`UnaryCallable<DeleteIndexRequest,Empty>`

Overrides

FirestoreAdminStub.deleteIndexCallable()

exportDocumentsCallable()

public UnaryCallable<ExportDocumentsRequest,Operation> exportDocumentsCallable()

Returns
Type	Description
`UnaryCallable<ExportDocumentsRequest,Operation>`

Overrides

FirestoreAdminStub.exportDocumentsCallable()

exportDocumentsOperationCallable()

public OperationCallable<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata> exportDocumentsOperationCallable()

Returns
Type	Description
`OperationCallable<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata>`

Overrides

FirestoreAdminStub.exportDocumentsOperationCallable()

getBackupCallable()

public UnaryCallable<GetBackupRequest,Backup> getBackupCallable()

Returns
Type	Description
`UnaryCallable<GetBackupRequest,Backup>`

Overrides

FirestoreAdminStub.getBackupCallable()

getBackupScheduleCallable()

public UnaryCallable<GetBackupScheduleRequest,BackupSchedule> getBackupScheduleCallable()

Returns
Type	Description
`UnaryCallable<GetBackupScheduleRequest,BackupSchedule>`

Overrides

FirestoreAdminStub.getBackupScheduleCallable()

getDatabaseCallable()

public UnaryCallable<GetDatabaseRequest,Database> getDatabaseCallable()

Returns
Type	Description
`UnaryCallable<GetDatabaseRequest,Database>`

Overrides

FirestoreAdminStub.getDatabaseCallable()

getFieldCallable()

public UnaryCallable<GetFieldRequest,Field> getFieldCallable()

Returns
Type	Description
`UnaryCallable<GetFieldRequest,Field>`

Overrides

FirestoreAdminStub.getFieldCallable()

getIndexCallable()

public UnaryCallable<GetIndexRequest,Index> getIndexCallable()

Returns
Type	Description
`UnaryCallable<GetIndexRequest,Index>`

Overrides

FirestoreAdminStub.getIndexCallable()

getOperationsStub()

public GrpcOperationsStub getOperationsStub()

Returns
Type	Description
`GrpcOperationsStub`

Overrides

FirestoreAdminStub.getOperationsStub()

importDocumentsCallable()

public UnaryCallable<ImportDocumentsRequest,Operation> importDocumentsCallable()

Returns
Type	Description
`UnaryCallable<ImportDocumentsRequest,Operation>`

Overrides

FirestoreAdminStub.importDocumentsCallable()

importDocumentsOperationCallable()

public OperationCallable<ImportDocumentsRequest,Empty,ImportDocumentsMetadata> importDocumentsOperationCallable()

Returns
Type	Description
`OperationCallable<ImportDocumentsRequest,Empty,ImportDocumentsMetadata>`

Overrides

FirestoreAdminStub.importDocumentsOperationCallable()

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

FirestoreAdminStub.listBackupSchedulesCallable()

listBackupsCallable()

public UnaryCallable<ListBackupsRequest,ListBackupsResponse> listBackupsCallable()

Returns
Type	Description
`UnaryCallable<ListBackupsRequest,ListBackupsResponse>`

Overrides

FirestoreAdminStub.listBackupsCallable()

listDatabasesCallable()

public UnaryCallable<ListDatabasesRequest,ListDatabasesResponse> listDatabasesCallable()

Returns
Type	Description
`UnaryCallable<ListDatabasesRequest,ListDatabasesResponse>`

Overrides

FirestoreAdminStub.listDatabasesCallable()

listFieldsCallable()

public UnaryCallable<ListFieldsRequest,ListFieldsResponse> listFieldsCallable()

Returns
Type	Description
`UnaryCallable<ListFieldsRequest,ListFieldsResponse>`

Overrides

FirestoreAdminStub.listFieldsCallable()

listFieldsPagedCallable()

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

Returns
Type	Description
`UnaryCallable<ListFieldsRequest,ListFieldsPagedResponse>`

Overrides

FirestoreAdminStub.listFieldsPagedCallable()

listIndexesCallable()

public UnaryCallable<ListIndexesRequest,ListIndexesResponse> listIndexesCallable()

Returns
Type	Description
`UnaryCallable<ListIndexesRequest,ListIndexesResponse>`

Overrides

FirestoreAdminStub.listIndexesCallable()

listIndexesPagedCallable()

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

Returns
Type	Description
`UnaryCallable<ListIndexesRequest,ListIndexesPagedResponse>`

Overrides

FirestoreAdminStub.listIndexesPagedCallable()

restoreDatabaseCallable()

public UnaryCallable<RestoreDatabaseRequest,Operation> restoreDatabaseCallable()

Returns
Type	Description
`UnaryCallable<RestoreDatabaseRequest,Operation>`

Overrides

FirestoreAdminStub.restoreDatabaseCallable()

restoreDatabaseOperationCallable()

public OperationCallable<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata> restoreDatabaseOperationCallable()

Returns
Type	Description
`OperationCallable<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata>`

Overrides

FirestoreAdminStub.restoreDatabaseOperationCallable()

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateBackupScheduleCallable()

public UnaryCallable<UpdateBackupScheduleRequest,BackupSchedule> updateBackupScheduleCallable()

Returns
Type	Description
`UnaryCallable<UpdateBackupScheduleRequest,BackupSchedule>`

Overrides

FirestoreAdminStub.updateBackupScheduleCallable()

updateDatabaseCallable()

public UnaryCallable<UpdateDatabaseRequest,Operation> updateDatabaseCallable()

Returns
Type	Description
`UnaryCallable<UpdateDatabaseRequest,Operation>`

Overrides

FirestoreAdminStub.updateDatabaseCallable()

updateDatabaseOperationCallable()

public OperationCallable<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata> updateDatabaseOperationCallable()

Returns
Type	Description
`OperationCallable<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata>`

Overrides

FirestoreAdminStub.updateDatabaseOperationCallable()

updateFieldCallable()

public UnaryCallable<UpdateFieldRequest,Operation> updateFieldCallable()

Returns
Type	Description
`UnaryCallable<UpdateFieldRequest,Operation>`

Overrides

FirestoreAdminStub.updateFieldCallable()

updateFieldOperationCallable()

public OperationCallable<UpdateFieldRequest,Field,FieldOperationMetadata> updateFieldOperationCallable()

Returns
Type	Description
`OperationCallable<UpdateFieldRequest,Field,FieldOperationMetadata>`

Overrides

FirestoreAdminStub.updateFieldOperationCallable()