A B C D E F I M R S T U

A

acquireInitialToken(AcquireInitialTokenRequest) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy

Invoked before the first request attempt.

AcquireInitialTokenRequest - Interface in com.ibm.cos.v2.retries.api

Encapsulates the abstract scope to start the attempts about to be executed using a retry strategy.

AcquireInitialTokenRequestImpl - Class in com.ibm.cos.v2.retries.api.internal

Implementation of the AcquireInitialTokenRequest interface.

AcquireInitialTokenResponse - Interface in com.ibm.cos.v2.retries.api

Encapsulates the response from the RetryStrategy to the request to start the attempts to be executed.

AcquireInitialTokenResponseImpl - Class in com.ibm.cos.v2.retries.api.internal

Implementation of the AcquireInitialTokenResponse interface.

B

BackoffStrategy - Interface in com.ibm.cos.v2.retries.api

Determines how long to wait before each execution attempt.

backoffStrategy(BackoffStrategy) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

Configure the backoff strategy used by the retry strategy.

build() - Method in class com.ibm.cos.v2.retries.api.internal.RefreshRetryTokenRequestImpl.Builder

build() - Method in interface com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest.Builder

Builds and returns a new instance of .

build() - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

Build a new RetryStrategy with the current configuration on this builder.

builder() - Static method in class com.ibm.cos.v2.retries.api.internal.RefreshRetryTokenRequestImpl

Returns a new builder to create a new instance of RefreshRetryTokenRequest

builder() - Static method in interface com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest

Returns a new builder to configure the RefreshRetryTokenRequest instance.

C

com.ibm.cos.v2.retries.api - package com.ibm.cos.v2.retries.api

com.ibm.cos.v2.retries.api.internal - package com.ibm.cos.v2.retries.api.internal

com.ibm.cos.v2.retries.api.internal.backoff - package com.ibm.cos.v2.retries.api.internal.backoff

computeDelay(int) - Method in interface com.ibm.cos.v2.retries.api.BackoffStrategy

Compute the amount of time to wait before the provided attempt number is executed.

computeDelay(int) - Method in class com.ibm.cos.v2.retries.api.internal.backoff.ExponentialDelayWithHalfJitter

computeDelay(int) - Method in class com.ibm.cos.v2.retries.api.internal.backoff.ExponentialDelayWithJitter

computeDelay(int) - Method in class com.ibm.cos.v2.retries.api.internal.backoff.ExponentialDelayWithoutJitter

computeDelay(int) - Method in class com.ibm.cos.v2.retries.api.internal.backoff.FixedDelayWithJitter

computeDelay(int) - Method in class com.ibm.cos.v2.retries.api.internal.backoff.FixedDelayWithoutJitter

computeDelay(int) - Method in class com.ibm.cos.v2.retries.api.internal.backoff.Immediately

create(String) - Static method in interface com.ibm.cos.v2.retries.api.AcquireInitialTokenRequest

Creates a new AcquireInitialTokenRequest instance with the given scope.

create(RetryToken, Duration) - Static method in interface com.ibm.cos.v2.retries.api.AcquireInitialTokenResponse

Creates a new AcquireInitialTokenRequest instance with the given scope.

create(String) - Static method in class com.ibm.cos.v2.retries.api.internal.AcquireInitialTokenRequestImpl

Creates a new AcquireInitialTokenRequestImpl instance with the given scope.

create(RetryToken, Duration) - Static method in class com.ibm.cos.v2.retries.api.internal.AcquireInitialTokenResponseImpl

Creates a new AcquireInitialTokenResponseImpl instance with the given token and suggested delay values.

create(RetryToken) - Static method in class com.ibm.cos.v2.retries.api.internal.RecordSuccessRequestImpl

create(RetryToken) - Static method in class com.ibm.cos.v2.retries.api.internal.RecordSuccessResponseImpl

Creates a new RecordSuccessResponseImpl with the given token and responses.

create(RetryToken, Duration) - Static method in class com.ibm.cos.v2.retries.api.internal.RefreshRetryTokenResponseImpl

Creates a new RefreshRetryTokenResponse with the given token and delay.

create(RetryToken) - Static method in interface com.ibm.cos.v2.retries.api.RecordSuccessRequest

Creates a new RecordSuccessRequest instance with the given token.

