org.apache.flink.streaming.api.graph

Class StreamGraph

java.lang.Object

org.apache.flink.optimizer.plan.StreamingPlan

org.apache.flink.streaming.api.graph.StreamGraph

All Implemented Interfaces:

org.apache.flink.optimizer.plan.FlinkPlan

public class StreamGraph
extends org.apache.flink.optimizer.plan.StreamingPlan

Class representing the streaming topology. It contains all the information necessary to build the jobgraph for the execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamGraph.ResourceStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CHECKPOINTING_INTERVAL_MS The default interval for checkpoints, in milliseconds
protected Map<Integer,String>	vertexIDtoBrokerID
protected Map<Integer,Long>	vertexIDtoLoopTimeout

Constructor Summary

Constructors

Constructor and Description
StreamGraph(StreamExecutionEnvironment environment)

Method Summary

Modifier and Type	Method and Description
<IN1,IN2,OUT> void	addCoOperator(Integer vertexID, TwoInputStreamOperator<IN1,IN2,OUT> taskOperatorObject, org.apache.flink.api.common.typeinfo.TypeInformation<IN1> in1TypeInfo, org.apache.flink.api.common.typeinfo.TypeInformation<IN2> in2TypeInfo, org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo, String operatorName)
void	addEdge(Integer upStreamVertexID, Integer downStreamVertexID, int typeNumber)
protected StreamNode	addNode(Integer vertexID, Class<? extends org.apache.flink.runtime.jobgraph.tasks.AbstractInvokable> vertexClass, StreamOperator<?> operatorObject, String operatorName)
<IN,OUT> void	addOperator(Integer vertexID, StreamOperator<OUT> operatorObject, org.apache.flink.api.common.typeinfo.TypeInformation<IN> inTypeInfo, org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo, String operatorName)
<T> void	addOutputSelector(Integer vertexID, OutputSelector<T> outputSelector)
<IN,OUT> void	addSink(Integer vertexID, StreamOperator<OUT> operatorObject, org.apache.flink.api.common.typeinfo.TypeInformation<IN> inTypeInfo, org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo, String operatorName)
<IN,OUT> void	addSource(Integer vertexID, StreamOperator<OUT> operatorObject, org.apache.flink.api.common.typeinfo.TypeInformation<IN> inTypeInfo, org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo, String operatorName)
void	addVirtualPartitionNode(Integer originalId, Integer virtualId, StreamPartitioner<?> partitioner) Adds a new virtual node that is used to connect a downstream vertex to an input with a certain partitioning.
void	addVirtualSelectNode(Integer originalId, Integer virtualId, List<String> selectedNames) Adds a new virtual node that is used to connect a downstream vertex to only the outputs with the selected names.
void	clear() Remove all registered nodes etc.
org.apache.flink.api.java.tuple.Tuple2<StreamNode,StreamNode>	createIterationSourceAndSink(int loopId, int sourceId, int sinkId, long timeout, int parallelism)
void	dumpStreamingPlanAsJSON(File file)
void	forceCheckpoint()
String	getBrokerID(Integer vertexID)
long	getCheckpointingInterval()
CheckpointingMode	getCheckpointingMode()
protected org.apache.flink.api.common.ExecutionConfig	getExecutionConfig()
Set<org.apache.flink.api.java.tuple.Tuple2<StreamNode,StreamNode>>	getIterationSourceSinkPairs()
org.apache.flink.runtime.jobgraph.JobGraph	getJobGraph() Gets the assembled JobGraph and adds a default name for it.
org.apache.flink.runtime.jobgraph.JobGraph	getJobGraph(String jobGraphName) Gets the assembled JobGraph and adds a user specified name for it.
long	getLoopTimeout(Integer vertexID)
Set<org.apache.flink.api.java.tuple.Tuple2<Integer,StreamOperator<?>>>	getOperators()
Collection<Integer>	getSinkIDs()
Collection<Integer>	getSourceIDs()
org.apache.flink.runtime.state.StateBackend<?>	getStateBackend()
StreamEdge	getStreamEdge(int sourceId, int targetId)
String	getStreamingPlanAsJSON()
StreamNode	getStreamNode(Integer vertexID)
Collection<StreamNode>	getStreamNodes()
protected Collection<? extends Integer>	getVertexIDs()
boolean	isChainingEnabled()
boolean	isCheckpointingEnabled()
boolean	isIterative()
protected void	removeEdge(StreamEdge edge)
protected void	removeVertex(StreamNode toRemove)
void	setBufferTimeout(Integer vertexID, long bufferTimeout)
void	setChaining(boolean chaining)
void	setCheckpointingEnabled(boolean checkpointingEnabled)
void	setCheckpointingInterval(long checkpointingInterval)
void	setCheckpointingMode(CheckpointingMode checkpointingMode)
void	setInputFormat(Integer vertexID, org.apache.flink.api.common.io.InputFormat<?,?> inputFormat)
void	setJobName(String jobName)
void	setKey(Integer vertexID, org.apache.flink.api.java.functions.KeySelector<?,?> keySelector, org.apache.flink.api.common.typeutils.TypeSerializer<?> keySerializer)
<IN,OUT> void	setOperator(Integer vertexID, StreamOperator<OUT> operatorObject)
<OUT> void	setOutType(Integer vertexID, org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outType)
void	setParallelism(Integer vertexID, int parallelism)
void	setResourceStrategy(Integer vertexID, StreamGraph.ResourceStrategy strategy)
void	setSerializers(Integer vertexID, org.apache.flink.api.common.typeutils.TypeSerializer<?> in1, org.apache.flink.api.common.typeutils.TypeSerializer<?> in2, org.apache.flink.api.common.typeutils.TypeSerializer<?> out)
void	setSerializersFrom(Integer from, Integer to)
void	setStateBackend(org.apache.flink.runtime.state.StateBackend<?> backend)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHECKPOINTING_INTERVAL_MS

