Package com.google.cloud.firestore.v1

Class FirestoreAdminSettings.Builder

java.lang.Object

com.google.api.gax.rpc.ClientSettings.Builder<FirestoreAdminSettings,FirestoreAdminSettings.Builder>

com.google.cloud.firestore.v1.FirestoreAdminSettings.Builder

Enclosing class:

FirestoreAdminSettings

public static class FirestoreAdminSettings.Builder
extends ClientSettings.Builder<FirestoreAdminSettings,FirestoreAdminSettings.Builder>

Builder for FirestoreAdminSettings.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()
protected	Builder(ClientContext clientContext)
protected	Builder(FirestoreAdminSettings settings)
protected	Builder(FirestoreAdminStubSettings.Builder stubSettings)

Method Summary

Modifier and Type	Method	Description
FirestoreAdminSettings.Builder	applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)	Applies the given settings updater function to all of the unary API methods in this service.
FirestoreAdminSettings	build()
OperationCallSettings.Builder<BulkDeleteDocumentsRequest,BulkDeleteDocumentsResponse,BulkDeleteDocumentsMetadata>	bulkDeleteDocumentsOperationSettings()	Returns the builder for the settings used for calls to bulkDeleteDocuments.
UnaryCallSettings.Builder<BulkDeleteDocumentsRequest,Operation>	bulkDeleteDocumentsSettings()	Returns the builder for the settings used for calls to bulkDeleteDocuments.
OperationCallSettings.Builder<CloneDatabaseRequest,Database,CloneDatabaseMetadata>	cloneDatabaseOperationSettings()	Returns the builder for the settings used for calls to cloneDatabase.
UnaryCallSettings.Builder<CloneDatabaseRequest,Operation>	cloneDatabaseSettings()	Returns the builder for the settings used for calls to cloneDatabase.
UnaryCallSettings.Builder<CreateBackupScheduleRequest,BackupSchedule>	createBackupScheduleSettings()	Returns the builder for the settings used for calls to createBackupSchedule.
OperationCallSettings.Builder<CreateDatabaseRequest,Database,CreateDatabaseMetadata>	createDatabaseOperationSettings()	Returns the builder for the settings used for calls to createDatabase.
UnaryCallSettings.Builder<CreateDatabaseRequest,Operation>	createDatabaseSettings()	Returns the builder for the settings used for calls to createDatabase.
OperationCallSettings.Builder<CreateIndexRequest,Index,IndexOperationMetadata>	createIndexOperationSettings()	Returns the builder for the settings used for calls to createIndex.
UnaryCallSettings.Builder<CreateIndexRequest,Operation>	createIndexSettings()	Returns the builder for the settings used for calls to createIndex.
UnaryCallSettings.Builder<CreateUserCredsRequest,UserCreds>	createUserCredsSettings()	Returns the builder for the settings used for calls to createUserCreds.
UnaryCallSettings.Builder<DeleteBackupScheduleRequest,com.google.protobuf.Empty>	deleteBackupScheduleSettings()	Returns the builder for the settings used for calls to deleteBackupSchedule.
UnaryCallSettings.Builder<DeleteBackupRequest,com.google.protobuf.Empty>	deleteBackupSettings()	Returns the builder for the settings used for calls to deleteBackup.
OperationCallSettings.Builder<DeleteDatabaseRequest,Database,DeleteDatabaseMetadata>	deleteDatabaseOperationSettings()	Returns the builder for the settings used for calls to deleteDatabase.
UnaryCallSettings.Builder<DeleteDatabaseRequest,Operation>	deleteDatabaseSettings()	Returns the builder for the settings used for calls to deleteDatabase.
UnaryCallSettings.Builder<DeleteIndexRequest,com.google.protobuf.Empty>	deleteIndexSettings()	Returns the builder for the settings used for calls to deleteIndex.
UnaryCallSettings.Builder<DeleteUserCredsRequest,com.google.protobuf.Empty>	deleteUserCredsSettings()	Returns the builder for the settings used for calls to deleteUserCreds.
UnaryCallSettings.Builder<DisableUserCredsRequest,UserCreds>	disableUserCredsSettings()	Returns the builder for the settings used for calls to disableUserCreds.
UnaryCallSettings.Builder<EnableUserCredsRequest,UserCreds>	enableUserCredsSettings()	Returns the builder for the settings used for calls to enableUserCreds.
OperationCallSettings.Builder<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata>	exportDocumentsOperationSettings()	Returns the builder for the settings used for calls to exportDocuments.
UnaryCallSettings.Builder<ExportDocumentsRequest,Operation>	exportDocumentsSettings()	Returns the builder for the settings used for calls to exportDocuments.
UnaryCallSettings.Builder<GetBackupScheduleRequest,BackupSchedule>	getBackupScheduleSettings()	Returns the builder for the settings used for calls to getBackupSchedule.
UnaryCallSettings.Builder<GetBackupRequest,Backup>	getBackupSettings()	Returns the builder for the settings used for calls to getBackup.
UnaryCallSettings.Builder<GetDatabaseRequest,Database>	getDatabaseSettings()	Returns the builder for the settings used for calls to getDatabase.
UnaryCallSettings.Builder<GetFieldRequest,Field>	getFieldSettings()	Returns the builder for the settings used for calls to getField.
UnaryCallSettings.Builder<GetIndexRequest,Index>	getIndexSettings()	Returns the builder for the settings used for calls to getIndex.
FirestoreAdminStubSettings.Builder	getStubSettingsBuilder()
UnaryCallSettings.Builder<GetUserCredsRequest,UserCreds>	getUserCredsSettings()	Returns the builder for the settings used for calls to getUserCreds.
OperationCallSettings.Builder<ImportDocumentsRequest,com.google.protobuf.Empty,ImportDocumentsMetadata>	importDocumentsOperationSettings()	Returns the builder for the settings used for calls to importDocuments.
UnaryCallSettings.Builder<ImportDocumentsRequest,Operation>	importDocumentsSettings()	Returns the builder for the settings used for calls to importDocuments.
UnaryCallSettings.Builder<ListBackupSchedulesRequest,ListBackupSchedulesResponse>	listBackupSchedulesSettings()	Returns the builder for the settings used for calls to listBackupSchedules.
UnaryCallSettings.Builder<ListBackupsRequest,ListBackupsResponse>	listBackupsSettings()	Returns the builder for the settings used for calls to listBackups.
UnaryCallSettings.Builder<ListDatabasesRequest,ListDatabasesResponse>	listDatabasesSettings()	Returns the builder for the settings used for calls to listDatabases.
PagedCallSettings.Builder<ListFieldsRequest,ListFieldsResponse,FirestoreAdminClient.ListFieldsPagedResponse>	listFieldsSettings()	Returns the builder for the settings used for calls to listFields.
PagedCallSettings.Builder<ListIndexesRequest,ListIndexesResponse,FirestoreAdminClient.ListIndexesPagedResponse>	listIndexesSettings()	Returns the builder for the settings used for calls to listIndexes.
UnaryCallSettings.Builder<ListUserCredsRequest,ListUserCredsResponse>	listUserCredsSettings()	Returns the builder for the settings used for calls to listUserCreds.
UnaryCallSettings.Builder<ResetUserPasswordRequest,UserCreds>	resetUserPasswordSettings()	Returns the builder for the settings used for calls to resetUserPassword.
OperationCallSettings.Builder<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata>	restoreDatabaseOperationSettings()	Returns the builder for the settings used for calls to restoreDatabase.
UnaryCallSettings.Builder<RestoreDatabaseRequest,Operation>	restoreDatabaseSettings()	Returns the builder for the settings used for calls to restoreDatabase.
UnaryCallSettings.Builder<UpdateBackupScheduleRequest,BackupSchedule>	updateBackupScheduleSettings()	Returns the builder for the settings used for calls to updateBackupSchedule.
OperationCallSettings.Builder<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata>	updateDatabaseOperationSettings()	Returns the builder for the settings used for calls to updateDatabase.
UnaryCallSettings.Builder<UpdateDatabaseRequest,Operation>	updateDatabaseSettings()	Returns the builder for the settings used for calls to updateDatabase.
OperationCallSettings.Builder<UpdateFieldRequest,Field,FieldOperationMetadata>	updateFieldOperationSettings()	Returns the builder for the settings used for calls to updateField.
UnaryCallSettings.Builder<UpdateFieldRequest,Operation>	updateFieldSettings()	Returns the builder for the settings used for calls to updateField.