create(RetryToken) - Static method in interface com.ibm.cos.v2.retries.api.RecordSuccessResponse

Creates a new RecordSuccessResponseImpl with the given token.

create(RetryToken, Duration) - Static method in interface com.ibm.cos.v2.retries.api.RefreshRetryTokenResponse

Creates a new RefreshRetryTokenResponse with the given token and delay.

D

delay() - Method in interface com.ibm.cos.v2.retries.api.AcquireInitialTokenResponse

The amount of time to wait before performing the first attempt.

delay() - Method in class com.ibm.cos.v2.retries.api.internal.AcquireInitialTokenResponseImpl

delay() - Method in class com.ibm.cos.v2.retries.api.internal.RefreshRetryTokenResponseImpl

delay() - Method in interface com.ibm.cos.v2.retries.api.RefreshRetryTokenResponse

The amount of time to wait before performing the next attempt.

E

exponentialDelay(Duration, Duration) - Static method in interface com.ibm.cos.v2.retries.api.BackoffStrategy

Wait for a random period of time between 0ms and an exponentially increasing amount of time between each subsequent attempt of the same call.

exponentialDelayHalfJitter(Duration, Duration) - Static method in interface com.ibm.cos.v2.retries.api.BackoffStrategy

Wait for a random period of time with an upper bound of exponentially increasing amount of time between each subsequent attempt of the same call and a lower bound of half the amount of the computed exponential delay.

ExponentialDelayWithHalfJitter - Class in com.ibm.cos.v2.retries.api.internal.backoff

Strategy that waits for a random period of time between a lower bound x and an exponentially increasing amount of time between each subsequent attempt of the same call.

ExponentialDelayWithHalfJitter(Supplier<Random>, Duration, Duration) - Constructor for class com.ibm.cos.v2.retries.api.internal.backoff.ExponentialDelayWithHalfJitter

ExponentialDelayWithJitter - Class in com.ibm.cos.v2.retries.api.internal.backoff

Strategy that waits for a random period of time between 0ms and an exponentially increasing amount of time between each subsequent attempt of the same call.

ExponentialDelayWithJitter(Supplier<Random>, Duration, Duration) - Constructor for class com.ibm.cos.v2.retries.api.internal.backoff.ExponentialDelayWithJitter

exponentialDelayWithoutJitter(Duration, Duration) - Static method in interface com.ibm.cos.v2.retries.api.BackoffStrategy

Wait for an exponentially increasing amount of time between each subsequent attempt of the same call.

ExponentialDelayWithoutJitter - Class in com.ibm.cos.v2.retries.api.internal.backoff

Strategy that waits for an exponentially increasing amount of time between each subsequent attempt of the same call.

ExponentialDelayWithoutJitter(Duration, Duration) - Constructor for class com.ibm.cos.v2.retries.api.internal.backoff.ExponentialDelayWithoutJitter

F

failure(Throwable) - Method in class com.ibm.cos.v2.retries.api.internal.RefreshRetryTokenRequestImpl.Builder

failure() - Method in class com.ibm.cos.v2.retries.api.internal.RefreshRetryTokenRequestImpl

failure(Throwable) - Method in interface com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest.Builder

Configures the latest caught exception.

failure() - Method in interface com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest

The cause of the last attempt failure.

fixedDelay(Duration) - Static method in interface com.ibm.cos.v2.retries.api.BackoffStrategy

Wait for a random period of time between 0ms and the provided delay.

FixedDelayWithJitter - Class in com.ibm.cos.v2.retries.api.internal.backoff

Strategy that waits for a random period of time between 0ms and the provided delay.

FixedDelayWithJitter(Supplier<Random>, Duration) - Constructor for class com.ibm.cos.v2.retries.api.internal.backoff.FixedDelayWithJitter

fixedDelayWithoutJitter(Duration) - Static method in interface com.ibm.cos.v2.retries.api.BackoffStrategy

Wait for a period of time equal to the provided delay.

FixedDelayWithoutJitter - Class in com.ibm.cos.v2.retries.api.internal.backoff

Strategy that waits for a period of time equal to the provided delay.

FixedDelayWithoutJitter(Duration) - Constructor for class com.ibm.cos.v2.retries.api.internal.backoff.FixedDelayWithoutJitter

I

