Firestore v1 API - Class FirestoreSettings (3.12.0)

Version latest

• 3.12.0 (latest)
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.5.0
• 2.4.0
• 2.3.0

public sealed class FirestoreSettings : ServiceSettingsBase

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

Settings for FirestoreClient instances.

Inheritance

object > ServiceSettingsBase > FirestoreSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

FirestoreSettings()

public FirestoreSettings()

Constructs a new FirestoreSettings object with default settings.

Properties

BatchGetDocumentsSettings

public CallSettings BatchGetDocumentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.BatchGetDocuments and FirestoreClient.BatchGetDocumentsAsync.

Property Value
Type	Description
CallSettings

Remarks

Timeout: 300 seconds.

BatchWriteSettings

public CallSettings BatchWriteSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.BatchWrite and FirestoreClient.BatchWriteAsync.

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: ResourceExhausted, Unavailable, Aborted.
• Timeout: 60 seconds.

BeginTransactionSettings

public CallSettings BeginTransactionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.BeginTransaction and FirestoreClient.BeginTransactionAsync.

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: ResourceExhausted, Unavailable, Internal, DeadlineExceeded.
• Timeout: 60 seconds.

CommitSettings

public CallSettings CommitSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.Commit and FirestoreClient.CommitAsync.

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: ResourceExhausted, Unavailable.
• Timeout: 60 seconds.

CreateDocumentSettings

public CallSettings CreateDocumentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.CreateDocument and FirestoreClient.CreateDocumentAsync.

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: ResourceExhausted, Unavailable.
• Timeout: 60 seconds.

DeleteDocumentSettings

public CallSettings DeleteDocumentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.DeleteDocument and FirestoreClient.DeleteDocumentAsync.

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: ResourceExhausted, Unavailable, Internal, DeadlineExceeded.
• Timeout: 60 seconds.

GetDocumentSettings

public CallSettings GetDocumentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.GetDocument and FirestoreClient.GetDocumentAsync.

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: ResourceExhausted, Unavailable, Internal, DeadlineExceeded.
• Timeout: 60 seconds.

ListCollectionIdsSettings

public CallSettings ListCollectionIdsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.ListCollectionIds and FirestoreClient.ListCollectionIdsAsync.

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: ResourceExhausted, Unavailable, Internal, DeadlineExceeded.
• Timeout: 60 seconds.

ListDocumentsSettings

public CallSettings ListDocumentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.ListDocuments and FirestoreClient.ListDocumentsAsync.

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: ResourceExhausted, Unavailable, Internal, DeadlineExceeded.
• Timeout: 60 seconds.

ListenSettings

public CallSettings ListenSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.Listen and FirestoreClient.ListenAsync.

Property Value
Type	Description
CallSettings

Remarks

Timeout: 86400 seconds.

ListenStreamingSettings

public BidirectionalStreamingSettings ListenStreamingSettings { get; set; }

BidirectionalStreamingSettings for calls to FirestoreClient.Listen and FirestoreClient.ListenAsync.

Property Value
Type	Description
BidirectionalStreamingSettings

Remarks

The default local send queue size is 100.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

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

Property Value
Type	Description
LocationsSettings

PartitionQuerySettings

public CallSettings PartitionQuerySettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.PartitionQuery and FirestoreClient.PartitionQueryAsync.

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: ResourceExhausted, Unavailable, Internal, DeadlineExceeded.
• Timeout: 300 seconds.

RollbackSettings

public CallSettings RollbackSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.Rollback and FirestoreClient.RollbackAsync.

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: ResourceExhausted, Unavailable, Internal, DeadlineExceeded.
• Timeout: 60 seconds.

RunAggregationQuerySettings

public CallSettings RunAggregationQuerySettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.RunAggregationQuery and FirestoreClient.RunAggregationQueryAsync.

Property Value
Type	Description
CallSettings

Remarks

Timeout: 300 seconds.

RunQuerySettings

public CallSettings RunQuerySettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.RunQuery and FirestoreClient.RunQueryAsync.

Property Value
Type	Description
CallSettings

Remarks

Timeout: 300 seconds.

UpdateDocumentSettings

public CallSettings UpdateDocumentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.UpdateDocument and FirestoreClient.UpdateDocumentAsync.

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: ResourceExhausted, Unavailable.
• Timeout: 60 seconds.

WriteSettings

public CallSettings WriteSettings { get; set; }

CallSettings for synchronous and asynchronous calls to FirestoreClient.Write and FirestoreClient.WriteAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 86400 seconds.

WriteStreamingSettings

public BidirectionalStreamingSettings WriteStreamingSettings { get; set; }

BidirectionalStreamingSettings for calls to FirestoreClient.Write and FirestoreClient.WriteAsync.

Property Value
Type	Description
BidirectionalStreamingSettings

Remarks

The default local send queue size is 100.

Methods

Clone()

public FirestoreSettings Clone()

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

Returns
Type	Description
FirestoreSettings	A deep clone of this FirestoreSettings object.

GetDefault()

public static FirestoreSettings GetDefault()

Get a new instance of the default FirestoreSettings.

Returns
Type	Description
FirestoreSettings	A new instance of the default FirestoreSettings.