Methods inherited from class com.google.api.gax.rpc.ClientSettings.Builder

applyToAllUnaryMethods, getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, self, setApiKey, setBackgroundExecutorProvider, setClock, setCredentialsProvider, setEndpoint, setExecutorProvider, setGdchApiAudience, setHeaderProvider, setInternalHeaderProvider, setQuotaProjectId, setTransportChannelProvider, setUniverseDomain, setWatchdogCheckInterval, setWatchdogCheckIntervalDuration, setWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()
           throws IOException

Throws:

IOException

Builder

protected Builder(ClientContext clientContext)

Builder

protected Builder(FirestoreAdminSettings settings)

Builder

protected Builder(FirestoreAdminStubSettings.Builder stubSettings)

Method Details

getStubSettingsBuilder

public FirestoreAdminStubSettings.Builder getStubSettingsBuilder()

applyToAllUnaryMethods

public FirestoreAdminSettings.Builder applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)

Applies the given settings updater function to all of the unary API methods in this service.

Note: This method does not support applying settings to streaming methods.

createIndexSettings

public UnaryCallSettings.Builder<CreateIndexRequest,Operation> createIndexSettings()

Returns the builder for the settings used for calls to createIndex.

createIndexOperationSettings

public OperationCallSettings.Builder<CreateIndexRequest,Index,IndexOperationMetadata> createIndexOperationSettings()