public static final int DEFAULT_CHECKPOINTING_INTERVAL_MS

The default interval for checkpoints, in milliseconds

See Also:

Constant Field Values

vertexIDtoBrokerID

protected Map<Integer,String> vertexIDtoBrokerID

vertexIDtoLoopTimeout

protected Map<Integer,Long> vertexIDtoLoopTimeout

Constructor Detail

StreamGraph

public StreamGraph(StreamExecutionEnvironment environment)

Method Detail

clear

public void clear()

Remove all registered nodes etc.

getExecutionConfig

protected org.apache.flink.api.common.ExecutionConfig getExecutionConfig()

setJobName

public void setJobName(String jobName)

setChaining

public void setChaining(boolean chaining)

setCheckpointingEnabled

public void setCheckpointingEnabled(boolean checkpointingEnabled)

setCheckpointingInterval

public void setCheckpointingInterval(long checkpointingInterval)

forceCheckpoint

public void forceCheckpoint()

setStateBackend

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

getStateBackend

public org.apache.flink.runtime.state.StateBackend<?> getStateBackend()

getCheckpointingInterval

public long getCheckpointingInterval()

isChainingEnabled

public boolean isChainingEnabled()

isCheckpointingEnabled

public boolean isCheckpointingEnabled()

getCheckpointingMode

public CheckpointingMode getCheckpointingMode()

setCheckpointingMode

public void setCheckpointingMode(CheckpointingMode checkpointingMode)

isIterative

public boolean isIterative()

addSource

public <IN,OUT> void addSource(Integer vertexID,
                               StreamOperator<OUT> operatorObject,
                               org.apache.flink.api.common.typeinfo.TypeInformation<IN> inTypeInfo,
                               org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo,
                               String operatorName)

addSink

public <IN,OUT> void addSink(Integer vertexID,
                             StreamOperator<OUT> operatorObject,
                             org.apache.flink.api.common.typeinfo.TypeInformation<IN> inTypeInfo,
                             org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo,
                             String operatorName)

addOperator

public <IN,OUT> void addOperator(Integer vertexID,
                                 StreamOperator<OUT> operatorObject,
                                 org.apache.flink.api.common.typeinfo.TypeInformation<IN> inTypeInfo,
                                 org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo,
                                 String operatorName)

addCoOperator

public <IN1,IN2,OUT> void addCoOperator(Integer vertexID,
                                        TwoInputStreamOperator<IN1,IN2,OUT> taskOperatorObject,
                                        org.apache.flink.api.common.typeinfo.TypeInformation<IN1> in1TypeInfo,
                                        org.apache.flink.api.common.typeinfo.TypeInformation<IN2> in2TypeInfo,
                                        org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo,
                                        String operatorName)

addNode

protected StreamNode addNode(Integer vertexID,
                             Class<? extends org.apache.flink.runtime.jobgraph.tasks.AbstractInvokable> vertexClass,
                             StreamOperator<?> operatorObject,
                             String operatorName)

addVirtualSelectNode

public void addVirtualSelectNode(Integer originalId,
                                 Integer virtualId,
                                 List<String> selectedNames)

