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

Class GrpcFirestoreAdminStub

java.lang.Object

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

com.google.cloud.firestore.v1.stub.GrpcFirestoreAdminStub

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GrpcFirestoreAdminStub(FirestoreAdminStubSettings settings, com.google.api.gax.rpc.ClientContext clientContext)	Constructs an instance of GrpcFirestoreAdminStub, using the given settings.
protected	GrpcFirestoreAdminStub(FirestoreAdminStubSettings settings, com.google.api.gax.rpc.ClientContext clientContext, com.google.api.gax.grpc.GrpcStubCallableFactory callableFactory)	Constructs an instance of GrpcFirestoreAdminStub, using the given settings.

Method Summary

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

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

getHttpJsonOperationsStub

Methods inherited from class java.lang.Object

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

Constructor Details

GrpcFirestoreAdminStub

protected GrpcFirestoreAdminStub(FirestoreAdminStubSettings settings,
 com.google.api.gax.rpc.ClientContext clientContext)
                          throws IOException

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.

Throws:

IOException

GrpcFirestoreAdminStub

protected GrpcFirestoreAdminStub(FirestoreAdminStubSettings settings,
 com.google.api.gax.rpc.ClientContext clientContext,
 com.google.api.gax.grpc.GrpcStubCallableFactory callableFactory)
                          throws IOException

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.

Throws:

IOException

Method Details

create

public static final GrpcFirestoreAdminStub create(FirestoreAdminStubSettings settings)
                                           throws IOException

Throws:

IOException

create

public static final GrpcFirestoreAdminStub create(com.google.api.gax.rpc.ClientContext clientContext)
                                           throws IOException

Throws:

IOException

create

public static final GrpcFirestoreAdminStub create(com.google.api.gax.rpc.ClientContext clientContext,
 com.google.api.gax.grpc.GrpcStubCallableFactory callableFactory)
                                           throws IOException

Throws:

IOException

getOperationsStub

public com.google.longrunning.stub.GrpcOperationsStub getOperationsStub()

Overrides:

getOperationsStub in class FirestoreAdminStub

createIndexCallable

public com.google.api.gax.rpc.UnaryCallable<CreateIndexRequest,com.google.longrunning.Operation> createIndexCallable()

Overrides:

createIndexCallable in class FirestoreAdminStub

createIndexOperationCallable

public com.google.api.gax.rpc.OperationCallable<CreateIndexRequest,Index,IndexOperationMetadata> createIndexOperationCallable()

Overrides:

createIndexOperationCallable in class FirestoreAdminStub

listIndexesCallable

public com.google.api.gax.rpc.UnaryCallable<ListIndexesRequest,ListIndexesResponse> listIndexesCallable()

Overrides:

listIndexesCallable in class FirestoreAdminStub

listIndexesPagedCallable

public com.google.api.gax.rpc.UnaryCallable<ListIndexesRequest,FirestoreAdminClient.ListIndexesPagedResponse> listIndexesPagedCallable()

Overrides:

listIndexesPagedCallable in class FirestoreAdminStub

getIndexCallable

public com.google.api.gax.rpc.UnaryCallable<GetIndexRequest,Index> getIndexCallable()

Overrides:

getIndexCallable in class FirestoreAdminStub

deleteIndexCallable

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

Overrides:

deleteIndexCallable in class FirestoreAdminStub

getFieldCallable

public com.google.api.gax.rpc.UnaryCallable<GetFieldRequest,Field> getFieldCallable()

Overrides:

getFieldCallable in class FirestoreAdminStub

updateFieldCallable

public com.google.api.gax.rpc.UnaryCallable<UpdateFieldRequest,com.google.longrunning.Operation> updateFieldCallable()

Overrides:

updateFieldCallable in class FirestoreAdminStub

updateFieldOperationCallable

public com.google.api.gax.rpc.OperationCallable<UpdateFieldRequest,Field,FieldOperationMetadata> updateFieldOperationCallable()

Overrides:

updateFieldOperationCallable in class FirestoreAdminStub

