org.apache.samza.table.retry

Class TableRetryPolicy

java.lang.Object

org.apache.samza.table.retry.TableRetryPolicy

All Implemented Interfaces:

java.io.Serializable, TablePart

public class TableRetryPolicy
extends java.lang.Object
implements TablePart, java.io.Serializable

Common retry policy parameters for table IO. This serves as an abstraction on top of retry libraries. This common policy supports below features: - backoff modes: fixed, random, exponential - termination modes: by attempts, by duration - jitter Retry libraries can implement a subset or all features as described by this common policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TableRetryPolicy.RetryPredicate Serializable adapter interface for Predicate.

Constructor Summary

Constructors

Constructor and Description
TableRetryPolicy()

Method Summary

Modifier and Type	Method and Description
org.apache.samza.table.retry.TableRetryPolicy.BackoffType	getBackoffType()
double	getExponentialFactor()
java.time.Duration	getExponentialMaxSleep()
java.time.Duration	getJitter() Introduce randomness to the sleepTime time.
java.lang.Integer	getMaxAttempts() Termination after a fix number of attempts.
java.time.Duration	getMaxDuration() Termination after a fixed duration.
java.time.Duration	getRandomMax()
java.time.Duration	getRandomMin()
TableRetryPolicy.RetryPredicate	getRetryPredicate()
java.time.Duration	getSleepTime()
java.util.Map<java.lang.String,java.lang.String>	toConfig(Config jobConfig, Config tableConfig) Generate configuration for this building block.
TableRetryPolicy	withExponentialBackoff(java.time.Duration sleepTime, java.time.Duration maxSleep, double factor) Set the parameters for the exponential backoff policy.
TableRetryPolicy	withFixedBackoff(java.time.Duration sleepTime) Set the sleepTime time for the fixed backoff policy.
TableRetryPolicy	withJitter(java.time.Duration jitter) Set the jitter for the backoff policy to provide additional randomness.
TableRetryPolicy	withRandomBackoff(java.time.Duration minSleep, java.time.Duration maxSleep) Set the sleepTime time for the random backoff policy.
TableRetryPolicy	withRetryPredicate(TableRetryPolicy.RetryPredicate retryPredicate) Set the predicate to use for identifying retriable exceptions.
TableRetryPolicy	withStopAfterAttempts(int maxAttempts) Set maximum number of attempts before terminating the operation.
TableRetryPolicy	withStopAfterDelay(java.time.Duration maxDelay) Set maximum total delay (sleepTime + execution) before terminating the operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableRetryPolicy

public TableRetryPolicy()

Method Detail

withFixedBackoff

public TableRetryPolicy withFixedBackoff(java.time.Duration sleepTime)

Set the sleepTime time for the fixed backoff policy.

Parameters:

sleepTime - sleepTime time

Returns:

this policy instance

withRandomBackoff

public TableRetryPolicy withRandomBackoff(java.time.Duration minSleep,
                                          java.time.Duration maxSleep)

Set the sleepTime time for the random backoff policy. The actual sleepTime time before each attempt is randomly selected between [minSleep, maxSleep]

Parameters:

minSleep - lower bound sleepTime time

maxSleep - upper bound sleepTime time

Returns:

this policy instance

withExponentialBackoff

public TableRetryPolicy withExponentialBackoff(java.time.Duration sleepTime,
                                               java.time.Duration maxSleep,
                                               double factor)

Set the parameters for the exponential backoff policy. The actual sleepTime time is exponentially incremented up to the maxSleep and multiplying successive delays by the factor.

Parameters:

sleepTime - initial sleepTime time

maxSleep - upper bound sleepTime time

factor - exponential factor for backoff

Returns:

this policy instance

withJitter

public TableRetryPolicy withJitter(java.time.Duration jitter)

Set the jitter for the backoff policy to provide additional randomness. If this is set, a random value between [0, jitter] will be added to each sleepTime time. This applies to FIXED and EXPONENTIAL modes only.

Parameters:

jitter - initial sleepTime time

Returns:

this policy instance

withStopAfterAttempts

public TableRetryPolicy withStopAfterAttempts(int maxAttempts)

Set maximum number of attempts before terminating the operation.

Parameters:

maxAttempts - number of attempts

Returns:

this policy instance

withStopAfterDelay

public TableRetryPolicy withStopAfterDelay(java.time.Duration maxDelay)

Set maximum total delay (sleepTime + execution) before terminating the operation.

Parameters:

maxDelay - delay time

Returns:

this policy instance

withRetryPredicate

public TableRetryPolicy withRetryPredicate(TableRetryPolicy.RetryPredicate retryPredicate)

Set the predicate to use for identifying retriable exceptions. If specified, table retry logic will consult both such predicate and table function and retry will be attempted if either option returns true.

Parameters:

retryPredicate - predicate for retriable exception identification

Returns:

this policy instance

getSleepTime

public java.time.Duration getSleepTime()

Returns:

initial/fixed sleep time.

getRandomMin

public java.time.Duration getRandomMin()

Returns:

lower sleepTime time for random backoff or null if policyType is not RANDOM.

getRandomMax

public java.time.Duration getRandomMax()

Returns:

upper sleepTime time for random backoff or null if policyType is not RANDOM.

getExponentialFactor

public double getExponentialFactor()

Returns:

exponential factor for exponential backoff.

getExponentialMaxSleep

public java.time.Duration getExponentialMaxSleep()

Returns:

maximum sleepTime time for exponential backoff or null if policyType is not EXPONENTIAL.

getJitter

public java.time.Duration getJitter()

Introduce randomness to the sleepTime time.

Returns:

jitter to add on to each backoff or null if not set.

getMaxAttempts

public java.lang.Integer getMaxAttempts()

Termination after a fix number of attempts.

Returns:

maximum number of attempts without success before giving up the operation or null if not set.

getMaxDuration

public java.time.Duration getMaxDuration()

Termination after a fixed duration.

Returns:

maximum duration without success before giving up the operation or null if not set.

getBackoffType

public org.apache.samza.table.retry.TableRetryPolicy.BackoffType getBackoffType()

Returns:

type of the backoff.

getRetryPredicate

public TableRetryPolicy.RetryPredicate getRetryPredicate()

Returns:

Custom predicate for retriable exception identification or null if not specified.

toConfig

public java.util.Map<java.lang.String,java.lang.String> toConfig(Config jobConfig,
                                                                 Config tableConfig)

Generate configuration for this building block. There are situations where this object or its external dependencies may require certain configuration, this method allows generation and inclusion of them in the job configuration.

Specified by:

toConfig in interface TablePart

Parameters:

jobConfig - job configuration

tableConfig - so far generated configuration for this table

Returns:

configuration for this build block