org.apache.flink.streaming.api.graph

Class StreamConfig

java.lang.Object

org.apache.flink.streaming.api.graph.StreamConfig

All Implemented Interfaces:

Serializable

@Internal
public class StreamConfig
extends Object
implements Serializable

Internal configuration for a StreamOperator. This is created and populated by the StreamingJobGraphGenerator.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StreamConfig.InputConfig Interface representing chained inputs.
static class	StreamConfig.InputRequirement Requirements of the different inputs of an operator.
static class	StreamConfig.NetworkInputConfig A representation of a Network StreamConfig.InputConfig.
static class	StreamConfig.SourceInputConfig A serialized representation of an input.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZEDUDF

Constructor Summary

Constructors

Constructor and Description
StreamConfig(org.apache.flink.configuration.Configuration config)

Method Summary

Modifier and Type	Method and Description
java.time.Duration	getAlignmentTimeout()
List<StreamEdge>	getChainedOutputs(ClassLoader cl)
int	getChainIndex()
CheckpointingMode	getCheckpointMode()
org.apache.flink.runtime.state.CheckpointStorage	getCheckpointStorage(ClassLoader cl)
org.apache.flink.configuration.Configuration	getConfiguration()
List<StreamEdge>	getInPhysicalEdges(ClassLoader cl)
StreamConfig.InputConfig[]	getInputs(ClassLoader cl)
String	getIterationId()
long	getIterationWaitTime()
double	getManagedMemoryFractionOperatorUseCaseOfSlot(org.apache.flink.core.memory.ManagedMemoryUseCase managedMemoryUseCase, org.apache.flink.configuration.Configuration taskManagerConfig, ClassLoader cl) Fraction of total managed memory in the slot that this operator should use for the given use case.
List<StreamEdge>	getNonChainedOutputs(ClassLoader cl)
int	getNumberOfNetworkInputs()
int	getNumberOfOutputs()
org.apache.flink.runtime.jobgraph.OperatorID	getOperatorID()
String	getOperatorName()
List<StreamEdge>	getOutEdgesInOrder(ClassLoader cl)
org.apache.flink.core.fs.Path	getSavepointDir(ClassLoader cl)
org.apache.flink.runtime.state.StateBackend	getStateBackend(ClassLoader cl)
<K> org.apache.flink.api.common.typeutils.TypeSerializer<K>	getStateKeySerializer(ClassLoader cl)
<IN,K extends Serializable> org.apache.flink.api.java.functions.KeySelector<IN,K>	getStatePartitioner(int input, ClassLoader cl)
<T extends StreamOperator<?>> T	getStreamOperator(ClassLoader cl)
<T extends StreamOperatorFactory<?>> T	getStreamOperatorFactory(ClassLoader cl)
TimeCharacteristic	getTimeCharacteristic()
InternalTimeServiceManager.Provider	getTimerServiceProvider(ClassLoader cl)
Map<Integer,StreamConfig>	getTransitiveChainedTaskConfigs(ClassLoader cl)
Map<Integer,StreamConfig>	getTransitiveChainedTaskConfigsWithSelf(ClassLoader cl)
<T> org.apache.flink.api.common.typeutils.TypeSerializer<T>	getTypeSerializerIn(int index, ClassLoader cl)
<T> org.apache.flink.api.common.typeutils.TypeSerializer<T>	getTypeSerializerIn1(ClassLoader cl) Deprecated.
<T> org.apache.flink.api.common.typeutils.TypeSerializer<T>	getTypeSerializerIn2(ClassLoader cl) Deprecated.
<T> org.apache.flink.api.common.typeutils.TypeSerializer<T>	getTypeSerializerOut(ClassLoader cl)
<T> org.apache.flink.api.common.typeutils.TypeSerializer<T>	getTypeSerializerSideOut(org.apache.flink.util.OutputTag<?> outputTag, ClassLoader cl)
Integer	getVertexID()
boolean	isChainEnd()
boolean	isChainStart()
boolean	isCheckpointingEnabled()
boolean	isExactlyOnceCheckpointMode()
boolean	isGraphContainingLoops()
boolean	isUnalignedCheckpointsEnabled()
static boolean	requiresSorting(StreamConfig.InputConfig inputConfig)
void	setAlignmentTimeout(java.time.Duration alignmentTimeout)
void	setChainedOutputs(List<StreamEdge> chainedOutputs)
void	setChainEnd()
void	setChainIndex(int index)
void	setChainStart()
void	setCheckpointingEnabled(boolean enabled)
void	setCheckpointMode(CheckpointingMode mode)
void	setCheckpointStorage(org.apache.flink.runtime.state.CheckpointStorage storage)
void	setGraphContainingLoops(boolean graphContainingLoops)
void	setInPhysicalEdges(List<StreamEdge> inEdges)
void	setInputs(StreamConfig.InputConfig... inputs)
void	setIterationId(String iterationId)
void	setIterationWaitTime(long time)
void	setManagedMemoryFractionOperatorOfUseCase(org.apache.flink.core.memory.ManagedMemoryUseCase managedMemoryUseCase, double fraction) Fraction of managed memory reserved for the given use case that this operator should use.
void	setNonChainedOutputs(List<StreamEdge> outputvertexIDs)
void	setNumberOfNetworkInputs(int numberOfInputs)
void	setNumberOfOutputs(int numberOfOutputs)
void	setOperatorID(org.apache.flink.runtime.jobgraph.OperatorID operatorID)
void	setOperatorName(String name)
void	setOutEdgesInOrder(List<StreamEdge> outEdgeList)
void	setSavepointDir(org.apache.flink.core.fs.Path directory)
void	setStateBackend(org.apache.flink.runtime.state.StateBackend backend)
void	setStateBackendUsesManagedMemory(boolean usesManagedMemory)
void	setStateKeySerializer(org.apache.flink.api.common.typeutils.TypeSerializer<?> serializer)
void	setStatePartitioner(int input, org.apache.flink.api.java.functions.KeySelector<?,?> partitioner)
void	setStreamOperator(StreamOperator<?> operator)
void	setStreamOperatorFactory(StreamOperatorFactory<?> factory)
void	setTimeCharacteristic(TimeCharacteristic characteristic)
void	setTimerServiceProvider(InternalTimeServiceManager.Provider timerServiceProvider)
void	setTransitiveChainedTaskConfigs(Map<Integer,StreamConfig> chainedTaskConfigs)
void	setTypeSerializerOut(org.apache.flink.api.common.typeutils.TypeSerializer<?> serializer)
void	setTypeSerializerSideOut(org.apache.flink.util.OutputTag<?> outputTag, org.apache.flink.api.common.typeutils.TypeSerializer<?> serializer)
void	setUnalignedCheckpointsEnabled(boolean enabled)
void	setupNetworkInputs(org.apache.flink.api.common.typeutils.TypeSerializer<?>... serializers)
void	setVertexID(Integer vertexID)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZEDUDF

