ContextKey (Flink : State backends : ForSt 1.20.2-cp1 API)

java.lang.Object
- org.apache.flink.state.forst.ContextKey<K>

Type Parameters:

K - The type of the raw key.
```
@ThreadSafe
public class ContextKey<K>
extends Object
```
The composite key which contains some context information, such as keyGroup, etc.

Constructor Summary

Constructors
Constructor Description

ContextKey(org.apache.flink.runtime.asyncprocessing.RecordContext<K> recordContext)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`int`	`getKeyGroup()`
`byte[]`	`getOrCreateSerializedKey(org.apache.flink.util.function.FunctionWithException<ContextKey<K>,byte[],IOException> serializeKeyFunc)`	Get the serialized key.
`K`	`getRawKey()`
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ContextKey
```
public ContextKey(org.apache.flink.runtime.asyncprocessing.RecordContext<K> recordContext)
```
- Method Detail
  - getRawKey
```
public K getRawKey()
```
  - getKeyGroup
```
public int getKeyGroup()
```
  - getOrCreateSerializedKey
```
public byte[] getOrCreateSerializedKey(org.apache.flink.util.function.FunctionWithException<ContextKey<K>,byte[],IOException> serializeKeyFunc)
                                throws IOException
```
    Get the serialized key. If the cached serialized key within RecordContext#payload is null, the provided serialization function will be called, and the serialization result will be cached by RecordContext#payload.
    
    Parameters:
    
    serializeKeyFunc - the provided serialization function for this contextKey.
    
    Returns:
    
    the serialized bytes.
    
    Throws:
    
    IOException
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object