Package org.apache.flink.runtime.jobgraph

Class SavepointRestoreSettings

java.lang.Object

org.apache.flink.runtime.jobgraph.SavepointRestoreSettings

All Implemented Interfaces:

Serializable

public class SavepointRestoreSettings
extends Object
implements Serializable

Savepoint restore settings.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	allowNonRestoredState()	Returns whether non restored state is allowed if the savepoint contains state that cannot be mapped back to the job.
boolean	equals(Object o)
static SavepointRestoreSettings	forPath(String savepointPath)
static SavepointRestoreSettings	forPath(String savepointPath, boolean allowNonRestoredState)
static SavepointRestoreSettings	forPath(String savepointPath, boolean allowNonRestoredState, org.apache.flink.core.execution.RecoveryClaimMode recoveryClaimMode)
static SavepointRestoreSettings	fromConfiguration(org.apache.flink.configuration.ReadableConfig configuration)
org.apache.flink.core.execution.RecoveryClaimMode	getRecoveryClaimMode()	Tells how to restore from the given savepoint.
String	getRestorePath()	Returns the path to the savepoint to restore from.
int	hashCode()
static SavepointRestoreSettings	none()
boolean	restoreSavepoint()	Returns whether to restore from savepoint.
static void	toConfiguration(SavepointRestoreSettings savepointRestoreSettings, org.apache.flink.configuration.Configuration configuration)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

restoreSavepoint

public boolean restoreSavepoint()

Returns whether to restore from savepoint.

Returns:

true if should restore from savepoint.

getRestorePath

public String getRestorePath()

Returns the path to the savepoint to restore from.

Returns:

Path to the savepoint to restore from or null if should not restore.

allowNonRestoredState

public boolean allowNonRestoredState()

Returns whether non restored state is allowed if the savepoint contains state that cannot be mapped back to the job.

Returns:

true if non restored state is allowed if the savepoint contains state that cannot be mapped back to the job.

getRecoveryClaimMode

@Nonnull
public org.apache.flink.core.execution.RecoveryClaimMode getRecoveryClaimMode()

Tells how to restore from the given savepoint.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

none

public static SavepointRestoreSettings none()

forPath

public static SavepointRestoreSettings forPath(String savepointPath)

forPath

public static SavepointRestoreSettings forPath(String savepointPath,
 boolean allowNonRestoredState)

forPath

public static SavepointRestoreSettings forPath(String savepointPath,
 boolean allowNonRestoredState,
 @Nonnull
 org.apache.flink.core.execution.RecoveryClaimMode recoveryClaimMode)

toConfiguration

public static void toConfiguration(SavepointRestoreSettings savepointRestoreSettings,
 org.apache.flink.configuration.Configuration configuration)

fromConfiguration

public static SavepointRestoreSettings fromConfiguration(org.apache.flink.configuration.ReadableConfig configuration)