Immediately - Class in com.ibm.cos.v2.retries.api.internal.backoff

Strategy that do not back off: retry immediately.

Immediately() - Constructor for class com.ibm.cos.v2.retries.api.internal.backoff.Immediately

M

maxAttempts(int) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

Configure the maximum number of attempts used by the retry strategy.

maxAttempts() - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy

Returns the maximum numbers attempts that this retry policy will allow.

R

recordSuccess(RecordSuccessRequest) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy

Invoked after an attempt succeeds.

RecordSuccessRequest - Interface in com.ibm.cos.v2.retries.api

Request that the calling code makes to the RetryStrategy using RetryStrategy.recordSuccess(RecordSuccessRequest) to notify that the attempted execution succeeded.

RecordSuccessRequestImpl - Class in com.ibm.cos.v2.retries.api.internal

Implementation of the RecordSuccessRequest interfface

RecordSuccessResponse - Interface in com.ibm.cos.v2.retries.api

Response given to the calling code by the RetryStrategy after calling RetryStrategy.recordSuccess(RecordSuccessRequest).

RecordSuccessResponseImpl - Class in com.ibm.cos.v2.retries.api.internal

Implementation of the RecordSuccessResponse interface.

refreshRetryToken(RefreshRetryTokenRequest) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy

Invoked before each subsequent (non-first) request attempt.

RefreshRetryTokenRequest - Interface in com.ibm.cos.v2.retries.api

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.

RefreshRetryTokenRequest.Builder - Interface in com.ibm.cos.v2.retries.api

RefreshRetryTokenRequestImpl - Class in com.ibm.cos.v2.retries.api.internal

Implementation of the RefreshRetryTokenRequest interface.

RefreshRetryTokenRequestImpl.Builder - Class in com.ibm.cos.v2.retries.api.internal

RefreshRetryTokenResponse - Interface in com.ibm.cos.v2.retries.api

Response from the RetryStrategy after calling RetryStrategy.refreshRetryToken(RefreshRetryTokenRequest).

RefreshRetryTokenResponseImpl - Class in com.ibm.cos.v2.retries.api.internal

Implementation for the RefreshRetryTokenResponse interface.

retryImmediately() - Static method in interface com.ibm.cos.v2.retries.api.BackoffStrategy

Do not back off: retry immediately.

retryOnException(Predicate<Throwable>) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

Configure the strategy to retry when the provided predicate returns true, given a failure exception.

retryOnException(Class<? extends Throwable>) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

Configure the strategy to retry when a failure exception class is equal to the provided class.

retryOnExceptionInstanceOf(Class<? extends Throwable>) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

Configure the strategy to retry when a failure exception class is an instance of the provided class (includes subtypes).

retryOnExceptionOrCause(Class<? extends Throwable>) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

Configure the strategy to retry when a failure exception or one of its cause classes is equal to the provided class.

retryOnExceptionOrCauseInstanceOf(Class<? extends Throwable>) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

Configure the strategy to retry when a failure exception or one of its cause classes is an instance of the provided class (includes subtypes).

retryOnRootCause(Class<? extends Throwable>) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

Configure the strategy to retry the root cause of a failure (the final cause) a failure exception is equal to the provided class.

retryOnRootCauseInstanceOf(Class<? extends Throwable>) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

Configure the strategy to retry the root cause of a failure (the final cause) a failure exception is an instance of to the provided class (includes subtypes).

RetryStrategy - Interface in com.ibm.cos.v2.retries.api

A strategy used by an SDK to determine when something should be retried.

RetryStrategy.Builder<B extends RetryStrategy.Builder<B,T>,T extends RetryStrategy> - Interface in com.ibm.cos.v2.retries.api

Builder to create immutable instances of RetryStrategy.

RetryToken - Interface in com.ibm.cos.v2.retries.api

An opaque token representing an in-progress execution.

S

scope() - Method in interface com.ibm.cos.v2.retries.api.AcquireInitialTokenRequest

An abstract scope for the attempts about to be executed.

scope() - Method in class com.ibm.cos.v2.retries.api.internal.AcquireInitialTokenRequestImpl

suggestedDelay(Duration) - Method in class com.ibm.cos.v2.retries.api.internal.RefreshRetryTokenRequestImpl.Builder

suggestedDelay() - Method in class com.ibm.cos.v2.retries.api.internal.RefreshRetryTokenRequestImpl