@VisibleForTesting
public static final String SERIALIZEDUDF

See Also:

Constant Field Values

Constructor Detail

StreamConfig

public StreamConfig(org.apache.flink.configuration.Configuration config)

Method Detail

getConfiguration

public org.apache.flink.configuration.Configuration getConfiguration()

setVertexID

public void setVertexID(Integer vertexID)

getVertexID

public Integer getVertexID()

setManagedMemoryFractionOperatorOfUseCase

public void setManagedMemoryFractionOperatorOfUseCase(org.apache.flink.core.memory.ManagedMemoryUseCase managedMemoryUseCase,
                                                      double fraction)

Fraction of managed memory reserved for the given use case that this operator should use.

getManagedMemoryFractionOperatorUseCaseOfSlot

public double getManagedMemoryFractionOperatorUseCaseOfSlot(org.apache.flink.core.memory.ManagedMemoryUseCase managedMemoryUseCase,
                                                            org.apache.flink.configuration.Configuration taskManagerConfig,
                                                            ClassLoader cl)

Fraction of total managed memory in the slot that this operator should use for the given use case.

setTimeCharacteristic

public void setTimeCharacteristic(TimeCharacteristic characteristic)

getTimeCharacteristic

public TimeCharacteristic getTimeCharacteristic()

setTypeSerializerOut

