Package com.google.cloud.firestore.v1.stub

Class HttpJsonFirestoreAdminStub

java.lang.Object

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

com.google.cloud.firestore.v1.stub.HttpJsonFirestoreAdminStub

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated("by gapic-generator-java")
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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, TimeUnit unit)
UnaryCallable<BulkDeleteDocumentsRequest,Operation>	bulkDeleteDocumentsCallable()
OperationCallable<BulkDeleteDocumentsRequest,BulkDeleteDocumentsResponse,BulkDeleteDocumentsMetadata>	bulkDeleteDocumentsOperationCallable()
UnaryCallable<CloneDatabaseRequest,Operation>	cloneDatabaseCallable()
OperationCallable<CloneDatabaseRequest,Database,CloneDatabaseMetadata>	cloneDatabaseOperationCallable()
final void	close()
static final HttpJsonFirestoreAdminStub	create(ClientContext clientContext)
static final HttpJsonFirestoreAdminStub	create(ClientContext clientContext, HttpJsonStubCallableFactory callableFactory)
static final HttpJsonFirestoreAdminStub	create(FirestoreAdminStubSettings settings)
UnaryCallable<CreateBackupScheduleRequest,BackupSchedule>	createBackupScheduleCallable()
UnaryCallable<CreateDatabaseRequest,Operation>	createDatabaseCallable()
OperationCallable<CreateDatabaseRequest,Database,CreateDatabaseMetadata>	createDatabaseOperationCallable()
UnaryCallable<CreateIndexRequest,Operation>	createIndexCallable()
OperationCallable<CreateIndexRequest,Index,IndexOperationMetadata>	createIndexOperationCallable()
UnaryCallable<CreateUserCredsRequest,UserCreds>	createUserCredsCallable()
UnaryCallable<DeleteBackupRequest,com.google.protobuf.Empty>	deleteBackupCallable()
UnaryCallable<DeleteBackupScheduleRequest,com.google.protobuf.Empty>	deleteBackupScheduleCallable()
UnaryCallable<DeleteDatabaseRequest,Operation>	deleteDatabaseCallable()
OperationCallable<DeleteDatabaseRequest,Database,DeleteDatabaseMetadata>	deleteDatabaseOperationCallable()
UnaryCallable<DeleteIndexRequest,com.google.protobuf.Empty>	deleteIndexCallable()
UnaryCallable<DeleteUserCredsRequest,com.google.protobuf.Empty>	deleteUserCredsCallable()
UnaryCallable<DisableUserCredsRequest,UserCreds>	disableUserCredsCallable()
UnaryCallable<EnableUserCredsRequest,UserCreds>	enableUserCredsCallable()
UnaryCallable<ExportDocumentsRequest,Operation>	exportDocumentsCallable()
OperationCallable<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata>	exportDocumentsOperationCallable()
UnaryCallable<GetBackupRequest,Backup>	getBackupCallable()
UnaryCallable<GetBackupScheduleRequest,BackupSchedule>	getBackupScheduleCallable()
UnaryCallable<GetDatabaseRequest,Database>	getDatabaseCallable()
UnaryCallable<GetFieldRequest,Field>	getFieldCallable()
HttpJsonOperationsStub	getHttpJsonOperationsStub()
UnaryCallable<GetIndexRequest,Index>	getIndexCallable()
static List<ApiMethodDescriptor>	getMethodDescriptors()
UnaryCallable<GetUserCredsRequest,UserCreds>	getUserCredsCallable()
UnaryCallable<ImportDocumentsRequest,Operation>	importDocumentsCallable()
OperationCallable<ImportDocumentsRequest,com.google.protobuf.Empty,ImportDocumentsMetadata>	importDocumentsOperationCallable()
boolean	isShutdown()
boolean	isTerminated()
UnaryCallable<ListBackupsRequest,ListBackupsResponse>	listBackupsCallable()
UnaryCallable<ListBackupSchedulesRequest,ListBackupSchedulesResponse>	listBackupSchedulesCallable()
UnaryCallable<ListDatabasesRequest,ListDatabasesResponse>	listDatabasesCallable()
UnaryCallable<ListFieldsRequest,ListFieldsResponse>	listFieldsCallable()
UnaryCallable<ListFieldsRequest,FirestoreAdminClient.ListFieldsPagedResponse>	listFieldsPagedCallable()
UnaryCallable<ListIndexesRequest,ListIndexesResponse>	listIndexesCallable()
UnaryCallable<ListIndexesRequest,FirestoreAdminClient.ListIndexesPagedResponse>	listIndexesPagedCallable()
UnaryCallable<ListUserCredsRequest,ListUserCredsResponse>	listUserCredsCallable()
UnaryCallable<ResetUserPasswordRequest,UserCreds>	resetUserPasswordCallable()
UnaryCallable<RestoreDatabaseRequest,Operation>	restoreDatabaseCallable()
OperationCallable<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata>	restoreDatabaseOperationCallable()
void	shutdown()
void	shutdownNow()
UnaryCallable<UpdateBackupScheduleRequest,BackupSchedule>	updateBackupScheduleCallable()
UnaryCallable<UpdateDatabaseRequest,Operation>	updateDatabaseCallable()
OperationCallable<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata>	updateDatabaseOperationCallable()
UnaryCallable<UpdateFieldRequest,Operation>	updateFieldCallable()
OperationCallable<UpdateFieldRequest,Field,FieldOperationMetadata>	updateFieldOperationCallable()

