Package org.apache.flink.runtime.checkpoint

Enum DeactivatedCheckpointIDCounter

java.lang.Object

java.lang.Enum<DeactivatedCheckpointIDCounter>

org.apache.flink.runtime.checkpoint.DeactivatedCheckpointIDCounter

All Implemented Interfaces:

Serializable, Comparable<DeactivatedCheckpointIDCounter>, CheckpointIDCounter

public enum DeactivatedCheckpointIDCounter
extends Enum<DeactivatedCheckpointIDCounter>
implements CheckpointIDCounter

This class represents a CheckpointIDCounter if checkpointing is deactivated. Consequently, no component should use methods of this class other than start() and shutdown(org.apache.flink.api.common.JobStatus).

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Field Summary

Fields inherited from interface org.apache.flink.runtime.checkpoint.CheckpointIDCounter

INITIAL_CHECKPOINT_ID

Method Summary

Modifier and Type	Method	Description
long	get()	Atomically gets the current checkpoint ID.
long	getAndIncrement()	Atomically increments the current checkpoint ID.
void	setCount(long newId)	Sets the current checkpoint ID.
CompletableFuture<Void>	shutdown(org.apache.flink.api.common.JobStatus jobStatus)	Shuts the CheckpointIDCounter service.
void	start()	Starts the CheckpointIDCounter service down.
static DeactivatedCheckpointIDCounter	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DeactivatedCheckpointIDCounter[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final DeactivatedCheckpointIDCounter INSTANCE

Method Details

values

public static DeactivatedCheckpointIDCounter[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DeactivatedCheckpointIDCounter valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

start

public void start()
           throws Exception

Description copied from interface: CheckpointIDCounter

Starts the CheckpointIDCounter service down.

Specified by:

start in interface CheckpointIDCounter

Throws:

Exception

shutdown

public CompletableFuture<Void> shutdown(org.apache.flink.api.common.JobStatus jobStatus)

Description copied from interface: CheckpointIDCounter

Shuts the CheckpointIDCounter service.

The job status is forwarded and used to decide whether state should actually be discarded or kept.

Specified by:

shutdown in interface CheckpointIDCounter

Parameters:

jobStatus - Job state on shut down

Returns:

The CompletableFuture holding the result of the shutdown operation.

getAndIncrement

public long getAndIncrement()
                     throws Exception

Description copied from interface: CheckpointIDCounter

Atomically increments the current checkpoint ID.

Specified by:

getAndIncrement in interface CheckpointIDCounter

Returns:

The previous checkpoint ID

Throws:

Exception

get

public long get()

Description copied from interface: CheckpointIDCounter

Atomically gets the current checkpoint ID.

Specified by:

get in interface CheckpointIDCounter

Returns:

The current checkpoint ID

setCount

public void setCount(long newId)
              throws Exception

Description copied from interface: CheckpointIDCounter

Sets the current checkpoint ID.

Specified by:

setCount in interface CheckpointIDCounter

Parameters:

newId - The new ID

Throws:

Exception