org.apache.flink.queryablestate.client.state

Class ImmutableAggregatingState<IN,OUT>

java.lang.Object

org.apache.flink.queryablestate.client.state.ImmutableAggregatingState<IN,OUT>

All Implemented Interfaces:

AggregatingState<IN,OUT>, AppendingState<IN,OUT>, MergingState<IN,OUT>, State

@PublicEvolving
public final class ImmutableAggregatingState<IN,OUT>
extends Object
implements AggregatingState<IN,OUT>

A read-only AggregatingState that does not allow for modifications.

This is the type of the result returned when querying Flink's keyed state using the Queryable State Client and providing an AggregatingStateDescriptor.

Field Summary

Fields

Modifier and Type	Field and Description
protected static UnsupportedOperationException	MODIFICATION_ATTEMPT_ERROR

Method Summary

Modifier and Type	Method and Description
void	add(Object newValue) Updates the operator state accessible by AppendingState.get() by adding the given value to the list of values.
void	clear() Removes the value mapped under the current key.
static <IN,ACC,OUT> ImmutableAggregatingState<IN,OUT>	createState(AggregatingStateDescriptor<IN,ACC,OUT> stateDescriptor, byte[] serializedValue)
OUT	get() Returns the current value for the state.

Methods inherited from class java.lang.Object

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

Field Detail

MODIFICATION_ATTEMPT_ERROR

protected static final UnsupportedOperationException MODIFICATION_ATTEMPT_ERROR

Method Detail

get

public OUT get()

Description copied from interface: AppendingState

Returns the current value for the state. When the state is not partitioned the returned value is the same for all inputs in a given operator instance. If state partitioning is applied, the value returned depends on the current operator input, as the operator maintains an independent state for each partition.

NOTE TO IMPLEMENTERS: if the state is empty, then this method should return null.

Specified by:

get in interface AppendingState<IN,OUT>

Returns:

The operator state value corresponding to the current input or null if the state is empty.

add

public void add(Object newValue)

Description copied from interface: AppendingState

Updates the operator state accessible by AppendingState.get() by adding the given value to the list of values. The next time AppendingState.get() is called (for the same state partition) the returned state will represent the updated list.

If null is passed in, the state value will remain unchanged.

Specified by:

add in interface AppendingState<IN,OUT>

Parameters:

newValue - The new value for the state.

clear

public void clear()

Description copied from interface: State

Removes the value mapped under the current key.

Specified by:

clear in interface State

createState

public static <IN,ACC,OUT> ImmutableAggregatingState<IN,OUT> createState(AggregatingStateDescriptor<IN,ACC,OUT> stateDescriptor,
                                                                         byte[] serializedValue)
                                                                  throws IOException

Throws:

IOException