listFieldsCallable

public com.google.api.gax.rpc.UnaryCallable<ListFieldsRequest,ListFieldsResponse> listFieldsCallable()

Overrides:

listFieldsCallable in class FirestoreAdminStub

listFieldsPagedCallable

public com.google.api.gax.rpc.UnaryCallable<ListFieldsRequest,FirestoreAdminClient.ListFieldsPagedResponse> listFieldsPagedCallable()

Overrides:

listFieldsPagedCallable in class FirestoreAdminStub

exportDocumentsCallable

public com.google.api.gax.rpc.UnaryCallable<ExportDocumentsRequest,com.google.longrunning.Operation> exportDocumentsCallable()

Overrides:

exportDocumentsCallable in class FirestoreAdminStub

exportDocumentsOperationCallable

public com.google.api.gax.rpc.OperationCallable<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata> exportDocumentsOperationCallable()

Overrides:

exportDocumentsOperationCallable in class FirestoreAdminStub

importDocumentsCallable

public com.google.api.gax.rpc.UnaryCallable<ImportDocumentsRequest,com.google.longrunning.Operation> importDocumentsCallable()

Overrides:

importDocumentsCallable in class FirestoreAdminStub

importDocumentsOperationCallable

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

Overrides:

importDocumentsOperationCallable in class FirestoreAdminStub

bulkDeleteDocumentsCallable

public com.google.api.gax.rpc.UnaryCallable<BulkDeleteDocumentsRequest,com.google.longrunning.Operation> bulkDeleteDocumentsCallable()

Overrides:

bulkDeleteDocumentsCallable in class FirestoreAdminStub

bulkDeleteDocumentsOperationCallable

public com.google.api.gax.rpc.OperationCallable<BulkDeleteDocumentsRequest,BulkDeleteDocumentsResponse,BulkDeleteDocumentsMetadata> bulkDeleteDocumentsOperationCallable()

Overrides:

bulkDeleteDocumentsOperationCallable in class FirestoreAdminStub

createDatabaseCallable

public com.google.api.gax.rpc.UnaryCallable<CreateDatabaseRequest,com.google.longrunning.Operation> createDatabaseCallable()

Overrides:

createDatabaseCallable in class FirestoreAdminStub

createDatabaseOperationCallable

public com.google.api.gax.rpc.OperationCallable<CreateDatabaseRequest,Database,CreateDatabaseMetadata> createDatabaseOperationCallable()

Overrides:

createDatabaseOperationCallable in class FirestoreAdminStub

getDatabaseCallable

public com.google.api.gax.rpc.UnaryCallable<GetDatabaseRequest,Database> getDatabaseCallable()

Overrides:

getDatabaseCallable in class FirestoreAdminStub

listDatabasesCallable

public com.google.api.gax.rpc.UnaryCallable<ListDatabasesRequest,ListDatabasesResponse> listDatabasesCallable()

Overrides:

listDatabasesCallable in class FirestoreAdminStub

updateDatabaseCallable

public com.google.api.gax.rpc.UnaryCallable<UpdateDatabaseRequest,com.google.longrunning.Operation> updateDatabaseCallable()

Overrides:

updateDatabaseCallable in class FirestoreAdminStub

updateDatabaseOperationCallable

public com.google.api.gax.rpc.OperationCallable<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata> updateDatabaseOperationCallable()

Overrides:

updateDatabaseOperationCallable in class FirestoreAdminStub

deleteDatabaseCallable

public com.google.api.gax.rpc.UnaryCallable<DeleteDatabaseRequest,com.google.longrunning.Operation> deleteDatabaseCallable()

Overrides:

deleteDatabaseCallable in class FirestoreAdminStub

deleteDatabaseOperationCallable

public com.google.api.gax.rpc.OperationCallable<DeleteDatabaseRequest,Database,DeleteDatabaseMetadata> deleteDatabaseOperationCallable()

Overrides:

deleteDatabaseOperationCallable in class FirestoreAdminStub

