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
static class	StreamGraph.StreamLoop Object for representing loops in streaming programs.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Integer,StreamGraph.StreamLoop>	vertexIDtoLoop

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, StreamPartitioner<?> partitionerObject, int typeNumber, List<String> outputNames)
void	addIterationHead(Integer sourceID, Integer iterationHead, Integer iterationID, long timeOut)
void	addIterationTail(Integer sinkID, Integer iterationTail, Integer iterationID, long waitTime)
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	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	clear() Remove all registered nodes etc.
void	dumpStreamingPlanAsJSON(File file)
void	forceCheckpoint()
long	getCheckpointingInterval()
protected org.apache.flink.api.common.ExecutionConfig	getExecutionConfig()
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.
Integer	getLoopID(Integer vertexID)
long	getLoopTimeout(Integer vertexID)
Set<org.apache.flink.api.java.tuple.Tuple2<Integer,StreamOperator<?>>>	getOperators()
Collection<Integer>	getSourceIDs()
org.apache.flink.runtime.state.StateHandleProvider<?>	getStateHandleProvider()
StreamEdge	getStreamEdge(int sourceId, int targetId)
String	getStreamingPlanAsJSON()
Collection<StreamGraph.StreamLoop>	getStreamLoops()
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	setInputFormat(Integer vertexID, org.apache.flink.api.common.io.InputFormat<?,?> inputFormat)
void	setJobName(String jobName)
<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	setStateHandleProvider(org.apache.flink.runtime.state.StateHandleProvider<?> provider)

Methods inherited from class java.lang.Object

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

Field Detail

vertexIDtoLoop

protected Map<Integer,StreamGraph.StreamLoop> vertexIDtoLoop

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()

setStateHandleProvider

public void setStateHandleProvider(org.apache.flink.runtime.state.StateHandleProvider<?> provider)

getStateHandleProvider

public org.apache.flink.runtime.state.StateHandleProvider<?> getStateHandleProvider()

getCheckpointingInterval

public long getCheckpointingInterval()

isChainingEnabled

public boolean isChainingEnabled()

isCheckpointingEnabled

public boolean isCheckpointingEnabled()

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)

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)

addIterationHead

public void addIterationHead(Integer sourceID,
                             Integer iterationHead,
                             Integer iterationID,
                             long timeOut)

addIterationTail

public void addIterationTail(Integer sinkID,
                             Integer iterationTail,
                             Integer iterationID,
                             long waitTime)

addNode

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

addEdge

public void addEdge(Integer upStreamVertexID,
                    Integer downStreamVertexID,
                    StreamPartitioner<?> partitionerObject,
                    int typeNumber,
                    List<String> outputNames)

addOutputSelector

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

setParallelism

public void setParallelism(Integer vertexID,
                           int parallelism)

setBufferTimeout

public void setBufferTimeout(Integer vertexID,
                             long bufferTimeout)

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()

getStreamNodes

public Collection<StreamNode> getStreamNodes()

getOperators

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

getStreamLoops

public Collection<StreamGraph.StreamLoop> getStreamLoops()

getLoopID

public Integer getLoopID(Integer vertexID)

getLoopTimeout

public long getLoopTimeout(Integer vertexID)

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