suggestedDelay(Duration) - Method in interface com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest.Builder

Configures the suggested delay to used when refreshing the token.

suggestedDelay() - Method in interface com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest

A suggestion of how long to wait from the last attempt failure.

T

throttlingBackoffStrategy(BackoffStrategy) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

Configure the backoff strategy used for throttling exceptions by this strategy.

toBuilder() - Method in class com.ibm.cos.v2.retries.api.internal.RefreshRetryTokenRequestImpl

toBuilder() - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy

Create a new RetryStrategy.Builder with the current configuration.

token() - Method in interface com.ibm.cos.v2.retries.api.AcquireInitialTokenResponse

A RetryToken acquired by this invocation, used in subsequent RetryStrategy.refreshRetryToken(com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest) or RetryStrategy.recordSuccess(com.ibm.cos.v2.retries.api.RecordSuccessRequest) calls.

token() - Method in class com.ibm.cos.v2.retries.api.internal.AcquireInitialTokenResponseImpl

token() - Method in class com.ibm.cos.v2.retries.api.internal.RecordSuccessRequestImpl

token() - Method in class com.ibm.cos.v2.retries.api.internal.RecordSuccessResponseImpl

token(RetryToken) - Method in class com.ibm.cos.v2.retries.api.internal.RefreshRetryTokenRequestImpl.Builder

token() - Method in class com.ibm.cos.v2.retries.api.internal.RefreshRetryTokenRequestImpl

token() - Method in class com.ibm.cos.v2.retries.api.internal.RefreshRetryTokenResponseImpl

token() - Method in interface com.ibm.cos.v2.retries.api.RecordSuccessRequest

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.

token() - Method in interface com.ibm.cos.v2.retries.api.RecordSuccessResponse

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.

token(RetryToken) - Method in interface com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest.Builder

Configures the RetryToken to be refreshed.

token() - Method in interface com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest

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.

token() - Method in interface com.ibm.cos.v2.retries.api.RefreshRetryTokenResponse

A RetryToken acquired by this invocation, used in subsequent RetryStrategy.refreshRetryToken(com.ibm.cos.v2.retries.api.RefreshRetryTokenRequest) or RetryStrategy.recordSuccess(com.ibm.cos.v2.retries.api.RecordSuccessRequest) calls.

token() - Method in exception com.ibm.cos.v2.retries.api.TokenAcquisitionFailedException

Returns the retry token that tracked the execution.

TokenAcquisitionFailedException - Exception in com.ibm.cos.v2.retries.api

Exception thrown by RetryStrategy when a new token cannot be acquired.

TokenAcquisitionFailedException(String) - Constructor for exception com.ibm.cos.v2.retries.api.TokenAcquisitionFailedException

Exception construction accepting message with no root cause.

TokenAcquisitionFailedException(String, Throwable) - Constructor for exception com.ibm.cos.v2.retries.api.TokenAcquisitionFailedException

Exception constructor accepting message and a root cause.

TokenAcquisitionFailedException(String, RetryToken, Throwable) - Constructor for exception com.ibm.cos.v2.retries.api.TokenAcquisitionFailedException

Exception constructor accepting message, retry token, and a root cause.

toString() - Method in class com.ibm.cos.v2.retries.api.internal.backoff.ExponentialDelayWithHalfJitter

toString() - Method in class com.ibm.cos.v2.retries.api.internal.backoff.ExponentialDelayWithJitter

toString() - Method in class com.ibm.cos.v2.retries.api.internal.backoff.ExponentialDelayWithoutJitter

toString() - Method in class com.ibm.cos.v2.retries.api.internal.backoff.FixedDelayWithJitter

toString() - Method in class com.ibm.cos.v2.retries.api.internal.backoff.FixedDelayWithoutJitter

toString() - Method in class com.ibm.cos.v2.retries.api.internal.backoff.Immediately

treatAsThrottling(Predicate<Throwable>) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

Configure a predicate that determines whether a retryable exception is a throttling exception.

U

useClientDefaults(boolean) - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

Configure whether the default predicates should be used, or not.

useClientDefaults() - Method in interface com.ibm.cos.v2.retries.api.RetryStrategy

Returns whether the retry strategy uses default retry predicates.

A B C D E F I M R S T U