com.google.cloud.dataflow.sdk.util

Class AttemptAndTimeBoundedExponentialBackOff

java.lang.Object

com.google.cloud.dataflow.sdk.util.AttemptBoundedExponentialBackOff

com.google.cloud.dataflow.sdk.util.AttemptAndTimeBoundedExponentialBackOff

All Implemented Interfaces:

com.google.api.client.util.BackOff

public class AttemptAndTimeBoundedExponentialBackOff
extends AttemptBoundedExponentialBackOff

Extension of AttemptBoundedExponentialBackOff that bounds the total time that the backoff is happening as well as the amount of retries. Acts exactly as a AttemptBoundedExponentialBackOff unless the time interval has expired since the object was created. At this point, it will always return BackOff.STOP. Note that reset does not reset the timer.

Implementation is not thread-safe.

Field Summary

Fields inherited from class com.google.cloud.dataflow.sdk.util.AttemptBoundedExponentialBackOff

DEFAULT_MULTIPLIER, DEFAULT_RANDOMIZATION_FACTOR

Fields inherited from interface com.google.api.client.util.BackOff

STOP, STOP_BACKOFF, ZERO_BACKOFF

Constructor Summary

Constructors

Constructor and Description
AttemptAndTimeBoundedExponentialBackOff(int maximumNumberOfAttempts, long initialIntervalMillis, long maximumTotalWaitTimeMillis) Constructs an instance of AttemptAndTimeBoundedExponentialBackoff.
AttemptAndTimeBoundedExponentialBackOff(int maximumNumberOfAttempts, long initialIntervalMillis, long maximumTotalWaitTimeMillis, com.google.api.client.util.NanoClock nanoClock) Constructs an instance of AttemptAndTimeBoundedExponentialBackoff.

Method Summary

Modifier and Type	Method and Description
boolean	atMaxAttempts()
long	nextBackOffMillis()
void	setEndtimeMillis(long endTimeMillis)

Methods inherited from class com.google.cloud.dataflow.sdk.util.AttemptBoundedExponentialBackOff

reset

Methods inherited from class java.lang.Object

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

Constructor Detail

AttemptAndTimeBoundedExponentialBackOff

public AttemptAndTimeBoundedExponentialBackOff(int maximumNumberOfAttempts,
                                               long initialIntervalMillis,
                                               long maximumTotalWaitTimeMillis)

Constructs an instance of AttemptAndTimeBoundedExponentialBackoff.

Parameters:

maximumNumberOfAttempts - The maximum number of attempts it will make.

initialIntervalMillis - The original interval to wait between attempts in milliseconds.

maximumTotalWaitTimeMillis - The maximum total time that this object will allow more attempts in milliseconds.

AttemptAndTimeBoundedExponentialBackOff

public AttemptAndTimeBoundedExponentialBackOff(int maximumNumberOfAttempts,
                                               long initialIntervalMillis,
                                               long maximumTotalWaitTimeMillis,
                                               com.google.api.client.util.NanoClock nanoClock)

Constructs an instance of AttemptAndTimeBoundedExponentialBackoff.

Parameters:

maximumNumberOfAttempts - The maximum number of attempts it will make.

initialIntervalMillis - The original interval to wait between attempts in milliseconds.

maximumTotalWaitTimeMillis - The maximum total time that this object will allow more attempts in milliseconds.

nanoClock - clock used to measure the time that has passed.

Method Detail

setEndtimeMillis

public void setEndtimeMillis(long endTimeMillis)

nextBackOffMillis

public long nextBackOffMillis()

Specified by:

nextBackOffMillis in interface com.google.api.client.util.BackOff

Overrides:

nextBackOffMillis in class AttemptBoundedExponentialBackOff

atMaxAttempts

public boolean atMaxAttempts()

Overrides:

atMaxAttempts in class AttemptBoundedExponentialBackOff