Returns the builder for the settings used for calls to createIndex.

listIndexesSettings

public PagedCallSettings.Builder<ListIndexesRequest,ListIndexesResponse,FirestoreAdminClient.ListIndexesPagedResponse> listIndexesSettings()

Returns the builder for the settings used for calls to listIndexes.

getIndexSettings

public UnaryCallSettings.Builder<GetIndexRequest,Index> getIndexSettings()

Returns the builder for the settings used for calls to getIndex.

deleteIndexSettings

public UnaryCallSettings.Builder<DeleteIndexRequest,com.google.protobuf.Empty> deleteIndexSettings()

Returns the builder for the settings used for calls to deleteIndex.

getFieldSettings

public UnaryCallSettings.Builder<GetFieldRequest,Field> getFieldSettings()

Returns the builder for the settings used for calls to getField.

updateFieldSettings

public UnaryCallSettings.Builder<UpdateFieldRequest,Operation> updateFieldSettings()

Returns the builder for the settings used for calls to updateField.

updateFieldOperationSettings

public OperationCallSettings.Builder<UpdateFieldRequest,Field,FieldOperationMetadata> updateFieldOperationSettings()

Returns the builder for the settings used for calls to updateField.

listFieldsSettings

public PagedCallSettings.Builder<ListFieldsRequest,ListFieldsResponse,FirestoreAdminClient.ListFieldsPagedResponse> listFieldsSettings()

Returns the builder for the settings used for calls to listFields.

exportDocumentsSettings

public UnaryCallSettings.Builder<ExportDocumentsRequest,Operation> exportDocumentsSettings()

Returns the builder for the settings used for calls to exportDocuments.

exportDocumentsOperationSettings

public OperationCallSettings.Builder<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata> exportDocumentsOperationSettings()

Returns the builder for the settings used for calls to exportDocuments.

importDocumentsSettings

public UnaryCallSettings.Builder<ImportDocumentsRequest,Operation> importDocumentsSettings()

Returns the builder for the settings used for calls to importDocuments.

importDocumentsOperationSettings

public OperationCallSettings.Builder<ImportDocumentsRequest,com.google.protobuf.Empty,ImportDocumentsMetadata> importDocumentsOperationSettings()

Returns the builder for the settings used for calls to importDocuments.

bulkDeleteDocumentsSettings

public UnaryCallSettings.Builder<BulkDeleteDocumentsRequest,Operation> bulkDeleteDocumentsSettings()

Returns the builder for the settings used for calls to bulkDeleteDocuments.

bulkDeleteDocumentsOperationSettings

public OperationCallSettings.Builder<BulkDeleteDocumentsRequest,BulkDeleteDocumentsResponse,BulkDeleteDocumentsMetadata> bulkDeleteDocumentsOperationSettings()

Returns the builder for the settings used for calls to bulkDeleteDocuments.

createDatabaseSettings

public UnaryCallSettings.Builder<CreateDatabaseRequest,Operation> createDatabaseSettings()

Returns the builder for the settings used for calls to createDatabase.

createDatabaseOperationSettings

public OperationCallSettings.Builder<CreateDatabaseRequest,Database,CreateDatabaseMetadata> createDatabaseOperationSettings()

Returns the builder for the settings used for calls to createDatabase.

getDatabaseSettings

public UnaryCallSettings.Builder<GetDatabaseRequest,Database> getDatabaseSettings()

Returns the builder for the settings used for calls to getDatabase.

listDatabasesSettings

public UnaryCallSettings.Builder<ListDatabasesRequest,ListDatabasesResponse> listDatabasesSettings()

Returns the builder for the settings used for calls to listDatabases.

updateDatabaseSettings

public UnaryCallSettings.Builder<UpdateDatabaseRequest,Operation> updateDatabaseSettings()

Returns the builder for the settings used for calls to updateDatabase.

updateDatabaseOperationSettings

public OperationCallSettings.Builder<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata> updateDatabaseOperationSettings()

Returns the builder for the settings used for calls to updateDatabase.

