Class StreamingRetryAlgorithm<ResponseT> (2.83.0)

2.83.0 (latest) 2.82.0 2.81.0 2.80.0 2.79.0 2.76.0 2.75.0 2.74.1 2.73.1 2.72.2 2.71.0 2.70.3 2.69.0 2.68.2 2.67.0 2.66.0 2.65.0 2.63.1 2.62.0 2.61.0 2.60.0 2.59.1 2.58.0 2.57.0 2.55.0 2.54.1 2.53.0 2.52.0 2.51.0 2.50.0 2.49.0 2.48.1 2.47.0 2.46.1 2.45.0 2.43.0 2.42.0 2.41.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.1 2.33.0 2.32.1 2.31.1 2.30.1 2.24.0 2.23.3 2.22.0 2.21.0 2.20.1 2.19.6 2.18.7 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.2 2.11.0 2.10.0 2.9.0 2.8.1 2.7.1

public final class StreamingRetryAlgorithm<ResponseT> extends RetryAlgorithm<ResponseT>

The streaming retry algorithm, which makes decision based either on the thrown exception and the execution time settings of the previous attempt. This extends RetryAlgorithm to take additional information (provided by ServerStreamingAttemptCallable) into account.

This class is thread-safe.

Internal use only - public for technical reasons.

Inheritance

java.lang.Object > RetryAlgorithm > StreamingRetryAlgorithm<ResponseT>

Inherited Members

RetryAlgorithm.createFirstAttempt()

RetryAlgorithm.createFirstAttempt(@Nullable RetryingContext)

RetryAlgorithm.createNextAttempt(@Nullable RetryingContext,@Nullable Throwable,@Nullable ResponseT,TimedAttemptSettings)

RetryAlgorithm.createNextAttempt(Throwable,ResponseT,TimedAttemptSettings)

RetryAlgorithm.getResultAlgorithm()

RetryAlgorithm.getTimedAlgorithm()

RetryAlgorithm.shouldRetry(@Nullable RetryingContext,@Nullable Throwable,@Nullable ResponseT,TimedAttemptSettings)

RetryAlgorithm.shouldRetry(Throwable,ResponseT,TimedAttemptSettings)

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Type Parameter
Name	Description
ResponseT

Constructors

StreamingRetryAlgorithm(ResultRetryAlgorithm<ResponseT> resultAlgorithm, TimedRetryAlgorithm timedAlgorithm) (deprecated)

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

Deprecated. use #StreamingRetryAlgorithm(ResultRetryAlgorithmWithContext, TimedRetryAlgorithmWithContext) instead

Instances that are created using this constructor will ignore the RetryingContext that is passed in to the retrying methods. Use <xref uid="com.google.api.gax.retrying.StreamingRetryAlgorithm.StreamingRetryAlgorithm(com.google.api.gax.retrying.ResultRetryAlgorithmWithContext<ResponseT>,com.google.api.gax.retrying.TimedRetryAlgorithmWithContext)" data-throw-if-not-resolved="false">#StreamingRetryAlgorithm(ResultRetryAlgorithmWithContext, TimedRetryAlgorithmWithContext) to create an instance that will respect the RetryingContext.

Parameters
Name	Description
resultAlgorithm	ResultRetryAlgorithm<ResponseT>
timedAlgorithm	TimedRetryAlgorithm

StreamingRetryAlgorithm(ResultRetryAlgorithmWithContext<ResponseT> resultAlgorithm, TimedRetryAlgorithmWithContext timedAlgorithm)

public StreamingRetryAlgorithm(ResultRetryAlgorithmWithContext<ResponseT> resultAlgorithm, TimedRetryAlgorithmWithContext timedAlgorithm)

Creates a StreamingRetryAlgorithm that will use the settings (if any) in the RetryingContext that is passed in to the retrying methods.

Parameters
Name	Description
resultAlgorithm	ResultRetryAlgorithmWithContext<ResponseT>
timedAlgorithm	TimedRetryAlgorithmWithContext

Methods

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

public @Nullable TimedAttemptSettings createNextAttempt(@Nullable RetryingContext context, @Nullable Throwable previousThrowable, @Nullable 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.

The attempt settings will be reset if the stream attempt produced any messages.

Parameters
Name	Description
context	@org.jspecify.annotations.Nullable com.google.api.gax.retrying.RetryingContext
previousThrowable	@org.jspecify.annotations.Nullable java.lang.Throwable
previousResponse	@org.jspecify.annotations.Nullable ResponseT
previousSettings	TimedAttemptSettings

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.api.gax.retrying.TimedAttemptSettings

Overrides

RetryAlgorithm<ResponseT>.createNextAttempt(@Nullable RetryingContext context, @Nullable Throwable previousThrowable, @Nullable ResponseT previousResponse, TimedAttemptSettings previousSettings)

createNextAttempt(@Nullable Throwable previousThrowable, @Nullable ResponseT previousResponse, TimedAttemptSettings previousSettings)

public @Nullable TimedAttemptSettings createNextAttempt(@Nullable Throwable previousThrowable, @Nullable 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.

The attempt settings will be reset if the stream attempt produced any messages.

Parameters
Name	Description
previousThrowable	@org.jspecify.annotations.Nullable java.lang.Throwable
previousResponse	@org.jspecify.annotations.Nullable ResponseT
previousSettings	TimedAttemptSettings

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.api.gax.retrying.TimedAttemptSettings

Overrides

RetryAlgorithm<ResponseT>.createNextAttempt(Throwable previousThrowable, ResponseT previousResponse, TimedAttemptSettings previousSettings)

shouldRetry(@Nullable RetryingContext context, @Nullable Throwable previousThrowable, @Nullable ResponseT previousResponse, TimedAttemptSettings nextAttemptSettings)

public boolean shouldRetry(@Nullable RetryingContext context, @Nullable Throwable previousThrowable, @Nullable ResponseT previousResponse, TimedAttemptSettings nextAttemptSettings)

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

Schedules retries only if the StreamResumptionStrategy in the ServerStreamingAttemptCallable supports it.

Parameters
Name	Description
context	@org.jspecify.annotations.Nullable com.google.api.gax.retrying.RetryingContext
previousThrowable	@org.jspecify.annotations.Nullable java.lang.Throwable
previousResponse	@org.jspecify.annotations.Nullable ResponseT
nextAttemptSettings	TimedAttemptSettings

Returns
Type	Description
boolean

Overrides

RetryAlgorithm<ResponseT>.shouldRetry(@Nullable RetryingContext context, @Nullable Throwable previousThrowable, @Nullable ResponseT previousResponse, TimedAttemptSettings nextAttemptSettings)

Exceptions
Type	Description
CancellationException

shouldRetry(@Nullable Throwable previousThrowable, @Nullable ResponseT previousResponse, TimedAttemptSettings nextAttemptSettings)

public boolean shouldRetry(@Nullable Throwable previousThrowable, @Nullable ResponseT previousResponse, TimedAttemptSettings nextAttemptSettings)

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

Ensures retries are only scheduled if the StreamResumptionStrategy in the ServerStreamingAttemptCallable supports it.

Parameters
Name	Description
previousThrowable	@org.jspecify.annotations.Nullable java.lang.Throwable
previousResponse	@org.jspecify.annotations.Nullable ResponseT
nextAttemptSettings	TimedAttemptSettings

Returns
Type	Description
boolean

Overrides

RetryAlgorithm<ResponseT>.shouldRetry(Throwable previousThrowable, ResponseT previousResponse, TimedAttemptSettings nextAttemptSettings)

Exceptions
Type	Description
CancellationException