Package org.apache.flink.state.api.input

Class KeyedStateInputFormat<K,N,OUT>

java.lang.Object

org.apache.flink.api.common.io.RichInputFormat<OUT,KeyGroupRangeInputSplit>

org.apache.flink.state.api.input.KeyedStateInputFormat<K,N,OUT>

Type Parameters:

K - The type of the key.

OUT - The type of the output of the KeyedStateReaderFunction.

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.io.InputFormat<OUT,KeyGroupRangeInputSplit>, org.apache.flink.core.io.InputSplitSource<KeyGroupRangeInputSplit>

@Internal
public class KeyedStateInputFormat<K,N,OUT>
extends org.apache.flink.api.common.io.RichInputFormat<OUT,KeyGroupRangeInputSplit>

Input format for reading partitioned state.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
KeyedStateInputFormat(org.apache.flink.runtime.checkpoint.OperatorState operatorState, org.apache.flink.runtime.state.StateBackend stateBackend, org.apache.flink.configuration.Configuration configuration, StateReaderOperator<?,K,N,OUT> operator, org.apache.flink.api.common.ExecutionConfig executionConfig)	Creates an input format for reading partitioned state from an operator in a savepoint.

Method Summary

Modifier and Type	Method	Description
void	close()
void	configure(org.apache.flink.configuration.Configuration parameters)
KeyGroupRangeInputSplit[]	createInputSplits(int minNumSplits)
org.apache.flink.core.io.InputSplitAssigner	getInputSplitAssigner(KeyGroupRangeInputSplit[] inputSplits)
org.apache.flink.api.common.io.statistics.BaseStatistics	getStatistics(org.apache.flink.api.common.io.statistics.BaseStatistics cachedStatistics)
OUT	nextRecord(OUT reuse)
void	open(KeyGroupRangeInputSplit split)
void	openInputFormat()
boolean	reachedEnd()

Methods inherited from class org.apache.flink.api.common.io.RichInputFormat

closeInputFormat, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

KeyedStateInputFormat

public KeyedStateInputFormat(org.apache.flink.runtime.checkpoint.OperatorState operatorState,
 @Nullable
 org.apache.flink.runtime.state.StateBackend stateBackend,
 org.apache.flink.configuration.Configuration configuration,
 StateReaderOperator<?,K,N,OUT> operator,
 org.apache.flink.api.common.ExecutionConfig executionConfig)
                      throws IOException

Creates an input format for reading partitioned state from an operator in a savepoint.

Parameters:

operatorState - The state to be queried.

stateBackend - The state backed used to snapshot the operator.

configuration - The underlying Flink configuration used to configure the state backend.

Throws:

IOException

Method Details

configure

public void configure(org.apache.flink.configuration.Configuration parameters)

getInputSplitAssigner

public org.apache.flink.core.io.InputSplitAssigner getInputSplitAssigner(KeyGroupRangeInputSplit[] inputSplits)

getStatistics

public org.apache.flink.api.common.io.statistics.BaseStatistics getStatistics(org.apache.flink.api.common.io.statistics.BaseStatistics cachedStatistics)

createInputSplits

public KeyGroupRangeInputSplit[] createInputSplits(int minNumSplits)
                                            throws IOException

Throws:

IOException

openInputFormat

public void openInputFormat()

Overrides:

openInputFormat in class org.apache.flink.api.common.io.RichInputFormat<OUT,KeyGroupRangeInputSplit>

open

public void open(KeyGroupRangeInputSplit split)
          throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Throws:

IOException

reachedEnd

public boolean reachedEnd()

nextRecord

public OUT nextRecord(OUT reuse)
               throws IOException

Throws:

IOException