org.apache.flink.runtime.state

类 IncrementalRemoteKeyedStateHandle

java.lang.Object

org.apache.flink.runtime.state.IncrementalRemoteKeyedStateHandle

所有已实现的接口:

Serializable, CheckpointBoundKeyedStateHandle, CompositeStateHandle, IncrementalKeyedStateHandle, KeyedStateHandle, StateObject

public class IncrementalRemoteKeyedStateHandle
extends Object
implements IncrementalKeyedStateHandle

The handle to states of an incremental snapshot.

The states contained in an incremental snapshot include:

• Created shared state which includes shared files produced since the last completed checkpoint. These files can be referenced by succeeding checkpoints if the checkpoint succeeds to complete.
• Referenced shared state which includes the shared files materialized in previous checkpoints. Until we this is registered to a SharedStateRegistry, all referenced shared state handles are only placeholders, so that we do not send state handles twice from which we know that they already exist on the checkpoint coordinator.
• Private state which includes all other files, typically mutable, that cannot be shared by other checkpoints.
• Backend meta state which includes the information of existing states.

When this should become a completed checkpoint on the checkpoint coordinator, it must first be registered with a SharedStateRegistry, so that all placeholder state handles to previously existing state are replaced with the originals.

IMPORTANT: This class currently overrides equals and hash code only for testing purposes. They should not be called from production code. This means this class is also not suited to serve as a key, e.g. in hash maps.

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
static long	UNKNOWN_CHECKPOINTED_SIZE

构造器概要

构造器

限定符	构造器和说明
	IncrementalRemoteKeyedStateHandle(UUID backendIdentifier, KeyGroupRange keyGroupRange, long checkpointId, Map<StateHandleID,StreamStateHandle> sharedState, Map<StateHandleID,StreamStateHandle> privateState, StreamStateHandle metaStateHandle)
	IncrementalRemoteKeyedStateHandle(UUID backendIdentifier, KeyGroupRange keyGroupRange, long checkpointId, Map<StateHandleID,StreamStateHandle> sharedState, Map<StateHandleID,StreamStateHandle> privateState, StreamStateHandle metaStateHandle, long persistedSizeOfThisCheckpoint)
protected	IncrementalRemoteKeyedStateHandle(UUID backendIdentifier, KeyGroupRange keyGroupRange, long checkpointId, Map<StateHandleID,StreamStateHandle> sharedState, Map<StateHandleID,StreamStateHandle> privateState, StreamStateHandle metaStateHandle, long persistedSizeOfThisCheckpoint, StateHandleID stateHandleId)

方法概要

限定符和类型	方法和说明
SharedStateRegistryKey	createSharedStateRegistryKeyFromFileName(StateHandleID shId) Create a unique key to register one of our shared state handles.
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) This method is should only be called in tests!
UUID	getBackendIdentifier() Returns the identifier of the state backend from which this handle was created.
long	getCheckpointedSize() Returns the persisted data size during checkpoint execution in bytes.
long	getCheckpointId() Returns the ID of the checkpoint for which the handle was created or used.
KeyedStateHandle	getIntersection(KeyGroupRange keyGroupRange) 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.
StreamStateHandle	getMetaStateHandle()
Map<StateHandleID,StreamStateHandle>	getPrivateState()
Map<StateHandleID,StreamStateHandle>	getSharedState()
Map<StateHandleID,StreamStateHandle>	getSharedStateHandles() Returns a set of ids of all registered shared states in the backend at the time this was created.
SharedStateRegistry	getSharedStateRegistry()
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() This method should only be called in tests!
void	registerSharedStates(SharedStateRegistry stateRegistry, long checkpointID) Register both newly created and already referenced shared states in the given SharedStateRegistry.
static IncrementalRemoteKeyedStateHandle	restore(UUID backendIdentifier, KeyGroupRange keyGroupRange, long checkpointId, Map<StateHandleID,StreamStateHandle> sharedState, Map<StateHandleID,StreamStateHandle> privateState, StreamStateHandle metaStateHandle, long persistedSizeOfThisCheckpoint, StateHandleID stateHandleId)
String	toString()

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

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

字段详细资料