public void setTypeSerializerOut(org.apache.flink.api.common.typeutils.TypeSerializer<?> serializer)

getTypeSerializerOut

public <T> org.apache.flink.api.common.typeutils.TypeSerializer<T> getTypeSerializerOut(ClassLoader cl)

setTypeSerializerSideOut

public void setTypeSerializerSideOut(org.apache.flink.util.OutputTag<?> outputTag,
                                     org.apache.flink.api.common.typeutils.TypeSerializer<?> serializer)

getTypeSerializerSideOut

public <T> org.apache.flink.api.common.typeutils.TypeSerializer<T> getTypeSerializerSideOut(org.apache.flink.util.OutputTag<?> outputTag,
                                                                                            ClassLoader cl)

setupNetworkInputs

public void setupNetworkInputs(org.apache.flink.api.common.typeutils.TypeSerializer<?>... serializers)

setInputs

public void setInputs(StreamConfig.InputConfig... inputs)

getInputs

public StreamConfig.InputConfig[] getInputs(ClassLoader cl)

getTypeSerializerIn1

@Deprecated
public <T> org.apache.flink.api.common.typeutils.TypeSerializer<T> getTypeSerializerIn1(ClassLoader cl)

Deprecated.

getTypeSerializerIn2

@Deprecated
public <T> org.apache.flink.api.common.typeutils.TypeSerializer<T> getTypeSerializerIn2(ClassLoader cl)

Deprecated.

getTypeSerializerIn

public <T> org.apache.flink.api.common.typeutils.TypeSerializer<T> getTypeSerializerIn(int index,
                                                                                       ClassLoader cl)

setStreamOperator

@VisibleForTesting
public void setStreamOperator(StreamOperator<?> operator)

setStreamOperatorFactory

public void setStreamOperatorFactory(StreamOperatorFactory<?> factory)

getStreamOperator

@VisibleForTesting
public <T extends StreamOperator<?>> T getStreamOperator(ClassLoader cl)

getStreamOperatorFactory

public <T extends StreamOperatorFactory<?>> T getStreamOperatorFactory(ClassLoader cl)

setIterationId

public void setIterationId(String iterationId)

getIterationId

public String getIterationId()

setIterationWaitTime

public void setIterationWaitTime(long time)

getIterationWaitTime

public long getIterationWaitTime()

setNumberOfNetworkInputs

public void setNumberOfNetworkInputs(int numberOfInputs)

getNumberOfNetworkInputs

public int getNumberOfNetworkInputs()

setNumberOfOutputs

public void setNumberOfOutputs(int numberOfOutputs)

getNumberOfOutputs

public int getNumberOfOutputs()

setNonChainedOutputs

public void setNonChainedOutputs(List<StreamEdge> outputvertexIDs)

getNonChainedOutputs

public List<StreamEdge> getNonChainedOutputs(ClassLoader cl)

setChainedOutputs

public void setChainedOutputs(List<StreamEdge> chainedOutputs)

getChainedOutputs

public List<StreamEdge> getChainedOutputs(ClassLoader cl)

setInPhysicalEdges

public void setInPhysicalEdges(List<StreamEdge> inEdges)

getInPhysicalEdges

public List<StreamEdge> getInPhysicalEdges(ClassLoader cl)

setCheckpointingEnabled

public void setCheckpointingEnabled(boolean enabled)

isCheckpointingEnabled

public boolean isCheckpointingEnabled()

