com.ibm.cos.v2.retries.api

Interface RefreshRetryTokenRequest

All Superinterfaces:

ToCopyableBuilder<RefreshRetryTokenRequest.Builder,RefreshRetryTokenRequest>

All Known Implementing Classes:

RefreshRetryTokenRequestImpl

@ThreadSafe
public interface RefreshRetryTokenRequest
extends ToCopyableBuilder<RefreshRetryTokenRequest.Builder,RefreshRetryTokenRequest>

Request that the calling code makes to the RetryStrategy using RetryStrategy.refreshRetryToken(RefreshRetryTokenRequest) to notify that the attempted execution failed and the RetryToken needs to be refreshed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RefreshRetryTokenRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RefreshRetryTokenRequest.Builder	builder() Returns a new builder to configure the RefreshRetryTokenRequest instance.
Throwable	failure() The cause of the last attempt failure.
Optional<Duration>	suggestedDelay() A suggestion of how long to wait from the last attempt failure.
RetryToken	token() A RetryToken acquired a previous RetryStrategy.acquireInitialToken(com.ibm.cos.v2.retries.api.AcquireInitialTokenRequest) or RetryStrategy.refreshRetryToken(com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest) call.

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy, toBuilder

Method Detail

token

RetryToken token()

A RetryToken acquired a previous RetryStrategy.acquireInitialToken(com.ibm.cos.v2.retries.api.AcquireInitialTokenRequest) or RetryStrategy.refreshRetryToken(com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest) call.

suggestedDelay

Optional<Duration> suggestedDelay()

A suggestion of how long to wait from the last attempt failure. For HTTP calls, this is usually extracted from a "retry after" header from the downstream service.

failure

Throwable failure()

The cause of the last attempt failure.

builder

static RefreshRetryTokenRequest.Builder builder()

Returns a new builder to configure the RefreshRetryTokenRequest instance.