org.apache.flink.runtime.checkpoint

枚举 DeactivatedCheckpointCompletedCheckpointStore

java.lang.Object

java.lang.Enum<DeactivatedCheckpointCompletedCheckpointStore>

org.apache.flink.runtime.checkpoint.DeactivatedCheckpointCompletedCheckpointStore

所有已实现的接口:

Serializable, Comparable<DeactivatedCheckpointCompletedCheckpointStore>, CompletedCheckpointStore

public enum DeactivatedCheckpointCompletedCheckpointStore
extends Enum<DeactivatedCheckpointCompletedCheckpointStore>
implements CompletedCheckpointStore

This class represents a CompletedCheckpointStore if checkpointing has been disabled. Consequently, no component should use methods other than CompletedCheckpointStore.shutdown(org.apache.flink.api.common.JobStatus, org.apache.flink.runtime.checkpoint.CheckpointsCleaner).

枚举常量概要

枚举常量

枚举常量和说明
INSTANCE

字段概要

从接口继承的字段 org.apache.flink.runtime.checkpoint.CompletedCheckpointStore

LOG

方法概要

限定符和类型	方法和说明
CompletedCheckpoint	addCheckpointAndSubsumeOldestOne(CompletedCheckpoint checkpoint, CheckpointsCleaner checkpointsCleaner, Runnable postCleanup) Adds a CompletedCheckpoint instance to the list of completed checkpoints.
List<CompletedCheckpoint>	getAllCheckpoints() Returns all CompletedCheckpoint instances.
int	getMaxNumberOfRetainedCheckpoints() Returns the max number of retained checkpoints.
int	getNumberOfRetainedCheckpoints() Returns the current number of retained checkpoints.
SharedStateRegistry	getSharedStateRegistry() Returns the SharedStateRegistry used to register the shared state.
boolean	requiresExternalizedCheckpoints() This method returns whether the completed checkpoint store requires checkpoints to be externalized.
void	shutdown(org.apache.flink.api.common.JobStatus jobStatus, CheckpointsCleaner checkpointsCleaner) Shuts down the store.
static DeactivatedCheckpointCompletedCheckpointStore	valueOf(String name) 返回带有指定名称的该类型的枚举常量。
static DeactivatedCheckpointCompletedCheckpointStore[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

从类继承的方法 java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.apache.flink.runtime.checkpoint.CompletedCheckpointStore

getLatestCheckpoint, getLatestCheckpointId

枚举常量详细资料

INSTANCE

public static final DeactivatedCheckpointCompletedCheckpointStore INSTANCE

方法详细资料

values

public static DeactivatedCheckpointCompletedCheckpointStore[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

for (DeactivatedCheckpointCompletedCheckpointStore c : DeactivatedCheckpointCompletedCheckpointStore.values())
    System.out.println(c);

返回:

按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

valueOf

public static DeactivatedCheckpointCompletedCheckpointStore valueOf(String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量

NullPointerException - 如果参数为空值

addCheckpointAndSubsumeOldestOne

public CompletedCheckpoint addCheckpointAndSubsumeOldestOne(CompletedCheckpoint checkpoint,
                                                            CheckpointsCleaner checkpointsCleaner,
                                                            Runnable postCleanup)
                                                     throws Exception

从接口复制的说明: CompletedCheckpointStore

Adds a CompletedCheckpoint instance to the list of completed checkpoints.

Only a bounded number of checkpoints is kept. When exceeding the maximum number of retained checkpoints, the oldest one will be discarded.

After FLINK-24611, SharedStateRegistry.unregisterUnusedState(long) should be called here to subsume unused state. Note, the CompletedCheckpoint passed to SharedStateRegistry.registerAllAfterRestored(org.apache.flink.runtime.checkpoint.CompletedCheckpoint, org.apache.flink.runtime.jobgraph.RestoreMode) or SharedStateRegistryFactory.create(java.util.concurrent.Executor, java.util.Collection<org.apache.flink.runtime.checkpoint.CompletedCheckpoint>, org.apache.flink.runtime.jobgraph.RestoreMode) must be the same object as the input parameter, otherwise the state may be deleted by mistake.

After FLINK-25872, CheckpointsCleaner.cleanSubsumedCheckpoints(long, java.util.Set<java.lang.Long>, java.lang.Runnable, java.util.concurrent.Executor) should be called explicitly here.

指定者:

addCheckpointAndSubsumeOldestOne 在接口中 CompletedCheckpointStore

返回:

the subsumed oldest completed checkpoint if possible, return null if no checkpoint needs to be discarded on subsume.

抛出:

Exception

shutdown

public void shutdown(org.apache.flink.api.common.JobStatus jobStatus,
                     CheckpointsCleaner checkpointsCleaner)
              throws Exception

从接口复制的说明: CompletedCheckpointStore

Shuts down the store.

The job status is forwarded and used to decide whether state should actually be discarded or kept. SharedStateRegistry.unregisterUnusedState(long) and CheckpointsCleaner.cleanSubsumedCheckpoints(long, java.util.Set<java.lang.Long>, java.lang.Runnable, java.util.concurrent.Executor) should be called here to subsume unused state.

指定者:

shutdown 在接口中 CompletedCheckpointStore

参数:

jobStatus - Job state on shut down

checkpointsCleaner - that will cleanup completed checkpoints if needed

抛出:

Exception

getAllCheckpoints

public List<CompletedCheckpoint> getAllCheckpoints()
                                            throws Exception

从接口复制的说明: CompletedCheckpointStore

Returns all CompletedCheckpoint instances.

Returns an empty list if no checkpoint has been added yet.

指定者:

getAllCheckpoints 在接口中 CompletedCheckpointStore

抛出:

Exception

getNumberOfRetainedCheckpoints

public int getNumberOfRetainedCheckpoints()

从接口复制的说明: CompletedCheckpointStore

Returns the current number of retained checkpoints.

指定者:

getNumberOfRetainedCheckpoints 在接口中 CompletedCheckpointStore

getMaxNumberOfRetainedCheckpoints

public int getMaxNumberOfRetainedCheckpoints()

从接口复制的说明: CompletedCheckpointStore

Returns the max number of retained checkpoints.

指定者:

getMaxNumberOfRetainedCheckpoints 在接口中 CompletedCheckpointStore

requiresExternalizedCheckpoints

public boolean requiresExternalizedCheckpoints()

从接口复制的说明: CompletedCheckpointStore

This method returns whether the completed checkpoint store requires checkpoints to be externalized. Externalized checkpoints have their meta data persisted, which the checkpoint store can exploit (for example by simply pointing the persisted metadata).

指定者:

requiresExternalizedCheckpoints 在接口中 CompletedCheckpointStore

返回:

True, if the store requires that checkpoints are externalized before being added, false if the store stores the metadata itself.

getSharedStateRegistry

public SharedStateRegistry getSharedStateRegistry()

从接口复制的说明: CompletedCheckpointStore

Returns the SharedStateRegistry used to register the shared state.

指定者:

getSharedStateRegistry 在接口中 CompletedCheckpointStore