Adds a new virtual node that is used to connect a downstream vertex to only the outputs with the selected names. When adding an edge from the virtual node to a downstream node the connection will be made to the original node, only with the selected names given here.

Parameters:

originalId - ID of the node that should be connected to.

virtualId - ID of the virtual node.

selectedNames - The selected names.

addVirtualPartitionNode

public void addVirtualPartitionNode(Integer originalId,
                                    Integer virtualId,
                                    StreamPartitioner<?> partitioner)

Adds a new virtual node that is used to connect a downstream vertex to an input with a certain partitioning. When adding an edge from the virtual node to a downstream node the connection will be made to the original node, but with the partitioning given here.

Parameters:

originalId - ID of the node that should be connected to.

virtualId - ID of the virtual node.

partitioner - The partitioner

addEdge

public void addEdge(Integer upStreamVertexID,
                    Integer downStreamVertexID,
                    int typeNumber)

addOutputSelector

public <T> void addOutputSelector(Integer vertexID,
                                  OutputSelector<T> outputSelector)

setParallelism

public void setParallelism(Integer vertexID,
                           int parallelism)

setKey

public void setKey(Integer vertexID,
                   org.apache.flink.api.java.functions.KeySelector<?,?> keySelector,
                   org.apache.flink.api.common.typeutils.TypeSerializer<?> keySerializer)

setBufferTimeout

public void setBufferTimeout(Integer vertexID,
                             long bufferTimeout)

setSerializers

public void setSerializers(Integer vertexID,
                           org.apache.flink.api.common.typeutils.TypeSerializer<?> in1,
                           org.apache.flink.api.common.typeutils.TypeSerializer<?> in2,
                           org.apache.flink.api.common.typeutils.TypeSerializer<?> out)

setSerializersFrom

public void setSerializersFrom(Integer from,
                               Integer to)

setOutType

public <OUT> void setOutType(Integer vertexID,
                             org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outType)

setOperator

public <IN,OUT> void setOperator(Integer vertexID,
                                 StreamOperator<OUT> operatorObject)

setInputFormat

public void setInputFormat(Integer vertexID,
                           org.apache.flink.api.common.io.InputFormat<?,?> inputFormat)

setResourceStrategy

public void setResourceStrategy(Integer vertexID,
                                StreamGraph.ResourceStrategy strategy)

getStreamNode

public StreamNode getStreamNode(Integer vertexID)

getVertexIDs

protected Collection<? extends Integer> getVertexIDs()

getStreamEdge

public StreamEdge getStreamEdge(int sourceId,
                                int targetId)

getSourceIDs

public Collection<Integer> getSourceIDs()

getSinkIDs

public Collection<Integer> getSinkIDs()

getStreamNodes

public Collection<StreamNode> getStreamNodes()

getOperators

public Set<org.apache.flink.api.java.tuple.Tuple2<Integer,StreamOperator<?>>> getOperators()

getBrokerID

public String getBrokerID(Integer vertexID)

getLoopTimeout

public long getLoopTimeout(Integer vertexID)

createIterationSourceAndSink

public org.apache.flink.api.java.tuple.Tuple2<StreamNode,StreamNode> createIterationSourceAndSink(int loopId,
                                                                                                  int sourceId,
                                                                                                  int sinkId,
                                                                                                  long timeout,
                                                                                                  int parallelism)

getIterationSourceSinkPairs

public Set<org.apache.flink.api.java.tuple.Tuple2<StreamNode,StreamNode>> getIterationSourceSinkPairs()

removeEdge

protected void removeEdge(StreamEdge edge)

removeVertex

protected void removeVertex(StreamNode toRemove)

getJobGraph

public org.apache.flink.runtime.jobgraph.JobGraph getJobGraph()

Gets the assembled JobGraph and adds a default name for it.

Specified by:

getJobGraph in class org.apache.flink.optimizer.plan.StreamingPlan

getJobGraph

public org.apache.flink.runtime.jobgraph.JobGraph getJobGraph(String jobGraphName)

Gets the assembled JobGraph and adds a user specified name for it.

Parameters:

jobGraphName - name of the jobGraph

getStreamingPlanAsJSON

public String getStreamingPlanAsJSON()

Specified by:

getStreamingPlanAsJSON in class org.apache.flink.optimizer.plan.StreamingPlan

dumpStreamingPlanAsJSON

public void dumpStreamingPlanAsJSON(File file)
                             throws IOException

Specified by:

dumpStreamingPlanAsJSON in class org.apache.flink.optimizer.plan.StreamingPlan

Throws:

IOException