deleteDatabaseSettings

public UnaryCallSettings.Builder<DeleteDatabaseRequest,Operation> deleteDatabaseSettings()

Returns the builder for the settings used for calls to deleteDatabase.

deleteDatabaseOperationSettings

public OperationCallSettings.Builder<DeleteDatabaseRequest,Database,DeleteDatabaseMetadata> deleteDatabaseOperationSettings()

Returns the builder for the settings used for calls to deleteDatabase.

createUserCredsSettings

public UnaryCallSettings.Builder<CreateUserCredsRequest,UserCreds> createUserCredsSettings()

Returns the builder for the settings used for calls to createUserCreds.

getUserCredsSettings

public UnaryCallSettings.Builder<GetUserCredsRequest,UserCreds> getUserCredsSettings()

Returns the builder for the settings used for calls to getUserCreds.

listUserCredsSettings

public UnaryCallSettings.Builder<ListUserCredsRequest,ListUserCredsResponse> listUserCredsSettings()

Returns the builder for the settings used for calls to listUserCreds.

enableUserCredsSettings

public UnaryCallSettings.Builder<EnableUserCredsRequest,UserCreds> enableUserCredsSettings()

Returns the builder for the settings used for calls to enableUserCreds.

disableUserCredsSettings

public UnaryCallSettings.Builder<DisableUserCredsRequest,UserCreds> disableUserCredsSettings()

Returns the builder for the settings used for calls to disableUserCreds.

resetUserPasswordSettings

public UnaryCallSettings.Builder<ResetUserPasswordRequest,UserCreds> resetUserPasswordSettings()

Returns the builder for the settings used for calls to resetUserPassword.

deleteUserCredsSettings

public UnaryCallSettings.Builder<DeleteUserCredsRequest,com.google.protobuf.Empty> deleteUserCredsSettings()

Returns the builder for the settings used for calls to deleteUserCreds.

getBackupSettings

public UnaryCallSettings.Builder<GetBackupRequest,Backup> getBackupSettings()

Returns the builder for the settings used for calls to getBackup.

listBackupsSettings

public UnaryCallSettings.Builder<ListBackupsRequest,ListBackupsResponse> listBackupsSettings()

Returns the builder for the settings used for calls to listBackups.

deleteBackupSettings

public UnaryCallSettings.Builder<DeleteBackupRequest,com.google.protobuf.Empty> deleteBackupSettings()

Returns the builder for the settings used for calls to deleteBackup.

restoreDatabaseSettings

public UnaryCallSettings.Builder<RestoreDatabaseRequest,Operation> restoreDatabaseSettings()

Returns the builder for the settings used for calls to restoreDatabase.

restoreDatabaseOperationSettings

public OperationCallSettings.Builder<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata> restoreDatabaseOperationSettings()

Returns the builder for the settings used for calls to restoreDatabase.

createBackupScheduleSettings

public UnaryCallSettings.Builder<CreateBackupScheduleRequest,BackupSchedule> createBackupScheduleSettings()

Returns the builder for the settings used for calls to createBackupSchedule.

getBackupScheduleSettings

public UnaryCallSettings.Builder<GetBackupScheduleRequest,BackupSchedule> getBackupScheduleSettings()

Returns the builder for the settings used for calls to getBackupSchedule.

listBackupSchedulesSettings

public UnaryCallSettings.Builder<ListBackupSchedulesRequest,ListBackupSchedulesResponse> listBackupSchedulesSettings()

Returns the builder for the settings used for calls to listBackupSchedules.

updateBackupScheduleSettings

public UnaryCallSettings.Builder<UpdateBackupScheduleRequest,BackupSchedule> updateBackupScheduleSettings()

Returns the builder for the settings used for calls to updateBackupSchedule.

deleteBackupScheduleSettings

public UnaryCallSettings.Builder<DeleteBackupScheduleRequest,com.google.protobuf.Empty> deleteBackupScheduleSettings()

Returns the builder for the settings used for calls to deleteBackupSchedule.

cloneDatabaseSettings

public UnaryCallSettings.Builder<CloneDatabaseRequest,Operation> cloneDatabaseSettings()

Returns the builder for the settings used for calls to cloneDatabase.

cloneDatabaseOperationSettings

public OperationCallSettings.Builder<CloneDatabaseRequest,Database,CloneDatabaseMetadata> cloneDatabaseOperationSettings()

Returns the builder for the settings used for calls to cloneDatabase.

build

public FirestoreAdminSettings build()
                             throws IOException

Specified by:

build in class ClientSettings.Builder<FirestoreAdminSettings,FirestoreAdminSettings.Builder>

Throws:

IOException