Package org.apache.flink.api.common.restartstrategy

Class RestartStrategies

java.lang.Object

org.apache.flink.api.common.restartstrategy.RestartStrategies

@PublicEvolving
public class RestartStrategies
extends Object

This class defines methods to generate RestartStrategyConfigurations. These configurations are used to create RestartStrategies at runtime.

The RestartStrategyConfigurations are used to decouple the core module from the runtime module.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RestartStrategies.ExponentialDelayRestartStrategyConfiguration	Configuration representing an exponential delay restart strategy.
static class	RestartStrategies.FailureRateRestartStrategyConfiguration	Configuration representing a failure rate restart strategy.
static class	RestartStrategies.FallbackRestartStrategyConfiguration	Restart strategy configuration that could be used by jobs to use cluster level restart strategy.
static class	RestartStrategies.FixedDelayRestartStrategyConfiguration	Configuration representing a fixed delay restart strategy.
static class	RestartStrategies.NoRestartStrategyConfiguration	Configuration representing no restart strategy.
static class	RestartStrategies.RestartStrategyConfiguration	Abstract configuration for restart strategies.

Constructor Summary

Constructors

Constructor	Description
RestartStrategies()

Method Summary

Modifier and Type	Method	Description
static RestartStrategies.ExponentialDelayRestartStrategyConfiguration	exponentialDelayRestart(Time initialBackoff, Time maxBackoff, double backoffMultiplier, Time resetBackoffThreshold, double jitterFactor)	Generates a ExponentialDelayRestartStrategyConfiguration.
static RestartStrategies.FailureRateRestartStrategyConfiguration	failureRateRestart(int failureRate, Time failureInterval, Time delayInterval)	Generates a FailureRateRestartStrategyConfiguration.
static RestartStrategies.RestartStrategyConfiguration	fallBackRestart()
static RestartStrategies.RestartStrategyConfiguration	fixedDelayRestart(int restartAttempts, long delayBetweenAttempts)	Generates a FixedDelayRestartStrategyConfiguration.
static RestartStrategies.RestartStrategyConfiguration	fixedDelayRestart(int restartAttempts, Time delayInterval)	Generates a FixedDelayRestartStrategyConfiguration.
static Optional<RestartStrategies.RestartStrategyConfiguration>	fromConfiguration(ReadableConfig configuration)	Reads a RestartStrategies.RestartStrategyConfiguration from a given ReadableConfig.
static RestartStrategies.RestartStrategyConfiguration	noRestart()	Generates NoRestartStrategyConfiguration.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestartStrategies

public RestartStrategies()

Method Detail

noRestart

public static RestartStrategies.RestartStrategyConfiguration noRestart()

Generates NoRestartStrategyConfiguration.

Returns:

NoRestartStrategyConfiguration

fallBackRestart

public static RestartStrategies.RestartStrategyConfiguration fallBackRestart()

fixedDelayRestart

public static RestartStrategies.RestartStrategyConfiguration fixedDelayRestart(int restartAttempts,
                                                                               long delayBetweenAttempts)

Generates a FixedDelayRestartStrategyConfiguration.

Parameters:

restartAttempts - Number of restart attempts for the FixedDelayRestartStrategy

delayBetweenAttempts - Delay in-between restart attempts for the FixedDelayRestartStrategy

Returns:

FixedDelayRestartStrategy

fixedDelayRestart

public static RestartStrategies.RestartStrategyConfiguration fixedDelayRestart(int restartAttempts,
                                                                               Time delayInterval)

Generates a FixedDelayRestartStrategyConfiguration.

Parameters:

restartAttempts - Number of restart attempts for the FixedDelayRestartStrategy

delayInterval - Delay in-between restart attempts for the FixedDelayRestartStrategy

Returns:

FixedDelayRestartStrategy

failureRateRestart

public static RestartStrategies.FailureRateRestartStrategyConfiguration failureRateRestart(int failureRate,
                                                                                           Time failureInterval,
                                                                                           Time delayInterval)

Generates a FailureRateRestartStrategyConfiguration.

Parameters:

failureRate - Maximum number of restarts in given interval failureInterval before failing a job

failureInterval - Time interval for failures

delayInterval - Delay in-between restart attempts

exponentialDelayRestart

public static RestartStrategies.ExponentialDelayRestartStrategyConfiguration exponentialDelayRestart(Time initialBackoff,
                                                                                                     Time maxBackoff,
                                                                                                     double backoffMultiplier,
                                                                                                     Time resetBackoffThreshold,
                                                                                                     double jitterFactor)

Generates a ExponentialDelayRestartStrategyConfiguration.

Parameters:

initialBackoff - Starting duration between restarts

maxBackoff - The highest possible duration between restarts

backoffMultiplier - Delay multiplier how many times is the delay longer than before

resetBackoffThreshold - How long the job must run smoothly to reset the time interval

jitterFactor - How much the delay may differ (in percentage)

fromConfiguration

public static Optional<RestartStrategies.RestartStrategyConfiguration> fromConfiguration(ReadableConfig configuration)

Reads a RestartStrategies.RestartStrategyConfiguration from a given ReadableConfig.

Parameters:

configuration - configuration object to retrieve parameters from

Returns:

Optional.empty() when no restart strategy parameters provided