org.apache.flink.runtime.state

Interface StateBackend.KeyedStateBackendParameters<K>

Type Parameters:

K - The type of the keys by which the state is organized.

All Known Implementing Classes:

KeyedStateBackendParametersImpl

Enclosing interface:

StateBackend

@PublicEvolving
public static interface StateBackend.KeyedStateBackendParameters<K>

Parameters passed to StateBackend.createKeyedStateBackend(KeyedStateBackendParameters).

Method Summary

Modifier and Type	Method and Description
CloseableRegistry	getCancelStreamRegistry()
StateBackend.CustomInitializationMetrics	getCustomInitializationMetrics()
Environment	getEnv()
JobID	getJobID()
KeyGroupRange	getKeyGroupRange()
TypeSerializer<K>	getKeySerializer()
TaskKvStateRegistry	getKvStateRegistry()
double	getManagedMemoryFraction()
MetricGroup	getMetricGroup()
int	getNumberOfKeyGroups()
String	getOperatorIdentifier()
Collection<KeyedStateHandle>	getStateHandles()
TtlTimeProvider	getTtlTimeProvider()

Method Detail

getEnv

Environment getEnv()

Returns:

The runtime environment of the executing task.

getJobID

JobID getJobID()

getOperatorIdentifier

String getOperatorIdentifier()

getKeySerializer

TypeSerializer<K> getKeySerializer()

getNumberOfKeyGroups

int getNumberOfKeyGroups()

getKeyGroupRange

KeyGroupRange getKeyGroupRange()

Returns:

Range of key-groups for which the to-be-created backend is responsible.

getKvStateRegistry

TaskKvStateRegistry getKvStateRegistry()

getTtlTimeProvider

TtlTimeProvider getTtlTimeProvider()

Returns:

Provider for TTL logic to judge about state expiration.

getMetricGroup

MetricGroup getMetricGroup()

getStateHandles

@Nonnull
Collection<KeyedStateHandle> getStateHandles()

getCancelStreamRegistry

CloseableRegistry getCancelStreamRegistry()

Returns:

The registry to which created closeable objects will be * registered during restore.

getManagedMemoryFraction

double getManagedMemoryFraction()

getCustomInitializationMetrics

StateBackend.CustomInitializationMetrics getCustomInitializationMetrics()