Class RetryOptions

Namespace

Microsoft.Azure.Documents.Client

Assembly

Microsoft.Azure.Documents.Client.dll

RetryOptions class defines the parameters an application can set to customize the built-in retry policies in the Azure Cosmos DB service.

public class RetryOptions

Inheritance

object

RetryOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

TypeCheckFunctionsExtensions.IsArray(object)

TypeCheckFunctionsExtensions.IsBool(object)

TypeCheckFunctionsExtensions.IsDefined(object)

TypeCheckFunctionsExtensions.IsNull(object)

TypeCheckFunctionsExtensions.IsNumber(object)

TypeCheckFunctionsExtensions.IsObject(object)

TypeCheckFunctionsExtensions.IsPrimitive(object)

TypeCheckFunctionsExtensions.IsString(object)

Remarks

The DocumentClient class supports retry on certain types of exceptions. This class provides options for applications to control the retry behavior.

Constructors

RetryOptions()

Creates a new instance of the RetryOptions class and intialize all properties to default values for the Azure Cosmos DB service.

public RetryOptions()

Properties

MaxRetryAttemptsOnThrottledRequests

Gets or sets the maximum number of retries in the case where the request fails because the Azure Cosmos DB service has applied rate limiting on the client.

public int MaxRetryAttemptsOnThrottledRequests { get; set; }

Property Value

int

The default value is 9. This means in the case where the request is rate limited, the same request will be issued for a maximum of 10 times to the server before an error is returned to the application. If the value of this property is set to 0, there will be no automatic retry on rate limiting requests from the client and the exception needs to handled at the application level. For an example on how to set this value, please refer to RetryOptions.

Remarks

When a client is sending requests faster than the allowed rate, the service will return HttpStatusCode 429 (Too Many Request) to rate limit the client. The current implementation in the SDK will then wait for the amount of time the service tells it to wait and retry after the time has elapsed.

For more information, see Handle rate limiting/request rate too large.

MaxRetryWaitTimeInSeconds

Gets or sets the maximum retry time in seconds for the Azure Cosmos DB service.

public int MaxRetryWaitTimeInSeconds { get; set; }

Property Value

int

The default value is 30 seconds. For an example on how to set this value, please refer to RetryOptions.

Remarks

When a request fails due to a rate limiting error, the service sends back a response that contains a value indicating the client should not retry before the RetryAfter time period has elapsed. This property allows the application to set a maximum wait time for all retry attempts. If the cumulative wait time exceeds the this value, the client will stop retrying and return the error to the application.

For more information, see Handle rate limiting/request rate too large.