org.apache.flink.runtime.state

类 DirectoryKeyedStateHandle

java.lang.Object

org.apache.flink.runtime.state.DirectoryKeyedStateHandle

所有已实现的接口:

Serializable, CompositeStateHandle, KeyedStateHandle, StateObject

直接已知子类:

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.

另请参阅:

序列化表格

构造器概要

构造器

构造器和说明
DirectoryKeyedStateHandle(DirectoryStateHandle directoryStateHandle, KeyGroupRange keyGroupRange)

方法概要

限定符和类型	方法和说明
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)
long	getCheckpointedSize() Returns the persisted data size during checkpoint execution in bytes.
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.
StateHandleID	getStateHandleId() Returns a unique state handle id to distinguish with other keyed state handles.
long	getStateSize() Returns the size of the state in bytes.
int	hashCode()
void	registerSharedStates(SharedStateRegistry stateRegistry, long checkpointID) Register both newly created and already referenced shared states in the given SharedStateRegistry.
String	toString()

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

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

构造器详细资料

DirectoryKeyedStateHandle

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

方法详细资料

getDirectoryStateHandle

@Nonnull
public DirectoryStateHandle getDirectoryStateHandle()

getKeyGroupRange

@Nonnull
public KeyGroupRange getKeyGroupRange()

从接口复制的说明: KeyedStateHandle

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

指定者:

getKeyGroupRange 在接口中 KeyedStateHandle

discardState

public void discardState()
                  throws Exception

从接口复制的说明: 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.

指定者:

discardState 在接口中 StateObject

抛出:

Exception

getStateSize

public long getStateSize()

从接口复制的说明: 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.

指定者:

getStateSize 在接口中 StateObject

返回:

Size of the state in bytes.

getCheckpointedSize

public long getCheckpointedSize()

从接口复制的说明: CompositeStateHandle

Returns the persisted data size during checkpoint execution in bytes. If incremental checkpoint is enabled, this value represents the incremental persisted data size, and usually smaller than StateObject.getStateSize(). If the size is unknown, this method would return same result as StateObject.getStateSize().

指定者:

getCheckpointedSize 在接口中 CompositeStateHandle

返回:

The persisted data size during checkpoint execution in bytes.

getIntersection

public KeyedStateHandle getIntersection(KeyGroupRange otherKeyGroupRange)

从接口复制的说明: KeyedStateHandle

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

指定者:

getIntersection 在接口中 KeyedStateHandle

参数:

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.

getStateHandleId

public StateHandleID getStateHandleId()

从接口复制的说明: KeyedStateHandle

Returns a unique state handle id to distinguish with other keyed state handles.

If this state handle would be used as materialized part of ChangelogStateBackendHandle, it should persist this state handle id when serializing of checkpoint and deserialize it back to ensure the state handle id is constant.

指定者:

getStateHandleId 在接口中 KeyedStateHandle

返回:

A unique state handle id.

registerSharedStates

public void registerSharedStates(SharedStateRegistry stateRegistry,
                                 long checkpointID)

从接口复制的说明: 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.

指定者:

registerSharedStates 在接口中 CompositeStateHandle

参数:

stateRegistry - The registry where shared states are registered.

equals

public boolean equals(Object o)

覆盖:

equals 在类中 Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object

toString

public String toString()

覆盖:

toString 在类中 Object