Methods inherited from class com.google.cloud.firestore.v1.stub.FirestoreAdminStub

getOperationsStub

Methods inherited from class java.lang.Object

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

Constructor Details

HttpJsonFirestoreAdminStub

protected HttpJsonFirestoreAdminStub(FirestoreAdminStubSettings settings,
 ClientContext clientContext)
                              throws IOException

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.

Throws:

IOException

HttpJsonFirestoreAdminStub

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

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.

Throws:

IOException

Method Details

create

public static final HttpJsonFirestoreAdminStub create(FirestoreAdminStubSettings settings)
                                               throws IOException

Throws:

IOException

create

public static final HttpJsonFirestoreAdminStub create(ClientContext clientContext)
                                               throws IOException

Throws:

IOException

create

public static final HttpJsonFirestoreAdminStub create(ClientContext clientContext,
 HttpJsonStubCallableFactory callableFactory)
                                               throws IOException

Throws:

IOException

getMethodDescriptors

@InternalApi
public static List<ApiMethodDescriptor> getMethodDescriptors()

getHttpJsonOperationsStub

public HttpJsonOperationsStub getHttpJsonOperationsStub()

Overrides:

getHttpJsonOperationsStub in class FirestoreAdminStub

createIndexCallable

public UnaryCallable<CreateIndexRequest,Operation> createIndexCallable()

Overrides:

createIndexCallable in class FirestoreAdminStub

createIndexOperationCallable

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

Overrides:

createIndexOperationCallable in class FirestoreAdminStub

listIndexesCallable

public UnaryCallable<ListIndexesRequest,ListIndexesResponse> listIndexesCallable()

Overrides:

listIndexesCallable in class FirestoreAdminStub

listIndexesPagedCallable

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

Overrides:

listIndexesPagedCallable in class FirestoreAdminStub

getIndexCallable

public UnaryCallable<GetIndexRequest,Index> getIndexCallable()

Overrides:

getIndexCallable in class FirestoreAdminStub

deleteIndexCallable

public UnaryCallable<DeleteIndexRequest,com.google.protobuf.Empty> deleteIndexCallable()

Overrides:

deleteIndexCallable in class FirestoreAdminStub

getFieldCallable

public UnaryCallable<GetFieldRequest,Field> getFieldCallable()

Overrides:

getFieldCallable in class FirestoreAdminStub

updateFieldCallable

public UnaryCallable<UpdateFieldRequest,Operation> updateFieldCallable()

Overrides:

updateFieldCallable in class FirestoreAdminStub

updateFieldOperationCallable

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

Overrides:

updateFieldOperationCallable in class FirestoreAdminStub

listFieldsCallable

public UnaryCallable<ListFieldsRequest,ListFieldsResponse> listFieldsCallable()

Overrides:

listFieldsCallable in class FirestoreAdminStub

listFieldsPagedCallable

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

Overrides:

listFieldsPagedCallable in class FirestoreAdminStub

exportDocumentsCallable

public UnaryCallable<ExportDocumentsRequest,Operation> exportDocumentsCallable()

Overrides:

exportDocumentsCallable in class FirestoreAdminStub

exportDocumentsOperationCallable

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

Overrides:

exportDocumentsOperationCallable in class FirestoreAdminStub

importDocumentsCallable

public UnaryCallable<ImportDocumentsRequest,Operation> importDocumentsCallable()

Overrides:

importDocumentsCallable in class FirestoreAdminStub

importDocumentsOperationCallable

public OperationCallable<ImportDocumentsRequest,com.google.protobuf.Empty,ImportDocumentsMetadata> importDocumentsOperationCallable()

Overrides:

importDocumentsOperationCallable in class FirestoreAdminStub

bulkDeleteDocumentsCallable

public UnaryCallable<BulkDeleteDocumentsRequest,Operation> bulkDeleteDocumentsCallable()

Overrides:

bulkDeleteDocumentsCallable in class FirestoreAdminStub

bulkDeleteDocumentsOperationCallable

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

Overrides:

bulkDeleteDocumentsOperationCallable in class FirestoreAdminStub

createDatabaseCallable

public UnaryCallable<CreateDatabaseRequest,Operation> createDatabaseCallable()

Overrides:

createDatabaseCallable in class FirestoreAdminStub

createDatabaseOperationCallable

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

Overrides:

createDatabaseOperationCallable in class FirestoreAdminStub

