Package org.apache.flink.kubernetes.operator.utils

Class SavepointUtils

java.lang.Object

org.apache.flink.kubernetes.operator.utils.SavepointUtils

public class SavepointUtils
extends java.lang.Object

Savepoint utilities.

Constructor Summary

Constructors

Constructor	Description
SavepointUtils()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	createSavepointError(SavepointInfo savepointInfo, java.lang.Long triggerNonce)
static SavepointStatus	getLastSavepointStatus(AbstractFlinkResource<?,?> resource)
static org.apache.flink.core.execution.SavepointFormatType	getSavepointFormatType(org.apache.flink.configuration.Configuration configuration)
static boolean	gracePeriodEnded(org.apache.flink.configuration.Configuration conf, SavepointInfo savepointInfo)
static void	resetTriggerIfJobNotRunning(AbstractFlinkResource<?,?> resource, EventRecorder eventRecorder)
static boolean	savepointInProgress(JobStatus jobStatus)
protected static java.util.Optional<SavepointTriggerType>	shouldTriggerSavepoint(AbstractFlinkResource<?,?> resource, org.apache.flink.configuration.Configuration conf)	Checks whether savepoint should be triggered based on the current status and spec and if yes, returns the correct SavepointTriggerType.
static boolean	triggerSavepointIfNeeded(FlinkService flinkService, AbstractFlinkResource<?,?> resource, org.apache.flink.configuration.Configuration conf)	Triggers any pending manual or periodic savepoints and updates the status accordingly.

Methods inherited from class java.lang.Object

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

Constructor Detail

SavepointUtils

public SavepointUtils()

Method Detail

savepointInProgress

public static boolean savepointInProgress(JobStatus jobStatus)

getLastSavepointStatus

public static SavepointStatus getLastSavepointStatus(AbstractFlinkResource<?,?> resource)

triggerSavepointIfNeeded

public static boolean triggerSavepointIfNeeded(FlinkService flinkService,
                                               AbstractFlinkResource<?,?> resource,
                                               org.apache.flink.configuration.Configuration conf)
                                        throws java.lang.Exception

Triggers any pending manual or periodic savepoints and updates the status accordingly.

Parameters:

flinkService - FlinkService used to trigger savepoints

resource - Resource that should be savepointed

conf - Observe config of the resource

Returns:

True if a savepoint was triggered

Throws:

java.lang.Exception - Error during savepoint triggering.

shouldTriggerSavepoint

@VisibleForTesting
protected static java.util.Optional<SavepointTriggerType> shouldTriggerSavepoint(AbstractFlinkResource<?,?> resource,
                                                                                 org.apache.flink.configuration.Configuration conf)

Checks whether savepoint should be triggered based on the current status and spec and if yes, returns the correct SavepointTriggerType.

This logic is responsible for both manual and periodic savepoint triggering.

Parameters:

resource - Resource to be savepointed

conf - Observe configuration of the resource

Returns:

Optional @SavepointTriggerType

gracePeriodEnded

public static boolean gracePeriodEnded(org.apache.flink.configuration.Configuration conf,
                                       SavepointInfo savepointInfo)

resetTriggerIfJobNotRunning

public static void resetTriggerIfJobNotRunning(AbstractFlinkResource<?,?> resource,
                                               EventRecorder eventRecorder)

createSavepointError

public static java.lang.String createSavepointError(SavepointInfo savepointInfo,
                                                    java.lang.Long triggerNonce)

getSavepointFormatType

public static org.apache.flink.core.execution.SavepointFormatType getSavepointFormatType(org.apache.flink.configuration.Configuration configuration)