Package org.apache.flink.runtime.state

Class IncrementalLocalKeyedStateHandle

java.lang.Object

org.apache.flink.runtime.state.DirectoryKeyedStateHandle

org.apache.flink.runtime.state.IncrementalLocalKeyedStateHandle

All Implemented Interfaces:

Serializable, CheckpointBoundKeyedStateHandle, CompositeStateHandle, IncrementalKeyedStateHandle, KeyedStateHandle, StateObject

public class IncrementalLocalKeyedStateHandle
extends DirectoryKeyedStateHandle
implements IncrementalKeyedStateHandle

State handle for local copies of IncrementalRemoteKeyedStateHandle. Consists of a DirectoryStateHandle that represents the directory of the native RocksDB snapshot, the key groups, and a stream state handle for Flink's state meta data file.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.state.IncrementalKeyedStateHandle

IncrementalKeyedStateHandle.HandleAndLocalPath

Constructor Summary

Constructors

Constructor	Description
IncrementalLocalKeyedStateHandle(UUID backendIdentifier, long checkpointId, DirectoryStateHandle directoryStateHandle, KeyGroupRange keyGroupRange, StreamStateHandle metaDataState, List<IncrementalKeyedStateHandle.HandleAndLocalPath> sharedState)

Method Summary

Modifier and Type	Method	Description
void	discardState()	Discards the state referred to and solemnly owned by this handle, to free up resources in the persistent storage.
boolean	equals(Object o)
UUID	getBackendIdentifier()	Returns the identifier of the state backend from which this handle was created.
long	getCheckpointId()	Returns the ID of the checkpoint for which the handle was created or used.
StreamStateHandle	getMetaDataState()
List<IncrementalKeyedStateHandle.HandleAndLocalPath>	getSharedStateHandles()	Returns a list of all shared states and the corresponding localPath in the backend at the time this was created.
long	getStateSize()	Returns the size of the state in bytes.
int	hashCode()
CheckpointBoundKeyedStateHandle	rebound(long checkpointId)	Returns a new CheckpointBoundKeyedStateHandle Rebounding checkpoint id to a specific checkpoint id.
String	toString()

Methods inherited from class org.apache.flink.runtime.state.DirectoryKeyedStateHandle

getCheckpointedSize, getDirectoryStateHandle, getIntersection, getKeyGroupRange, getStateHandleId, registerSharedStates

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.runtime.state.CompositeStateHandle

getCheckpointedSize, registerSharedStates

Methods inherited from interface org.apache.flink.runtime.state.KeyedStateHandle

getIntersection, getKeyGroupRange, getStateHandleId

Constructor Detail

IncrementalLocalKeyedStateHandle

public IncrementalLocalKeyedStateHandle(@Nonnull
                                        UUID backendIdentifier,
                                        @Nonnegative
                                        long checkpointId,
                                        @Nonnull
                                        DirectoryStateHandle directoryStateHandle,
                                        @Nonnull
                                        KeyGroupRange keyGroupRange,
                                        @Nonnull
                                        StreamStateHandle metaDataState,
                                        @Nonnull
                                        List<IncrementalKeyedStateHandle.HandleAndLocalPath> sharedState)

Method Detail

getMetaDataState

@Nonnull
public StreamStateHandle getMetaDataState()

getCheckpointId

public long getCheckpointId()

Description copied from interface: CheckpointBoundKeyedStateHandle

Returns the ID of the checkpoint for which the handle was created or used.

Specified by:

getCheckpointId in interface CheckpointBoundKeyedStateHandle

rebound

public CheckpointBoundKeyedStateHandle rebound(long checkpointId)

Description copied from interface: CheckpointBoundKeyedStateHandle

Returns a new CheckpointBoundKeyedStateHandle Rebounding checkpoint id to a specific checkpoint id.

Specified by:

rebound in interface CheckpointBoundKeyedStateHandle

Parameters:

checkpointId - rebounded checkpoint id.

getBackendIdentifier

@Nonnull
public UUID getBackendIdentifier()

Description copied from interface: IncrementalKeyedStateHandle

Returns the identifier of the state backend from which this handle was created.

Specified by:

getBackendIdentifier in interface IncrementalKeyedStateHandle

getSharedStateHandles

@Nonnull
public List<IncrementalKeyedStateHandle.HandleAndLocalPath> getSharedStateHandles()

Description copied from interface: IncrementalKeyedStateHandle

Returns a list of all shared states and the corresponding localPath in the backend at the time this was created.

Specified by:

getSharedStateHandles in interface IncrementalKeyedStateHandle

equals

public boolean equals(Object o)

Overrides:

equals in class DirectoryKeyedStateHandle

discardState

public void discardState()
                  throws Exception

Description copied from interface: StateObject

Discards the state referred to and solemnly owned by this handle, to free up resources in the persistent storage. This method is called when the state represented by this object will not be used anymore.

Specified by:

discardState in interface StateObject

Overrides:

discardState in class DirectoryKeyedStateHandle

Throws:

Exception

getStateSize

public long getStateSize()

Description copied from interface: StateObject

Returns the size of the state in bytes. If the size is not known, this method should return 0.

The values produced by this method are only used for informational purposes and for metrics/monitoring. If this method returns wrong values, the checkpoints and recovery will still behave correctly. However, efficiency may be impacted (wrong space pre-allocation) and functionality that depends on metrics (like monitoring) will be impacted.

Note for implementors: This method should not perform any I/O operations while obtaining the state size (hence it does not declare throwing an IOException). Instead, the state size should be stored in the state object, or should be computable from the state stored in this object. The reason is that this method is called frequently by several parts of the checkpointing and issuing I/O requests from this method accumulates a heavy I/O load on the storage system at higher scale.

Specified by:

getStateSize in interface StateObject

Overrides:

getStateSize in class DirectoryKeyedStateHandle

Returns:

Size of the state in bytes.

hashCode

public int hashCode()

Overrides:

hashCode in class DirectoryKeyedStateHandle

toString

public String toString()

Overrides:

toString in class DirectoryKeyedStateHandle