getDatabaseCallable

public UnaryCallable<GetDatabaseRequest,Database> getDatabaseCallable()

Overrides:

getDatabaseCallable in class FirestoreAdminStub

listDatabasesCallable

public UnaryCallable<ListDatabasesRequest,ListDatabasesResponse> listDatabasesCallable()

Overrides:

listDatabasesCallable in class FirestoreAdminStub

updateDatabaseCallable

public UnaryCallable<UpdateDatabaseRequest,Operation> updateDatabaseCallable()

Overrides:

updateDatabaseCallable in class FirestoreAdminStub

updateDatabaseOperationCallable

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

Overrides:

updateDatabaseOperationCallable in class FirestoreAdminStub

deleteDatabaseCallable

public UnaryCallable<DeleteDatabaseRequest,Operation> deleteDatabaseCallable()

Overrides:

deleteDatabaseCallable in class FirestoreAdminStub

deleteDatabaseOperationCallable

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

Overrides:

deleteDatabaseOperationCallable in class FirestoreAdminStub

createUserCredsCallable

public UnaryCallable<CreateUserCredsRequest,UserCreds> createUserCredsCallable()

Overrides:

createUserCredsCallable in class FirestoreAdminStub

getUserCredsCallable

public UnaryCallable<GetUserCredsRequest,UserCreds> getUserCredsCallable()

Overrides:

getUserCredsCallable in class FirestoreAdminStub

listUserCredsCallable

public UnaryCallable<ListUserCredsRequest,ListUserCredsResponse> listUserCredsCallable()

Overrides:

listUserCredsCallable in class FirestoreAdminStub

enableUserCredsCallable

public UnaryCallable<EnableUserCredsRequest,UserCreds> enableUserCredsCallable()

Overrides:

enableUserCredsCallable in class FirestoreAdminStub

disableUserCredsCallable

public UnaryCallable<DisableUserCredsRequest,UserCreds> disableUserCredsCallable()

Overrides:

disableUserCredsCallable in class FirestoreAdminStub

resetUserPasswordCallable

public UnaryCallable<ResetUserPasswordRequest,UserCreds> resetUserPasswordCallable()

Overrides:

resetUserPasswordCallable in class FirestoreAdminStub

deleteUserCredsCallable

public UnaryCallable<DeleteUserCredsRequest,com.google.protobuf.Empty> deleteUserCredsCallable()

Overrides:

deleteUserCredsCallable in class FirestoreAdminStub

getBackupCallable

public UnaryCallable<GetBackupRequest,Backup> getBackupCallable()

Overrides:

getBackupCallable in class FirestoreAdminStub

listBackupsCallable

public UnaryCallable<ListBackupsRequest,ListBackupsResponse> listBackupsCallable()

Overrides:

listBackupsCallable in class FirestoreAdminStub

deleteBackupCallable

public UnaryCallable<DeleteBackupRequest,com.google.protobuf.Empty> deleteBackupCallable()

Overrides:

deleteBackupCallable in class FirestoreAdminStub

restoreDatabaseCallable

public UnaryCallable<RestoreDatabaseRequest,Operation> restoreDatabaseCallable()

Overrides:

restoreDatabaseCallable in class FirestoreAdminStub

restoreDatabaseOperationCallable

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

Overrides:

restoreDatabaseOperationCallable in class FirestoreAdminStub

createBackupScheduleCallable

public UnaryCallable<CreateBackupScheduleRequest,BackupSchedule> createBackupScheduleCallable()

Overrides:

createBackupScheduleCallable in class FirestoreAdminStub

getBackupScheduleCallable

public UnaryCallable<GetBackupScheduleRequest,BackupSchedule> getBackupScheduleCallable()

Overrides:

getBackupScheduleCallable in class FirestoreAdminStub

listBackupSchedulesCallable

public UnaryCallable<ListBackupSchedulesRequest,ListBackupSchedulesResponse> listBackupSchedulesCallable()

Overrides:

listBackupSchedulesCallable in class FirestoreAdminStub

updateBackupScheduleCallable

public UnaryCallable<UpdateBackupScheduleRequest,BackupSchedule> updateBackupScheduleCallable()

Overrides:

updateBackupScheduleCallable in class FirestoreAdminStub

deleteBackupScheduleCallable

public UnaryCallable<DeleteBackupScheduleRequest,com.google.protobuf.Empty> deleteBackupScheduleCallable()

Overrides:

deleteBackupScheduleCallable in class FirestoreAdminStub

cloneDatabaseCallable

public UnaryCallable<CloneDatabaseRequest,Operation> cloneDatabaseCallable()

Overrides:

cloneDatabaseCallable in class FirestoreAdminStub

cloneDatabaseOperationCallable

public OperationCallable<CloneDatabaseRequest,Database,CloneDatabaseMetadata> cloneDatabaseOperationCallable()

Overrides:

cloneDatabaseOperationCallable 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