org.apache.flink.runtime.state.metainfo

Class StateMetaInfoSnapshot

java.lang.Object

org.apache.flink.runtime.state.metainfo.StateMetaInfoSnapshot

public class StateMetaInfoSnapshot
extends Object

Generalized snapshot for meta information about one state in a state backend (e.g. RegisteredKeyValueStateBackendMetaInfo).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StateMetaInfoSnapshot.BackendStateType Enum that defines the different types of state that live in Flink backends.
static class	StateMetaInfoSnapshot.CommonOptionsKeys Predefined keys for the most common options in the meta info.
static class	StateMetaInfoSnapshot.CommonSerializerKeys Predefined keys for the most common serializer types in the meta info.

Constructor Summary

Constructors

Constructor and Description
StateMetaInfoSnapshot(String name, StateMetaInfoSnapshot.BackendStateType backendStateType, Map<String,String> options, Map<String,TypeSerializerSnapshot<?>> serializerSnapshots)
StateMetaInfoSnapshot(String name, StateMetaInfoSnapshot.BackendStateType backendStateType, Map<String,String> options, Map<String,TypeSerializerSnapshot<?>> serializerSnapshots, Map<String,TypeSerializer<?>> serializers) TODO this variant, which requires providing the serializers, TODO should actually be removed, leaving only StateMetaInfoSnapshot(String, BackendStateType, Map, Map).

Method Summary

Modifier and Type	Method and Description
StateMetaInfoSnapshot.BackendStateType	getBackendStateType()
String	getName()
String	getOption(StateMetaInfoSnapshot.CommonOptionsKeys key)
String	getOption(String key)
Map<String,String>	getOptionsImmutable()
Map<String,TypeSerializerSnapshot<?>>	getSerializerSnapshotsImmutable()
TypeSerializer<?>	getTypeSerializer(String key) TODO this method should be removed once the serializer map is removed.
TypeSerializerSnapshot<?>	getTypeSerializerSnapshot(StateMetaInfoSnapshot.CommonSerializerKeys key)
TypeSerializerSnapshot<?>	getTypeSerializerSnapshot(String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

StateMetaInfoSnapshot

public StateMetaInfoSnapshot(@Nonnull
                             String name,
                             @Nonnull
                             StateMetaInfoSnapshot.BackendStateType backendStateType,
                             @Nonnull
                             Map<String,String> options,
                             @Nonnull
                             Map<String,TypeSerializerSnapshot<?>> serializerSnapshots)

StateMetaInfoSnapshot

public StateMetaInfoSnapshot(@Nonnull
                             String name,
                             @Nonnull
                             StateMetaInfoSnapshot.BackendStateType backendStateType,
                             @Nonnull
                             Map<String,String> options,
                             @Nonnull
                             Map<String,TypeSerializerSnapshot<?>> serializerSnapshots,
                             @Nonnull
                             Map<String,TypeSerializer<?>> serializers)

TODO this variant, which requires providing the serializers, TODO should actually be removed, leaving only StateMetaInfoSnapshot(String, BackendStateType, Map, Map). TODO This is still used by snapshot extracting methods (i.e. computeSnapshot() method of specific state meta TODO info subclasses), and will be removed once all serializers have the restoreSerializer() factory method implemented.

Method Detail

getBackendStateType

@Nonnull
public StateMetaInfoSnapshot.BackendStateType getBackendStateType()

getTypeSerializerSnapshot

@Nullable
public TypeSerializerSnapshot<?> getTypeSerializerSnapshot(@Nonnull
                                                                     String key)

getTypeSerializerSnapshot

@Nullable
public TypeSerializerSnapshot<?> getTypeSerializerSnapshot(@Nonnull
                                                                     StateMetaInfoSnapshot.CommonSerializerKeys key)

getOption

@Nullable
public String getOption(@Nonnull
                                  String key)

getOption

@Nullable
public String getOption(@Nonnull
                                  StateMetaInfoSnapshot.CommonOptionsKeys key)

getOptionsImmutable

@Nonnull
public Map<String,String> getOptionsImmutable()

getName

@Nonnull
public String getName()

getSerializerSnapshotsImmutable

@Nonnull
public Map<String,TypeSerializerSnapshot<?>> getSerializerSnapshotsImmutable()

getTypeSerializer

@Nullable
public TypeSerializer<?> getTypeSerializer(@Nonnull
                                                     String key)

TODO this method should be removed once the serializer map is removed.