RetryOptions Class

  • Reference
Package:
com.azure.core.http.policy
Maven Artifact:
com.azure:azure-core:1.48.0
  • java.lang.Object
    • com.azure.core.http.policy.RetryOptions

public class RetryOptions

The RetryOptions class provides configuration options for retry strategies. It supports both ExponentialBackoffOptions and FixedDelayOptions.

This class is useful when you need to customize the behavior of retries in the HTTP pipeline. It allows you to specify the type of retry strategy and its options.

Here's a code sample of how to use this class:

In these examples, RetryOptions is created with either ExponentialBackoffOptions or FixedDelayOptions. These options can then be used to configure a retry policy in the HTTP pipeline.

// Using ExponentialBackoffOptions
 ExponentialBackoffOptions exponentialOptions = new ExponentialBackoffOptions()
     .setMaxRetries(5)
     .setBaseDelay(Duration.ofSeconds(1))
     .setMaxDelay(Duration.ofSeconds(10));
 RetryOptions retryOptions = new RetryOptions(exponentialOptions);

 // Using FixedDelayOptions
 FixedDelayOptions fixedOptions = new FixedDelayOptions(3, Duration.ofSeconds(1));
 RetryOptions retryOptions = new RetryOptions(fixedOptions);

Constructor Summary

Constructor Description
RetryOptions(ExponentialBackoffOptions exponentialBackoffOptions)

Creates a new instance that uses ExponentialBackoffOptions.
RetryOptions(FixedDelayOptions fixedDelayOptions)

Creates a new instance that uses FixedDelayOptions.

Method Summary

Modifier and Type Method and Description
ExponentialBackoffOptions getExponentialBackoffOptions()

Gets the configuration for exponential backoff if configured.
FixedDelayOptions getFixedDelayOptions()

Gets the configuration for exponential backoff if configured.
Predicate<RequestRetryCondition> getShouldRetryCondition()

Gets the predicate that determines if a retry should be attempted.
RetryOptions setShouldRetryCondition(Predicate<RequestRetryCondition> shouldRetryCondition)

Sets the predicate that determines if a retry should be attempted.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RetryOptions

public RetryOptions(ExponentialBackoffOptions exponentialBackoffOptions)

Creates a new instance that uses ExponentialBackoffOptions.

Parameters:

exponentialBackoffOptions - The ExponentialBackoffOptions.

RetryOptions

public RetryOptions(FixedDelayOptions fixedDelayOptions)

Creates a new instance that uses FixedDelayOptions.

Parameters:

fixedDelayOptions - The FixedDelayOptions.

Method Details

getExponentialBackoffOptions

public ExponentialBackoffOptions getExponentialBackoffOptions()

Gets the configuration for exponential backoff if configured.

Returns:

getFixedDelayOptions

public FixedDelayOptions getFixedDelayOptions()

Gets the configuration for exponential backoff if configured.

Returns:

getShouldRetryCondition

public Predicate getShouldRetryCondition()

Gets the predicate that determines if a retry should be attempted.

If null, the default behavior is to retry HTTP responses with status codes 408, 429, and any 500 status code that isn't 501 or 505. And to retry any Exception.

Returns:

The predicate that determines if a retry should be attempted.

setShouldRetryCondition

public RetryOptions setShouldRetryCondition(Predicate shouldRetryCondition)

Sets the predicate that determines if a retry should be attempted.

If null, the default behavior is to retry HTTP responses with status codes 408, 429, and any 500 status code that isn't 501 or 505. And to retry any Exception.

Parameters:

shouldRetryCondition - The predicate that determines if a retry should be attempted for the given HttpResponse.

Returns:

The updated RetryOptions object.

Applies to