KeyGroupsStateHandle (Flink : Runtime 1.14.5 API)

java.lang.Object
- org.apache.flink.runtime.state.KeyGroupsStateHandle

所有已实现的接口:

Serializable, CompositeStateHandle, KeyedStateHandle, StateObject, StreamStateHandle

直接已知子类:

KeyGroupsSavepointStateHandle
```
public class KeyGroupsStateHandle
extends Object
implements StreamStateHandle, KeyedStateHandle
```
A handle to the partitioned stream operator state after it has been checkpointed. This state consists of a range of key group snapshots. A key group is subset of the available key space. The key groups are identified by their key group indices.

另请参阅:

序列化表格

构造器概要

构造器
构造器和说明

KeyGroupsStateHandle(KeyGroupRangeOffsets groupRangeOffsets, StreamStateHandle streamStateHandle)

构造器
构造器和说明
`KeyGroupsStateHandle(KeyGroupRangeOffsets groupRangeOffsets, StreamStateHandle streamStateHandle)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Optional<byte[]>`	`asBytesIfInMemory()`
`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)`
`StreamStateHandle`	`getDelegateStateHandle()`
`KeyGroupRangeOffsets`	`getGroupRangeOffsets()`
`KeyGroupsStateHandle`	`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.
`long`	`getOffsetForKeyGroup(int keyGroupId)`
`long`	`getStateSize()` Returns the size of the state in bytes.
`int`	`hashCode()`
`org.apache.flink.core.fs.FSDataInputStream`	`openInputStream()` Returns an `FSDataInputStream` that can be used to read back the data that was previously written to the stream.
`void`	`registerSharedStates(SharedStateRegistry stateRegistry)` 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

- 构造器详细资料
  - KeyGroupsStateHandle
```
public KeyGroupsStateHandle(KeyGroupRangeOffsets groupRangeOffsets,
                            StreamStateHandle streamStateHandle)
```
    参数:
    
    groupRangeOffsets - range of key-group ids that in the state of this handle
    
    streamStateHandle - handle to the actual state of the key-groups
- 方法详细资料
  - getGroupRangeOffsets
```
public KeyGroupRangeOffsets getGroupRangeOffsets()
```
    返回:
    
    the internal key-group range to offsets metadata
  - getDelegateStateHandle
```
public StreamStateHandle getDelegateStateHandle()
```
    返回:
    
    The handle to the actual states
  - getOffsetForKeyGroup
```
public long getOffsetForKeyGroup(int keyGroupId)
```
    参数:
    
    keyGroupId - the id of a key-group. the id must be contained in the range of this handle.
    
    返回:
    
    offset to the position of data for the provided key-group in the stream referenced by this state handle
  - getIntersection
```
public KeyGroupsStateHandle 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 - a key group range to intersect.
    
    返回:
    
    key-group state over a range that is the intersection between this handle's key-group range and the provided key-group range.
  - getKeyGroupRange
```
public KeyGroupRange getKeyGroupRange()
```
    从接口复制的说明: KeyedStateHandle
    
    Returns the range of the key groups contained in the state.
    
    指定者:
    
    getKeyGroupRange 在接口中 KeyedStateHandle
  - registerSharedStates
```
public void registerSharedStates(SharedStateRegistry stateRegistry)
```
    从接口复制的说明: 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.
  - 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.
  - openInputStream
```
public org.apache.flink.core.fs.FSDataInputStream openInputStream()
                                                           throws IOException
```
    从接口复制的说明: StreamStateHandle
    
    Returns an FSDataInputStream that can be used to read back the data that was previously written to the stream.
    
    指定者:
    
    openInputStream 在接口中 StreamStateHandle
    
    抛出:
    
    IOException
  - asBytesIfInMemory
```
public Optional<byte[]> asBytesIfInMemory()
```
    指定者:
    
    asBytesIfInMemory 在接口中 StreamStateHandle
    
    返回:
    
    Content of this handle as bytes array if it is already in memory.
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 KeyGroupsStateHandle

构造器概要

方法概要

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

构造器详细资料

KeyGroupsStateHandle

方法详细资料

getGroupRangeOffsets

getDelegateStateHandle

getOffsetForKeyGroup

getIntersection

getKeyGroupRange

registerSharedStates

discardState

getStateSize

openInputStream

asBytesIfInMemory

equals

hashCode

toString