com.google.api.gax.retrying

Class RetryAlgorithm<ResponseT>

java.lang.Object

com.google.api.gax.retrying.RetryAlgorithm<ResponseT>

Type Parameters:

ResponseT - response type

Direct Known Subclasses:

StreamingRetryAlgorithm

public class RetryAlgorithm<ResponseT>
extends Object

The retry algorithm, which makes decision based either on the thrown exception or the returned response, and the execution time settings of the previous attempt.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
RetryAlgorithm(ResultRetryAlgorithm<ResponseT> resultAlgorithm, TimedRetryAlgorithm timedAlgorithm) Creates a new retry algorithm instance, which uses thrown exception or returned response and timed algorithms to make a decision.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryAlgorithm

public RetryAlgorithm(ResultRetryAlgorithm<ResponseT> resultAlgorithm,
                      TimedRetryAlgorithm timedAlgorithm)

Creates a new retry algorithm instance, which uses thrown exception or returned response and timed algorithms to make a decision. The result algorithm has higher priority than the timed algorithm.

Parameters:

resultAlgorithm - result algorithm to use

timedAlgorithm - timed algorithm to use

Method Detail

createFirstAttempt

public TimedAttemptSettings createFirstAttempt()

Creates a first attempt TimedAttemptSettings.

Returns:

first attempt settings

createNextAttempt

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

Creates a next attempt TimedAttemptSettings. This method will return first non-null value, returned by either result or timed retry algorithms in that particular order.

Parameters:

prevThrowable - exception thrown by the previous attempt or null if a result was returned instead

prevResponse - response returned by the previous attempt or null if an exception was thrown instead

prevSettings - previous attempt settings

Returns:

next attempt settings, can be null, if no there should be no new attempt

shouldRetry

public boolean shouldRetry(Throwable prevThrowable,
                           ResponseT prevResponse,
                           TimedAttemptSettings nextAttemptSettings)
                    throws CancellationException

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

Parameters:

prevThrowable - exception thrown by the previous attempt or null if a result was returned instead

prevResponse - response returned by the previous attempt or null if an exception was thrown instead

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

Returns:

true if another attempt should be made, or false otherwise

Throws:

CancellationException - if the retrying process should be canceled