Skip to content

Commit 2515373

Browse files
committed
fix: update session retry optmization public doc
1 parent e4ec354 commit 2515373

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

Microsoft.Azure.Cosmos/src/CosmosClientOptions.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -747,8 +747,9 @@ public Func<HttpClient> HttpClientFactory
747747
/// </remarks>
748748
public AvailabilityStrategy AvailabilityStrategy { get; set; }
749749

750-
/// <summary>
751-
/// provides SessionTokenMismatchRetryPolicy optimization through customer supplied region switch hints
750+
/// <summary>
751+
/// Provides SessionTokenMismatchRetryPolicy optimization through customer supplied region switch hints which guide SDK-internal retry policies on how early to switch retries to a different region.
752+
/// If true, will retry all replicas once and add a minimum delay before switching to the next region.If false, it will retry in the local region up to 5s
752753
/// </summary>
753754
#if PREVIEW
754755
public

Microsoft.Azure.Cosmos/src/Fluent/CosmosClientBuilder.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,8 @@ public CosmosClientBuilder WithSerializerOptions(CosmosSerializationOptions cosm
584584
}
585585

586586
/// <summary>
587-
/// provides SessionTokenMismatchRetryPolicy optimization through customer supplied region switch hints
587+
/// Provides SessionTokenMismatchRetryPolicy optimization through customer supplied region switch hints which guide SDK-internal retry policies on how early to switch retries to a different region.
588+
/// If true, will retry all replicas once and add a minimum delay before switching to the next region.If false, it will retry in the local region up to 5s
588589
/// </summary>
589590
/// <param name="enableRemoteRegionPreferredForSessionRetry"></param>
590591
/// <returns>The <see cref="CosmosClientBuilder"/> object</returns>

0 commit comments

Comments
 (0)