org.apache.flink.runtime.state

Class DirectoryKeyedStateHandle

java.lang.Object

org.apache.flink.runtime.state.DirectoryKeyedStateHandle

All Implemented Interfaces:

Serializable, CompositeStateHandle, KeyedStateHandle, StateObject

Direct Known Subclasses:

IncrementalLocalKeyedStateHandle

public class DirectoryKeyedStateHandle
extends Object
implements KeyedStateHandle

This class is a keyed state handle based on a directory. It combines a DirectoryStateHandle and a KeyGroupRange.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DirectoryKeyedStateHandle(DirectoryStateHandle directoryStateHandle, KeyGroupRange keyGroupRange)

Method Summary

Modifier and Type	Method and 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)
DirectoryStateHandle	getDirectoryStateHandle()
KeyedStateHandle	getIntersection(KeyGroupRange otherKeyGroupRange) Returns a state over a range that is the intersection between this handle's key-group range and the provided key-group range.
KeyGroupRange	getKeyGroupRange() Returns the range of the key groups contained in the state.
long	getStateSize() Returns the size of the state in bytes.
int	hashCode()
void	registerSharedStates(SharedStateRegistry stateRegistry) Register both newly created and already referenced shared states in the given SharedStateRegistry.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryKeyedStateHandle

public DirectoryKeyedStateHandle(@Nonnull
                                 DirectoryStateHandle directoryStateHandle,
                                 @Nonnull
                                 KeyGroupRange keyGroupRange)

Method Detail

getDirectoryStateHandle

@Nonnull
public DirectoryStateHandle getDirectoryStateHandle()

getKeyGroupRange

@Nonnull
public KeyGroupRange getKeyGroupRange()

Description copied from interface: KeyedStateHandle

Returns the range of the key groups contained in the state.

Specified by:

getKeyGroupRange in interface KeyedStateHandle

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 any more.

Specified by:

discardState in interface StateObject

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

Returns:

Size of the state in bytes.

getIntersection

public KeyedStateHandle getIntersection(KeyGroupRange otherKeyGroupRange)

Description copied from interface: KeyedStateHandle

Returns a state over a range that is the intersection between this handle's key-group range and the provided key-group range.

Specified by:

getIntersection in interface KeyedStateHandle

Parameters:

otherKeyGroupRange - The key group range to intersect with, will return null if the intersection of this handle's key-group and the provided key-group is empty.

registerSharedStates

public void registerSharedStates(SharedStateRegistry stateRegistry)

Description copied from interface: CompositeStateHandle

Register both newly created and already referenced shared states in the given SharedStateRegistry. This method is called when the checkpoint successfully completes or is recovered from failures.

After this is completed, newly created shared state is considered as published is no longer owned by this handle. This means that it should no longer be deleted as part of calls to StateObject.discardState(). Instead, StateObject.discardState() will trigger an unregistration from the registry.

Specified by:

registerSharedStates in interface CompositeStateHandle

Parameters:

stateRegistry - The registry where shared states are registered.

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