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

Class RestartStrategies

java.lang.Object

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

@Deprecated
@PublicEvolving
public class RestartStrategies
extends Object

Deprecated.

The RestartStrategies class is marked as deprecated because starting from Flink 1.19, all complex Java objects related to configuration should be replaced by ConfigOption. In a future major version of Flink, this class will be removed entirely. It is recommended to switch to using the ConfigOptions provided by RestartStrategyOptions for configuring restart strategies like the following code snippet:

 Configuration config = new Configuration();
 config.set(RestartStrategyOptions.RESTART_STRATEGY, "fixed-delay");
 config.set(RestartStrategyOptions.RESTART_STRATEGY_FIXED_DELAY_ATTEMPTS, 3);
 config.set(RestartStrategyOptions.RESTART_STRATEGY_FIXED_DELAY_DELAY, Duration.ofMinutes(1));
 StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment(config);
 

For more details on using ConfigOption for restart strategies, please refer to the Flink documentation: restart-strategies

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	Deprecated. Configuration representing an exponential delay restart strategy.
static class	RestartStrategies.FailureRateRestartStrategyConfiguration	Deprecated. Configuration representing a failure rate restart strategy.
static class	RestartStrategies.FallbackRestartStrategyConfiguration	Deprecated. Restart strategy configuration that could be used by jobs to use cluster level restart strategy.
static class	RestartStrategies.FixedDelayRestartStrategyConfiguration	Deprecated. Configuration representing a fixed delay restart strategy.
static class	RestartStrategies.NoRestartStrategyConfiguration	Deprecated. Configuration representing no restart strategy.
static class	RestartStrategies.RestartStrategyConfiguration	Deprecated. Abstract configuration for restart strategies.

Constructor Summary

Constructors

Constructor	Description
RestartStrategies()	Deprecated.

Method Summary

Modifier and Type	Method	Description
static RestartStrategies.ExponentialDelayRestartStrategyConfiguration	exponentialDelayRestart(java.time.Duration initialBackoff, java.time.Duration maxBackoff, double backoffMultiplier, java.time.Duration resetBackoffThreshold, double jitterFactor)	Deprecated. Generates a ExponentialDelayRestartStrategyConfiguration.
static RestartStrategies.ExponentialDelayRestartStrategyConfiguration	exponentialDelayRestart(Time initialBackoff, Time maxBackoff, double backoffMultiplier, Time resetBackoffThreshold, double jitterFactor)	Deprecated. Use exponentialDelayRestart(Duration, Duration, double, Duration, double)
static RestartStrategies.FailureRateRestartStrategyConfiguration	failureRateRestart(int failureRate, java.time.Duration failureInterval, java.time.Duration delayInterval)	Deprecated. Generates a FailureRateRestartStrategyConfiguration.
static RestartStrategies.FailureRateRestartStrategyConfiguration	failureRateRestart(int failureRate, Time failureInterval, Time delayInterval)	Deprecated. Use failureRateRestart(int, Duration, Duration)
static RestartStrategies.RestartStrategyConfiguration	fallBackRestart()	Deprecated.
static RestartStrategies.RestartStrategyConfiguration	fixedDelayRestart(int restartAttempts, long delayBetweenAttempts)	Deprecated. Generates a FixedDelayRestartStrategyConfiguration.
static RestartStrategies.RestartStrategyConfiguration	fixedDelayRestart(int restartAttempts, java.time.Duration delayInterval)	Deprecated. Generates a FixedDelayRestartStrategyConfiguration.
static RestartStrategies.RestartStrategyConfiguration	fixedDelayRestart(int restartAttempts, Time delayInterval)	Deprecated. Use fixedDelayRestart(int, Duration)
static Optional<RestartStrategies.RestartStrategyConfiguration>	fromConfiguration(ReadableConfig configuration)	Deprecated. Reads a RestartStrategies.RestartStrategyConfiguration from a given ReadableConfig.
static RestartStrategies.RestartStrategyConfiguration	noRestart()	Deprecated. 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()

Deprecated.

Method Detail

noRestart

public static RestartStrategies.RestartStrategyConfiguration noRestart()

Deprecated.

Generates NoRestartStrategyConfiguration.

Returns:

NoRestartStrategyConfiguration

fallBackRestart

public static RestartStrategies.RestartStrategyConfiguration fallBackRestart()

Deprecated.

fixedDelayRestart

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

Deprecated.

Generates a FixedDelayRestartStrategyConfiguration.

Parameters:

restartAttempts - Number of restart attempts for the FixedDelayRestartStrategy

delayBetweenAttempts - Delay in-between restart attempts for the FixedDelayRestartStrategy

Returns:

FixedDelayRestartStrategy

fixedDelayRestart

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

Deprecated.

Use fixedDelayRestart(int, Duration)

Generates a FixedDelayRestartStrategyConfiguration.

Parameters:

restartAttempts - Number of restart attempts for the FixedDelayRestartStrategy

delayInterval - Delay in-between restart attempts for the FixedDelayRestartStrategy

Returns:

FixedDelayRestartStrategy

fixedDelayRestart

public static RestartStrategies.RestartStrategyConfiguration fixedDelayRestart(int restartAttempts,
                                                                               java.time.Duration delayInterval)

Deprecated.

Generates a FixedDelayRestartStrategyConfiguration.

Parameters:

restartAttempts - Number of restart attempts for the FixedDelayRestartStrategy

delayInterval - Delay in-between restart attempts for the FixedDelayRestartStrategy

Returns:

FixedDelayRestartStrategy

failureRateRestart

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

Deprecated.

Use failureRateRestart(int, Duration, Duration)

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

failureRateRestart

public static RestartStrategies.FailureRateRestartStrategyConfiguration failureRateRestart(int failureRate,
                                                                                           java.time.Duration failureInterval,
                                                                                           java.time.Duration delayInterval)

Deprecated.

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

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

Deprecated.

Use exponentialDelayRestart(Duration, Duration, double, Duration, double)

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)

exponentialDelayRestart

public static RestartStrategies.ExponentialDelayRestartStrategyConfiguration exponentialDelayRestart(java.time.Duration initialBackoff,
                                                                                                     java.time.Duration maxBackoff,
                                                                                                     double backoffMultiplier,
                                                                                                     java.time.Duration resetBackoffThreshold,
                                                                                                     double jitterFactor)

Deprecated.

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)

Deprecated.

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