com.google.api.gax.retrying

Interface TimedRetryAlgorithmWithContext

All Superinterfaces:

TimedRetryAlgorithm

All Known Implementing Classes:

ExponentialPollAlgorithm, ExponentialRetryAlgorithm, OperationTimedPollAlgorithm

public interface TimedRetryAlgorithmWithContext
extends TimedRetryAlgorithm

A timed retry algorithm is responsible for the following operations, based on the previous attempt settings and current time:

1. Creating first attempt TimedAttemptSettings.
2. Accepting a task for retry so another attempt will be made.
3. Canceling retrying process so the related Future will be canceled.
4. Creating TimedAttemptSettings for each subsequent retry attempt.

Implementations of this interface receive a RetryingContext that can contain specific RetrySettings and retryable codes that should be used to determine the retry behavior.

Implementations of this interface must be be thread-save.

Method Summary

Modifier and Type	Method and Description
TimedAttemptSettings	createFirstAttempt(RetryingContext context) Creates a first attempt TimedAttemptSettings.
TimedAttemptSettings	createNextAttempt(RetryingContext context, TimedAttemptSettings previousSettings) Creates a next attempt TimedAttemptSettings, which defines properties of the next attempt.
boolean	shouldRetry(RetryingContext context, TimedAttemptSettings nextAttemptSettings) Returns true if another attempt should be made, or false otherwise.

Methods inherited from interface com.google.api.gax.retrying.TimedRetryAlgorithm

createFirstAttempt, createNextAttempt, shouldRetry

Method Detail

createFirstAttempt

TimedAttemptSettings createFirstAttempt(RetryingContext context)

Creates a first attempt TimedAttemptSettings.

Parameters:

context - a RetryingContext that can contain custom RetrySettings and retryable codes

Returns:

first attempt settings

createNextAttempt

TimedAttemptSettings createNextAttempt(RetryingContext context,
                                       TimedAttemptSettings previousSettings)

Creates a next attempt TimedAttemptSettings, which defines properties of the next attempt.

Parameters:

context - a RetryingContext that can contain custom RetrySettings and retryable codes

previousSettings - previous attempt settings

Returns:

next attempt settings or null if the implementing algorithm does not provide specific settings for the next attempt

shouldRetry

boolean shouldRetry(RetryingContext context,
                    TimedAttemptSettings nextAttemptSettings)

Returns true if another attempt should be made, or false otherwise.

Parameters:

context - a RetryingContext that can contain custom RetrySettings and retryable codes.

nextAttemptSettings - attempt settings, which will be used for the next attempt, if accepted

Throws:

CancellationException - if the retrying process should be canceled