Package com.microsoft.kiota.http.middleware.options

Class RetryHandlerOption

java.lang.Object

com.microsoft.kiota.http.middleware.options.RetryHandlerOption

All Implemented Interfaces:

com.microsoft.kiota.RequestOption

public class RetryHandlerOption
extends Object
implements com.microsoft.kiota.RequestOption

The options to be passed to the retry middleware.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_DELAY	Default retry delay
static final int	DEFAULT_MAX_RETRIES	Default maximum number of retries
static final IShouldRetry	DEFAULT_SHOULD_RETRY	Default retry evaluation, always retry.
static final long	MAX_DELAY	Absolute maximum retry delay
static final int	MAX_RETRIES	Absolute maximum number of retries

Constructor Summary

Constructors

Constructor	Description
RetryHandlerOption()	Create default instance of retry options, with default values of delay, max retries and shouldRetry callback.
RetryHandlerOption(IShouldRetry shouldRetry, int maxRetries, long delay)	Create an instance with provided values

Method Summary

Modifier and Type	Method	Description
long	delay()	Gets the delay in milliseconds between retries.
<T extends com.microsoft.kiota.RequestOption> Class<T>	getType()
int	maxRetries()	Gets the maximum number of retries.
IShouldRetry	shouldRetry()	Gets the callback evaluating whether a retry should be made.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_SHOULD_RETRY

@Nonnull
public static final IShouldRetry DEFAULT_SHOULD_RETRY

Default retry evaluation, always retry.

MAX_RETRIES

public static final int MAX_RETRIES

Absolute maximum number of retries

See Also:

• Constant Field Values

DEFAULT_MAX_RETRIES

public static final int DEFAULT_MAX_RETRIES

Default maximum number of retries

See Also:

• Constant Field Values

DEFAULT_DELAY

public static final long DEFAULT_DELAY

Default retry delay

See Also:

• Constant Field Values

MAX_DELAY

public static final long MAX_DELAY

Absolute maximum retry delay

See Also:

• Constant Field Values

Constructor Details

RetryHandlerOption

public RetryHandlerOption()

Create default instance of retry options, with default values of delay, max retries and shouldRetry callback.

RetryHandlerOption

public RetryHandlerOption(@Nullable
 IShouldRetry shouldRetry,
 int maxRetries,
 long delay)

Create an instance with provided values

Parameters:

shouldRetry - Retry callback to be called before making a retry

maxRetries - Number of max retires for a request

delay - Delay in seconds between retries

Method Details

shouldRetry

@Nonnull
public IShouldRetry shouldRetry()

Gets the callback evaluating whether a retry should be made.

Returns:

should retry callback

maxRetries

public int maxRetries()

Gets the maximum number of retries.

Returns:

Number of max retries

delay

public long delay()

Gets the delay in milliseconds between retries.

Returns:

Delay in milliseconds between retries

getType

@Nonnull
public <T extends com.microsoft.kiota.RequestOption>
Class<T> getType()

Specified by:

getType in interface com.microsoft.kiota.RequestOption