createUserCredsCallable

public com.google.api.gax.rpc.UnaryCallable<CreateUserCredsRequest,UserCreds> createUserCredsCallable()

Overrides:

createUserCredsCallable in class FirestoreAdminStub

getUserCredsCallable

public com.google.api.gax.rpc.UnaryCallable<GetUserCredsRequest,UserCreds> getUserCredsCallable()

Overrides:

getUserCredsCallable in class FirestoreAdminStub

listUserCredsCallable

public com.google.api.gax.rpc.UnaryCallable<ListUserCredsRequest,ListUserCredsResponse> listUserCredsCallable()

Overrides:

listUserCredsCallable in class FirestoreAdminStub

enableUserCredsCallable

public com.google.api.gax.rpc.UnaryCallable<EnableUserCredsRequest,UserCreds> enableUserCredsCallable()

Overrides:

enableUserCredsCallable in class FirestoreAdminStub

disableUserCredsCallable

public com.google.api.gax.rpc.UnaryCallable<DisableUserCredsRequest,UserCreds> disableUserCredsCallable()

Overrides:

disableUserCredsCallable in class FirestoreAdminStub

resetUserPasswordCallable

public com.google.api.gax.rpc.UnaryCallable<ResetUserPasswordRequest,UserCreds> resetUserPasswordCallable()

Overrides:

resetUserPasswordCallable in class FirestoreAdminStub

deleteUserCredsCallable

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

Overrides:

deleteUserCredsCallable in class FirestoreAdminStub

getBackupCallable

public com.google.api.gax.rpc.UnaryCallable<GetBackupRequest,Backup> getBackupCallable()

Overrides:

getBackupCallable in class FirestoreAdminStub

listBackupsCallable

public com.google.api.gax.rpc.UnaryCallable<ListBackupsRequest,ListBackupsResponse> listBackupsCallable()

Overrides:

listBackupsCallable in class FirestoreAdminStub

deleteBackupCallable

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

Overrides:

deleteBackupCallable in class FirestoreAdminStub

restoreDatabaseCallable

public com.google.api.gax.rpc.UnaryCallable<RestoreDatabaseRequest,com.google.longrunning.Operation> restoreDatabaseCallable()

Overrides:

restoreDatabaseCallable in class FirestoreAdminStub

restoreDatabaseOperationCallable

public com.google.api.gax.rpc.OperationCallable<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata> restoreDatabaseOperationCallable()

Overrides:

restoreDatabaseOperationCallable in class FirestoreAdminStub

createBackupScheduleCallable

public com.google.api.gax.rpc.UnaryCallable<CreateBackupScheduleRequest,BackupSchedule> createBackupScheduleCallable()

Overrides:

createBackupScheduleCallable in class FirestoreAdminStub

getBackupScheduleCallable

public com.google.api.gax.rpc.UnaryCallable<GetBackupScheduleRequest,BackupSchedule> getBackupScheduleCallable()

Overrides:

getBackupScheduleCallable in class FirestoreAdminStub

listBackupSchedulesCallable

public com.google.api.gax.rpc.UnaryCallable<ListBackupSchedulesRequest,ListBackupSchedulesResponse> listBackupSchedulesCallable()

Overrides:

listBackupSchedulesCallable in class FirestoreAdminStub

updateBackupScheduleCallable

public com.google.api.gax.rpc.UnaryCallable<UpdateBackupScheduleRequest,BackupSchedule> updateBackupScheduleCallable()

Overrides:

updateBackupScheduleCallable in class FirestoreAdminStub

deleteBackupScheduleCallable

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

Overrides:

deleteBackupScheduleCallable in class FirestoreAdminStub

cloneDatabaseCallable

public com.google.api.gax.rpc.UnaryCallable<CloneDatabaseRequest,com.google.longrunning.Operation> cloneDatabaseCallable()

Overrides:

cloneDatabaseCallable in class FirestoreAdminStub

cloneDatabaseOperationCallable

public com.google.api.gax.rpc.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