setCheckpointMode

public void setCheckpointMode(CheckpointingMode mode)

getCheckpointMode

public CheckpointingMode getCheckpointMode()

setUnalignedCheckpointsEnabled

public void setUnalignedCheckpointsEnabled(boolean enabled)

isUnalignedCheckpointsEnabled

public boolean isUnalignedCheckpointsEnabled()

isExactlyOnceCheckpointMode

public boolean isExactlyOnceCheckpointMode()

getAlignmentTimeout

public java.time.Duration getAlignmentTimeout()

setAlignmentTimeout

public void setAlignmentTimeout(java.time.Duration alignmentTimeout)

setOutEdgesInOrder

public void setOutEdgesInOrder(List<StreamEdge> outEdgeList)

getOutEdgesInOrder

public List<StreamEdge> getOutEdgesInOrder(ClassLoader cl)

setTransitiveChainedTaskConfigs

public void setTransitiveChainedTaskConfigs(Map<Integer,StreamConfig> chainedTaskConfigs)

getTransitiveChainedTaskConfigs

public Map<Integer,StreamConfig> getTransitiveChainedTaskConfigs(ClassLoader cl)

getTransitiveChainedTaskConfigsWithSelf

public Map<Integer,StreamConfig> getTransitiveChainedTaskConfigsWithSelf(ClassLoader cl)

setOperatorID

public void setOperatorID(org.apache.flink.runtime.jobgraph.OperatorID operatorID)

getOperatorID

public org.apache.flink.runtime.jobgraph.OperatorID getOperatorID()

setOperatorName

public void setOperatorName(String name)

getOperatorName

public String getOperatorName()

setChainIndex

public void setChainIndex(int index)

getChainIndex

public int getChainIndex()

setStateBackend

public void setStateBackend(org.apache.flink.runtime.state.StateBackend backend)

setStateBackendUsesManagedMemory

@VisibleForTesting
public void setStateBackendUsesManagedMemory(boolean usesManagedMemory)

getStateBackend

public org.apache.flink.runtime.state.StateBackend getStateBackend(ClassLoader cl)

setSavepointDir

public void setSavepointDir(org.apache.flink.core.fs.Path directory)

getSavepointDir

public org.apache.flink.core.fs.Path getSavepointDir(ClassLoader cl)

setCheckpointStorage

public void setCheckpointStorage(org.apache.flink.runtime.state.CheckpointStorage storage)

getCheckpointStorage

public org.apache.flink.runtime.state.CheckpointStorage getCheckpointStorage(ClassLoader cl)

setTimerServiceProvider

public void setTimerServiceProvider(InternalTimeServiceManager.Provider timerServiceProvider)

getTimerServiceProvider

public InternalTimeServiceManager.Provider getTimerServiceProvider(ClassLoader cl)

setStatePartitioner

public void setStatePartitioner(int input,
                                org.apache.flink.api.java.functions.KeySelector<?,?> partitioner)

getStatePartitioner

public <IN,K extends Serializable> org.apache.flink.api.java.functions.KeySelector<IN,K> getStatePartitioner(int input,
                                                                                                             ClassLoader cl)

setStateKeySerializer

public void setStateKeySerializer(org.apache.flink.api.common.typeutils.TypeSerializer<?> serializer)

getStateKeySerializer

public <K> org.apache.flink.api.common.typeutils.TypeSerializer<K> getStateKeySerializer(ClassLoader cl)

setChainStart

public void setChainStart()

isChainStart

public boolean isChainStart()

setChainEnd

public void setChainEnd()

isChainEnd

public boolean isChainEnd()

toString

public String toString()

Overrides:

toString in class Object

setGraphContainingLoops

public void setGraphContainingLoops(boolean graphContainingLoops)

isGraphContainingLoops

public boolean isGraphContainingLoops()

requiresSorting

public static boolean requiresSorting(StreamConfig.InputConfig inputConfig)