Firestore Admin v1 API - Class FirestoreAdminSettings (3.11.0)

public sealed class FirestoreAdminSettings : ServiceSettingsBase

Reference documentation and code samples for the Firestore Admin v1 API class FirestoreAdminSettings.

Settings for FirestoreAdminClient instances.

Inheritance

object > ServiceSettingsBase > FirestoreAdminSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

FirestoreAdminSettings()

public FirestoreAdminSettings()

Constructs a new FirestoreAdminSettings object with default settings.

Properties

BulkDeleteDocumentsOperationsSettings

public OperationsSettings BulkDeleteDocumentsOperationsSettings { get; set; }

Long Running Operation settings for calls to FirestoreAdminClient.BulkDeleteDocuments and FirestoreAdminClient.BulkDeleteDocumentsAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

BulkDeleteDocumentsSettings

public CallSettings BulkDeleteDocumentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.BulkDeleteDocuments and FirestoreAdminClient.BulkDeleteDocumentsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CreateBackupScheduleSettings

public CallSettings CreateBackupScheduleSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.CreateBackupSchedule and FirestoreAdminClient.CreateBackupScheduleAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

CreateDatabaseOperationsSettings

public OperationsSettings CreateDatabaseOperationsSettings { get; set; }

Long Running Operation settings for calls to FirestoreAdminClient.CreateDatabase and FirestoreAdminClient.CreateDatabaseAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

CreateDatabaseSettings

public CallSettings CreateDatabaseSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.CreateDatabase and FirestoreAdminClient.CreateDatabaseAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

CreateIndexOperationsSettings

public OperationsSettings CreateIndexOperationsSettings { get; set; }

Long Running Operation settings for calls to FirestoreAdminClient.CreateIndex and FirestoreAdminClient.CreateIndexAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

CreateIndexSettings

public CallSettings CreateIndexSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.CreateIndex and FirestoreAdminClient.CreateIndexAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

DeleteBackupScheduleSettings

public CallSettings DeleteBackupScheduleSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.DeleteBackupSchedule and FirestoreAdminClient.DeleteBackupScheduleAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

DeleteBackupSettings

public CallSettings DeleteBackupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.DeleteBackup and FirestoreAdminClient.DeleteBackupAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

DeleteDatabaseOperationsSettings

public OperationsSettings DeleteDatabaseOperationsSettings { get; set; }

Long Running Operation settings for calls to FirestoreAdminClient.DeleteDatabase and FirestoreAdminClient.DeleteDatabaseAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

DeleteDatabaseSettings

public CallSettings DeleteDatabaseSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.DeleteDatabase and FirestoreAdminClient.DeleteDatabaseAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

DeleteIndexSettings

public CallSettings DeleteIndexSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.DeleteIndex and FirestoreAdminClient.DeleteIndexAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unavailable, Internal, DeadlineExceeded.
Timeout: 60 seconds.

ExportDocumentsOperationsSettings

public OperationsSettings ExportDocumentsOperationsSettings { get; set; }

Long Running Operation settings for calls to FirestoreAdminClient.ExportDocuments and FirestoreAdminClient.ExportDocumentsAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

ExportDocumentsSettings

public CallSettings ExportDocumentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.ExportDocuments and FirestoreAdminClient.ExportDocumentsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

GetBackupScheduleSettings

public CallSettings GetBackupScheduleSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.GetBackupSchedule and FirestoreAdminClient.GetBackupScheduleAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

GetBackupSettings

public CallSettings GetBackupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.GetBackup and FirestoreAdminClient.GetBackupAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

GetDatabaseSettings

public CallSettings GetDatabaseSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.GetDatabase and FirestoreAdminClient.GetDatabaseAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

GetFieldSettings

public CallSettings GetFieldSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.GetField and FirestoreAdminClient.GetFieldAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unavailable, Internal, DeadlineExceeded.
Timeout: 60 seconds.

GetIndexSettings

public CallSettings GetIndexSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.GetIndex and FirestoreAdminClient.GetIndexAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unavailable, Internal, DeadlineExceeded.
Timeout: 60 seconds.

ImportDocumentsOperationsSettings

public OperationsSettings ImportDocumentsOperationsSettings { get; set; }

Long Running Operation settings for calls to FirestoreAdminClient.ImportDocuments and FirestoreAdminClient.ImportDocumentsAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

ImportDocumentsSettings

public CallSettings ImportDocumentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.ImportDocuments and FirestoreAdminClient.ImportDocumentsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

ListBackupSchedulesSettings

public CallSettings ListBackupSchedulesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.ListBackupSchedules and FirestoreAdminClient.ListBackupSchedulesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

ListBackupsSettings

public CallSettings ListBackupsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.ListBackups and FirestoreAdminClient.ListBackupsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

ListDatabasesSettings

public CallSettings ListDatabasesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.ListDatabases and FirestoreAdminClient.ListDatabasesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

ListFieldsSettings

public CallSettings ListFieldsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.ListFields and FirestoreAdminClient.ListFieldsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unavailable, Internal, DeadlineExceeded.
Timeout: 60 seconds.

ListIndexesSettings

public CallSettings ListIndexesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.ListIndexes and FirestoreAdminClient.ListIndexesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unavailable, Internal, DeadlineExceeded.
Timeout: 60 seconds.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

The settings to use for the LocationsClient associated with the client.

Property Value
Type	Description
`LocationsSettings`

RestoreDatabaseOperationsSettings

public OperationsSettings RestoreDatabaseOperationsSettings { get; set; }

Long Running Operation settings for calls to FirestoreAdminClient.RestoreDatabase and FirestoreAdminClient.RestoreDatabaseAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

RestoreDatabaseSettings

public CallSettings RestoreDatabaseSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.RestoreDatabase and FirestoreAdminClient.RestoreDatabaseAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

UpdateBackupScheduleSettings

public CallSettings UpdateBackupScheduleSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.UpdateBackupSchedule and FirestoreAdminClient.UpdateBackupScheduleAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

UpdateDatabaseOperationsSettings

public OperationsSettings UpdateDatabaseOperationsSettings { get; set; }

Long Running Operation settings for calls to FirestoreAdminClient.UpdateDatabase and FirestoreAdminClient.UpdateDatabaseAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

UpdateDatabaseSettings

public CallSettings UpdateDatabaseSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.UpdateDatabase and FirestoreAdminClient.UpdateDatabaseAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

UpdateFieldOperationsSettings

public OperationsSettings UpdateFieldOperationsSettings { get; set; }

Long Running Operation settings for calls to FirestoreAdminClient.UpdateField and FirestoreAdminClient.UpdateFieldAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

UpdateFieldSettings

public CallSettings UpdateFieldSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreAdminClient.UpdateField and FirestoreAdminClient.UpdateFieldAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

Methods

Clone()

public FirestoreAdminSettings Clone()

Creates a deep clone of this object, with all the same property values.

Returns
Type	Description
`FirestoreAdminSettings`	A deep clone of this FirestoreAdminSettings object.

GetDefault()

public static FirestoreAdminSettings GetDefault()

Get a new instance of the default FirestoreAdminSettings.

Returns
Type	Description
`FirestoreAdminSettings`	A new instance of the default FirestoreAdminSettings.