Class FirestoreAdminSettings.Builder (3.20.0)

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

Builder for FirestoreAdminSettings.

Inheritance

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

Constructors

Builder()

protected Builder()

Builder(ClientContext clientContext)

protected Builder(ClientContext clientContext)
Parameter
NameDescription
clientContextClientContext

Builder(FirestoreAdminSettings settings)

protected Builder(FirestoreAdminSettings settings)
Parameter
NameDescription
settingsFirestoreAdminSettings

Builder(FirestoreAdminStubSettings.Builder stubSettings)

protected Builder(FirestoreAdminStubSettings.Builder stubSettings)
Parameter
NameDescription
stubSettingsFirestoreAdminStubSettings.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
NameDescription
settingsUpdaterApiFunction<Builder<?,?>,Void>
Returns
TypeDescription
FirestoreAdminSettings.Builder

build()

public FirestoreAdminSettings build()
Returns
TypeDescription
FirestoreAdminSettings
Overrides
Exceptions
TypeDescription
IOException

createBackupScheduleSettings()

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

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

Returns
TypeDescription
Builder<CreateBackupScheduleRequest,BackupSchedule>

createDatabaseOperationSettings()

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

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

Returns
TypeDescription
Builder<CreateDatabaseRequest,Database,CreateDatabaseMetadata>

createDatabaseSettings()

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

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

Returns
TypeDescription
Builder<CreateDatabaseRequest,Operation>

createIndexOperationSettings()

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

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

Returns
TypeDescription
Builder<CreateIndexRequest,Index,IndexOperationMetadata>

createIndexSettings()

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

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

Returns
TypeDescription
Builder<CreateIndexRequest,Operation>

deleteBackupScheduleSettings()

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

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

Returns
TypeDescription
Builder<DeleteBackupScheduleRequest,Empty>

deleteBackupSettings()

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

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

Returns
TypeDescription
Builder<DeleteBackupRequest,Empty>

deleteDatabaseOperationSettings()

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

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

Returns
TypeDescription
Builder<DeleteDatabaseRequest,Database,DeleteDatabaseMetadata>

deleteDatabaseSettings()

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

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

Returns
TypeDescription
Builder<DeleteDatabaseRequest,Operation>

deleteIndexSettings()

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

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

Returns
TypeDescription
Builder<DeleteIndexRequest,Empty>

exportDocumentsOperationSettings()

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

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

Returns
TypeDescription
Builder<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata>

exportDocumentsSettings()

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

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

Returns
TypeDescription
Builder<ExportDocumentsRequest,Operation>

getBackupScheduleSettings()

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

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

Returns
TypeDescription
Builder<GetBackupScheduleRequest,BackupSchedule>

getBackupSettings()

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

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

Returns
TypeDescription
Builder<GetBackupRequest,Backup>

getDatabaseSettings()

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

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

Returns
TypeDescription
Builder<GetDatabaseRequest,Database>

getFieldSettings()

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

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

Returns
TypeDescription
Builder<GetFieldRequest,Field>

getIndexSettings()

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

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

Returns
TypeDescription
Builder<GetIndexRequest,Index>

getStubSettingsBuilder()

public FirestoreAdminStubSettings.Builder getStubSettingsBuilder()
Returns
TypeDescription
FirestoreAdminStubSettings.Builder

importDocumentsOperationSettings()

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

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

Returns
TypeDescription
Builder<ImportDocumentsRequest,Empty,ImportDocumentsMetadata>

importDocumentsSettings()

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

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

Returns
TypeDescription
Builder<ImportDocumentsRequest,Operation>

listBackupSchedulesSettings()

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

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

Returns
TypeDescription
Builder<ListBackupSchedulesRequest,ListBackupSchedulesResponse>

listBackupsSettings()

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

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

Returns
TypeDescription
Builder<ListBackupsRequest,ListBackupsResponse>

listDatabasesSettings()

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

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

Returns
TypeDescription
Builder<ListDatabasesRequest,ListDatabasesResponse>

listFieldsSettings()

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

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

Returns
TypeDescription
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
TypeDescription
Builder<ListIndexesRequest,ListIndexesResponse,ListIndexesPagedResponse>

restoreDatabaseOperationSettings()

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

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

Returns
TypeDescription
Builder<RestoreDatabaseRequest,Database,RestoreDatabaseMetadata>

restoreDatabaseSettings()

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

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

Returns
TypeDescription
Builder<RestoreDatabaseRequest,Operation>

updateBackupScheduleSettings()

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

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

Returns
TypeDescription
Builder<UpdateBackupScheduleRequest,BackupSchedule>

updateDatabaseOperationSettings()

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

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

Returns
TypeDescription
Builder<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata>

updateDatabaseSettings()

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

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

Returns
TypeDescription
Builder<UpdateDatabaseRequest,Operation>

updateFieldOperationSettings()

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

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

Returns
TypeDescription
Builder<UpdateFieldRequest,Field,FieldOperationMetadata>

updateFieldSettings()

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

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

Returns
TypeDescription
Builder<UpdateFieldRequest,Operation>