Class FirestoreAdminSettings.Builder (3.28.0)

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

Builder for FirestoreAdminSettings.

Inheritance

java.lang.Object > ClientSettings.Builder > FirestoreAdminSettings.Builder

Inherited Members

ClientSettings.Builder.applyToAllUnaryMethods(Iterable<UnaryCallSettings.Builder<?,?>>,ApiFunction<UnaryCallSettings.Builder<?,?>,Void>)

ClientSettings.Builder.build()

ClientSettings.Builder.getApiKey()

ClientSettings.Builder.getBackgroundExecutorProvider()

ClientSettings.Builder.getClock()

ClientSettings.Builder.getCredentialsProvider()

ClientSettings.Builder.getEndpoint()

ClientSettings.Builder.getExecutorProvider()

ClientSettings.Builder.getGdchApiAudience()

ClientSettings.Builder.getHeaderProvider()

ClientSettings.Builder.getInternalHeaderProvider()

ClientSettings.Builder.getQuotaProjectId()

ClientSettings.Builder.getStubSettings()

ClientSettings.Builder.getTransportChannelProvider()

ClientSettings.Builder.getWatchdogCheckInterval()

ClientSettings.Builder.getWatchdogCheckIntervalDuration()

ClientSettings.Builder.getWatchdogProvider()

ClientSettings.Builder.self()

ClientSettings.Builder.setApiKey(String)

ClientSettings.Builder.setBackgroundExecutorProvider(ExecutorProvider)

ClientSettings.Builder.setClock(ApiClock)

ClientSettings.Builder.setCredentialsProvider(CredentialsProvider)

ClientSettings.Builder.setEndpoint(String)

ClientSettings.Builder.setExecutorProvider(ExecutorProvider)

ClientSettings.Builder.setGdchApiAudience(String)

ClientSettings.Builder.setHeaderProvider(HeaderProvider)

ClientSettings.Builder.setInternalHeaderProvider(HeaderProvider)

ClientSettings.Builder.setQuotaProjectId(String)

ClientSettings.Builder.setTransportChannelProvider(TransportChannelProvider)

ClientSettings.Builder.setUniverseDomain(String)

ClientSettings.Builder.setWatchdogCheckInterval(Duration)

ClientSettings.Builder.setWatchdogCheckIntervalDuration(Duration)

ClientSettings.Builder.setWatchdogProvider(WatchdogProvider)

ClientSettings.Builder.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

Builder()

protected Builder()

Builder(ClientContext clientContext)

protected Builder(ClientContext clientContext)

Parameter
Name	Description
`clientContext`	`ClientContext`

Builder(FirestoreAdminSettings settings)

protected Builder(FirestoreAdminSettings settings)

Parameter
Name	Description
`settings`	`FirestoreAdminSettings`

Builder(FirestoreAdminStubSettings.Builder stubSettings)

protected Builder(FirestoreAdminStubSettings.Builder stubSettings)

Parameter
Name	Description
`stubSettings`	`FirestoreAdminStubSettings.Builder`

Methods

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

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.

Parameter
Name	Description
`settingsUpdater`	`ApiFunction<Builder<?,?>,Void>`

Returns
Type	Description
`FirestoreAdminSettings.Builder`

build()

public FirestoreAdminSettings build()

Returns
Type	Description
`FirestoreAdminSettings`

Overrides

ClientSettings.Builder<SettingsT,B>.build()

Exceptions
Type	Description
`IOException`

bulkDeleteDocumentsOperationSettings()

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

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

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

bulkDeleteDocumentsSettings()

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

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

Returns
Type	Description
`Builder<BulkDeleteDocumentsRequest,Operation>`

createBackupScheduleSettings()

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

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

Returns
Type	Description
`Builder<CreateBackupScheduleRequest,BackupSchedule>`

createDatabaseOperationSettings()

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

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

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

createDatabaseSettings()

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

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

Returns
Type	Description
`Builder<CreateDatabaseRequest,Operation>`

createIndexOperationSettings()

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

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

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

createIndexSettings()

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

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

Returns
Type	Description
`Builder<CreateIndexRequest,Operation>`

deleteBackupScheduleSettings()

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

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

Returns
Type	Description
`Builder<DeleteBackupScheduleRequest,Empty>`

deleteBackupSettings()

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

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

Returns
Type	Description
`Builder<DeleteBackupRequest,Empty>`

deleteDatabaseOperationSettings()

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

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

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

deleteDatabaseSettings()

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

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

Returns
Type	Description
`Builder<DeleteDatabaseRequest,Operation>`

deleteIndexSettings()

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

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

Returns
Type	Description
`Builder<DeleteIndexRequest,Empty>`

exportDocumentsOperationSettings()

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

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

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

exportDocumentsSettings()

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

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

Returns
Type	Description
`Builder<ExportDocumentsRequest,Operation>`

getBackupScheduleSettings()

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

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

Returns
Type	Description
`Builder<GetBackupScheduleRequest,BackupSchedule>`

getBackupSettings()

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

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

Returns
Type	Description
`Builder<GetBackupRequest,Backup>`

getDatabaseSettings()

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

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

Returns
Type	Description
`Builder<GetDatabaseRequest,Database>`

getFieldSettings()

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

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

Returns
Type	Description
`Builder<GetFieldRequest,Field>`

getIndexSettings()

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

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

Returns
Type	Description
`Builder<GetIndexRequest,Index>`

getStubSettingsBuilder()

public FirestoreAdminStubSettings.Builder getStubSettingsBuilder()

Returns
Type	Description
`FirestoreAdminStubSettings.Builder`

importDocumentsOperationSettings()

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

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

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

importDocumentsSettings()

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

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

Returns
Type	Description
`Builder<ImportDocumentsRequest,Operation>`

listBackupSchedulesSettings()

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

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

Returns
Type	Description
`Builder<ListBackupSchedulesRequest,ListBackupSchedulesResponse>`

listBackupsSettings()

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

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

Returns
Type	Description
`Builder<ListBackupsRequest,ListBackupsResponse>`

listDatabasesSettings()

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

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

Returns
Type	Description
`Builder<ListDatabasesRequest,ListDatabasesResponse>`

listFieldsSettings()

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

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

Returns
Type	Description
`Builder<ListFieldsRequest,ListFieldsResponse,ListFieldsPagedResponse>`

listIndexesSettings()

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

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

Returns
Type	Description
`Builder<ListIndexesRequest,ListIndexesResponse,ListIndexesPagedResponse>`

restoreDatabaseOperationSettings()

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

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

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

restoreDatabaseSettings()

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

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

Returns
Type	Description
`Builder<RestoreDatabaseRequest,Operation>`

updateBackupScheduleSettings()

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

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

Returns
Type	Description
`Builder<UpdateBackupScheduleRequest,BackupSchedule>`

updateDatabaseOperationSettings()

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

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

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

updateDatabaseSettings()

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

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

Returns
Type	Description
`Builder<UpdateDatabaseRequest,Operation>`

updateFieldOperationSettings()

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

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

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

updateFieldSettings()

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

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

Returns
Type	Description
`Builder<UpdateFieldRequest,Operation>`