com.google.api.gax.retrying

Interface ResultRetryAlgorithm<ResponseT>

Type Parameters:

ResponseT - response type

All Known Implementing Classes:

BasicResultRetryAlgorithm, OperationResponsePollAlgorithm

public interface ResultRetryAlgorithm<ResponseT>

A result retry algorithm is responsible for the following operations (based on the response returned by the previous attempt or on the thrown exception):

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

Implementations of this interface must be thread-safe.

Method Summary

Modifier and Type	Method and Description
TimedAttemptSettings	createNextAttempt(Throwable prevThrowable, ResponseT prevResponse, TimedAttemptSettings prevSettings) Creates a next attempt TimedAttemptSettings.
boolean	shouldRetry(Throwable prevThrowable, ResponseT prevResponse) Returns true if another attempt should be made, or false otherwise.

Method Detail

createNextAttempt

TimedAttemptSettings createNextAttempt(Throwable prevThrowable,
                                       ResponseT prevResponse,
                                       TimedAttemptSettings prevSettings)

Creates a next attempt TimedAttemptSettings.

Parameters:

prevThrowable - exception thrown by the previous attempt (null, if none)

prevResponse - response returned by the previous attempt

prevSettings - 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(Throwable prevThrowable,
                    ResponseT prevResponse)
             throws CancellationException

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

Parameters:

prevThrowable - exception thrown by the previous attempt (null, if none)

prevResponse - response returned by the previous attempt

Throws:

CancellationException - if the retrying process should be canceled