public sealed class FirestoreAdminSettings : ServiceSettingsBase
Settings for FirestoreAdminClient instances.
Namespace
Google.Cloud.Firestore.Admin.V1Assembly
Google.Cloud.Firestore.Admin.V1.dll
Constructors
FirestoreAdminSettings()
public FirestoreAdminSettings()
Constructs a new FirestoreAdminSettings object with default settings.
Properties
CreateIndexOperationsSettings
public OperationsSettings CreateIndexOperationsSettings { get; set; }
Long Running Operation settings for calls to FirestoreAdminClient.CreateIndex
and
FirestoreAdminClient.CreateIndexAsync
.
Property Value | |
---|---|
Type | Description |
OperationsSettings |
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 |
- This call will not be retried.
- Timeout: 60 seconds.
DeleteIndexSettings
public CallSettings DeleteIndexSettings { get; set; }
CallSettings for synchronous and asynchronous calls to
FirestoreAdminClient.DeleteIndex
and FirestoreAdminClient.DeleteIndexAsync
.
Property Value | |
---|---|
Type | Description |
CallSettings |
- Initial retry delay: 100 milliseconds.
- Retry delay multiplier: 1.3
- Retry maximum delay: 60000 milliseconds.
- Maximum attempts: 5
- 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 |
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 |
- This call will not be retried.
- Timeout: 60 seconds.
GetFieldSettings
public CallSettings GetFieldSettings { get; set; }
CallSettings for synchronous and asynchronous calls to
FirestoreAdminClient.GetField
and FirestoreAdminClient.GetFieldAsync
.
Property Value | |
---|---|
Type | Description |
CallSettings |
- Initial retry delay: 100 milliseconds.
- Retry delay multiplier: 1.3
- Retry maximum delay: 60000 milliseconds.
- Maximum attempts: 5
- 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 |
- Initial retry delay: 100 milliseconds.
- Retry delay multiplier: 1.3
- Retry maximum delay: 60000 milliseconds.
- Maximum attempts: 5
- 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 |
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 |
- This call will not be retried.
- Timeout: 60 seconds.
ListFieldsSettings
public CallSettings ListFieldsSettings { get; set; }
CallSettings for synchronous and asynchronous calls to
FirestoreAdminClient.ListFields
and FirestoreAdminClient.ListFieldsAsync
.
Property Value | |
---|---|
Type | Description |
CallSettings |
- Initial retry delay: 100 milliseconds.
- Retry delay multiplier: 1.3
- Retry maximum delay: 60000 milliseconds.
- Maximum attempts: 5
- 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 |
- Initial retry delay: 100 milliseconds.
- Retry delay multiplier: 1.3
- Retry maximum delay: 60000 milliseconds.
- Maximum attempts: 5
- Timeout: 60 seconds.
UpdateFieldOperationsSettings
public OperationsSettings UpdateFieldOperationsSettings { get; set; }
Long Running Operation settings for calls to FirestoreAdminClient.UpdateField
and
FirestoreAdminClient.UpdateFieldAsync
.
Property Value | |
---|---|
Type | Description |
OperationsSettings |
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 |
- 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. |