Package 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	Description
RetryAlgorithm(ResultRetryAlgorithm<ResponseT> resultAlgorithm, TimedRetryAlgorithm timedAlgorithm)	Deprecated. use RetryAlgorithm(ResultRetryAlgorithmWithContext, TimedRetryAlgorithmWithContext) instead
RetryAlgorithm(ResultRetryAlgorithmWithContext<ResponseT> resultAlgorithm, TimedRetryAlgorithmWithContext 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	Description
TimedAttemptSettings	createFirstAttempt()	Deprecated. use createFirstAttempt(RetryingContext) instead
TimedAttemptSettings	createFirstAttempt(RetryingContext context)	Creates a first attempt TimedAttemptSettings.
TimedAttemptSettings	createNextAttempt(RetryingContext context, Throwable previousThrowable, ResponseT previousResponse, TimedAttemptSettings previousSettings)	Creates a next attempt TimedAttemptSettings.
TimedAttemptSettings	createNextAttempt(Throwable previousThrowable, ResponseT previousResponse, TimedAttemptSettings previousSettings)	Deprecated. use createNextAttempt(RetryingContext, Throwable, Object, TimedAttemptSettings) instead
ResultRetryAlgorithm<ResponseT>	getResultAlgorithm()
TimedRetryAlgorithm	getTimedAlgorithm()
boolean	shouldRetry(RetryingContext context, Throwable previousThrowable, ResponseT previousResponse, TimedAttemptSettings nextAttemptSettings)	Returns true if another attempt should be made, or false otherwise.
boolean	shouldRetry(Throwable previousThrowable, ResponseT previousResponse, TimedAttemptSettings nextAttemptSettings)	Deprecated. use shouldRetry(RetryingContext, Throwable, Object, TimedAttemptSettings) instead

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryAlgorithm

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

Deprecated.

use RetryAlgorithm(ResultRetryAlgorithmWithContext, TimedRetryAlgorithmWithContext) instead

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.

Instances that are created using this constructor will ignore the RetryingContext that is passed in to the retrying methods. Use RetryAlgorithm(ResultRetryAlgorithmWithContext, TimedRetryAlgorithmWithContext) to create an instance that will respect the RetryingContext.

Parameters:

resultAlgorithm - result algorithm to use

timedAlgorithm - timed algorithm to use

RetryAlgorithm

public RetryAlgorithm(ResultRetryAlgorithmWithContext<ResponseT> resultAlgorithm,
                      TimedRetryAlgorithmWithContext 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

@Deprecated
public TimedAttemptSettings createFirstAttempt()

Deprecated.

use createFirstAttempt(RetryingContext) instead

Creates a first attempt TimedAttemptSettings.

Returns:

first attempt settings

createFirstAttempt

public TimedAttemptSettings createFirstAttempt(RetryingContext context)

Creates a first attempt TimedAttemptSettings.

Parameters:

context - the RetryingContext that can be used to get the initial RetrySettings

Returns:

first attempt settings

createNextAttempt

@Deprecated
public TimedAttemptSettings createNextAttempt(Throwable previousThrowable,
                                              ResponseT previousResponse,
                                              TimedAttemptSettings previousSettings)

Deprecated.

use createNextAttempt(RetryingContext, Throwable, Object, TimedAttemptSettings) instead

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:

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

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

previousSettings - previous attempt settings

Returns:

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

createNextAttempt

public TimedAttemptSettings createNextAttempt(RetryingContext context,
                                              Throwable previousThrowable,
                                              ResponseT previousResponse,
                                              TimedAttemptSettings previousSettings)

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:

context - the RetryingContext that can be used to determine the RetrySettings for the next attempt

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

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

previousSettings - previous attempt settings

Returns:

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

shouldRetry

@Deprecated
public boolean shouldRetry(Throwable previousThrowable,
                           ResponseT previousResponse,
                           TimedAttemptSettings nextAttemptSettings)
                    throws CancellationException

Deprecated.

use shouldRetry(RetryingContext, Throwable, Object, TimedAttemptSettings) instead

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

Parameters:

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

previousResponse - 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

shouldRetry

public boolean shouldRetry(RetryingContext context,
                           Throwable previousThrowable,
                           ResponseT previousResponse,
                           TimedAttemptSettings nextAttemptSettings)
                    throws CancellationException

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

Parameters:

context - the RetryingContext that can be used to determine whether another attempt should be made

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

previousResponse - 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 cancelled

getResultAlgorithm

@BetaApi("Surface for inspecting the a RetryAlgorithm is not yet stable")
public ResultRetryAlgorithm<ResponseT> getResultAlgorithm()

getTimedAlgorithm

@BetaApi("Surface for inspecting the a RetryAlgorithm is not yet stable")
public TimedRetryAlgorithm getTimedAlgorithm()