org.apache.flink.runtime.state

Class RegisteredKeyValueStateBackendMetaInfo<N,S>

java.lang.Object

org.apache.flink.runtime.state.RegisteredStateMetaInfoBase

org.apache.flink.runtime.state.RegisteredKeyValueStateBackendMetaInfo<N,S>

Type Parameters:

N - Type of namespace

S - Type of state value

public class RegisteredKeyValueStateBackendMetaInfo<N,S>
extends RegisteredStateMetaInfoBase

Compound meta information for a registered state in a keyed state backend. This combines all serializers and the state name.

Field Summary

Fields inherited from class org.apache.flink.runtime.state.RegisteredStateMetaInfoBase

name

Constructor Summary

Constructors

Constructor and Description
RegisteredKeyValueStateBackendMetaInfo(StateDescriptor.Type stateType, String name, TypeSerializer<N> namespaceSerializer, TypeSerializer<S> stateSerializer)
RegisteredKeyValueStateBackendMetaInfo(StateDescriptor.Type stateType, String name, TypeSerializer<N> namespaceSerializer, TypeSerializer<S> stateSerializer, StateSnapshotTransformer<S> snapshotTransformer)
RegisteredKeyValueStateBackendMetaInfo(StateMetaInfoSnapshot snapshot)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
TypeSerializer<N>	getNamespaceSerializer()
StateSnapshotTransformer<S>	getSnapshotTransformer()
TypeSerializer<S>	getStateSerializer()
StateDescriptor.Type	getStateType()
int	hashCode()
static <N,S> RegisteredKeyValueStateBackendMetaInfo<N,S>	resolveKvStateCompatibility(StateMetaInfoSnapshot restoredStateMetaInfoSnapshot, TypeSerializer<N> newNamespaceSerializer, StateDescriptor<?,S> newStateDescriptor, StateSnapshotTransformer<S> snapshotTransformer) Checks compatibility of a restored k/v state, with the new StateDescriptor provided to it.
StateMetaInfoSnapshot	snapshot()
String	toString()

Methods inherited from class org.apache.flink.runtime.state.RegisteredStateMetaInfoBase

fromMetaInfoSnapshot, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisteredKeyValueStateBackendMetaInfo

public RegisteredKeyValueStateBackendMetaInfo(@Nonnull
                                              StateDescriptor.Type stateType,
                                              @Nonnull
                                              String name,
                                              @Nonnull
                                              TypeSerializer<N> namespaceSerializer,
                                              @Nonnull
                                              TypeSerializer<S> stateSerializer)

RegisteredKeyValueStateBackendMetaInfo

public RegisteredKeyValueStateBackendMetaInfo(@Nonnull
                                              StateDescriptor.Type stateType,
                                              @Nonnull
                                              String name,
                                              @Nonnull
                                              TypeSerializer<N> namespaceSerializer,
                                              @Nonnull
                                              TypeSerializer<S> stateSerializer,
                                              @Nullable
                                              StateSnapshotTransformer<S> snapshotTransformer)

RegisteredKeyValueStateBackendMetaInfo

public RegisteredKeyValueStateBackendMetaInfo(@Nonnull
                                              StateMetaInfoSnapshot snapshot)

Method Detail

getStateType

@Nonnull
public StateDescriptor.Type getStateType()

getNamespaceSerializer

@Nonnull
public TypeSerializer<N> getNamespaceSerializer()

getStateSerializer

@Nonnull
public TypeSerializer<S> getStateSerializer()

getSnapshotTransformer

@Nullable
public StateSnapshotTransformer<S> getSnapshotTransformer()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

resolveKvStateCompatibility

@Nonnull
public static <N,S> RegisteredKeyValueStateBackendMetaInfo<N,S> resolveKvStateCompatibility(StateMetaInfoSnapshot restoredStateMetaInfoSnapshot,
                                                                                                     TypeSerializer<N> newNamespaceSerializer,
                                                                                                     StateDescriptor<?,S> newStateDescriptor,
                                                                                                     @Nullable
                                                                                                     StateSnapshotTransformer<S> snapshotTransformer)
                                                                                              throws StateMigrationException

Checks compatibility of a restored k/v state, with the new StateDescriptor provided to it. This checks that the descriptor specifies identical names and state types, as well as serializers that are compatible for the restored k/v state bytes.

Throws:

StateMigrationException

snapshot

@Nonnull
public StateMetaInfoSnapshot snapshot()

Specified by:

snapshot in class RegisteredStateMetaInfoBase