UNKNOWN_CHECKPOINTED_SIZE

public static final long UNKNOWN_CHECKPOINTED_SIZE

另请参阅:

常量字段值

构造器详细资料

IncrementalRemoteKeyedStateHandle

@VisibleForTesting
public IncrementalRemoteKeyedStateHandle(UUID backendIdentifier,
                                                            KeyGroupRange keyGroupRange,
                                                            long checkpointId,
                                                            Map<StateHandleID,StreamStateHandle> sharedState,
                                                            Map<StateHandleID,StreamStateHandle> privateState,
                                                            StreamStateHandle metaStateHandle)

IncrementalRemoteKeyedStateHandle

public IncrementalRemoteKeyedStateHandle(UUID backendIdentifier,
                                         KeyGroupRange keyGroupRange,
                                         long checkpointId,
                                         Map<StateHandleID,StreamStateHandle> sharedState,
                                         Map<StateHandleID,StreamStateHandle> privateState,
                                         StreamStateHandle metaStateHandle,
                                         long persistedSizeOfThisCheckpoint)

IncrementalRemoteKeyedStateHandle

protected IncrementalRemoteKeyedStateHandle(UUID backendIdentifier,
                                            KeyGroupRange keyGroupRange,
                                            long checkpointId,
                                            Map<StateHandleID,StreamStateHandle> sharedState,
                                            Map<StateHandleID,StreamStateHandle> privateState,
                                            StreamStateHandle metaStateHandle,
                                            long persistedSizeOfThisCheckpoint,
                                            StateHandleID stateHandleId)

方法详细资料

restore

public static IncrementalRemoteKeyedStateHandle restore(UUID backendIdentifier,
                                                        KeyGroupRange keyGroupRange,
                                                        long checkpointId,
                                                        Map<StateHandleID,StreamStateHandle> sharedState,
                                                        Map<StateHandleID,StreamStateHandle> privateState,
                                                        StreamStateHandle metaStateHandle,
                                                        long persistedSizeOfThisCheckpoint,
                                                        StateHandleID stateHandleId)

getKeyGroupRange

public KeyGroupRange getKeyGroupRange()

从接口复制的说明: KeyedStateHandle

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

指定者:

getKeyGroupRange 在接口中 KeyedStateHandle

getCheckpointId

public long getCheckpointId()

从接口复制的说明: CheckpointBoundKeyedStateHandle

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

指定者:

getCheckpointId 在接口中 CheckpointBoundKeyedStateHandle

getSharedState

public Map<StateHandleID,StreamStateHandle> getSharedState()

getPrivateState

public Map<StateHandleID,StreamStateHandle> getPrivateState()

getMetaStateHandle

public StreamStateHandle getMetaStateHandle()

getBackendIdentifier

@Nonnull
public UUID getBackendIdentifier()

从接口复制的说明: IncrementalKeyedStateHandle

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

指定者:

getBackendIdentifier 在接口中 IncrementalKeyedStateHandle

getSharedStateHandles

@Nonnull
public Map<StateHandleID,StreamStateHandle> getSharedStateHandles()

从接口复制的说明: IncrementalKeyedStateHandle

Returns a set of ids of all registered shared states in the backend at the time this was created.

指定者:

getSharedStateHandles 在接口中 IncrementalKeyedStateHandle

getSharedStateRegistry

public SharedStateRegistry getSharedStateRegistry()

getIntersection

public KeyedStateHandle getIntersection(KeyGroupRange keyGroupRange)

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

参数:

keyGroupRange - 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.

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.

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.

createSharedStateRegistryKeyFromFileName

@VisibleForTesting
public SharedStateRegistryKey createSharedStateRegistryKeyFromFileName(StateHandleID shId)

Create a unique key to register one of our shared state handles.

equals

@VisibleForTesting
public boolean equals(Object o)

This method is should only be called in tests! This should never serve as key in a hash map.

覆盖:

equals 在类中 Object

hashCode

@VisibleForTesting
public int hashCode()

This method should only be called in tests! This should never serve as key in a hash map.

覆盖:

hashCode 在类中 Object

toString

public String toString()

覆盖:

toString 在类中 Object