org.apache.flink.runtime.topology

Interface PipelinedRegion<VID extends VertexID,RID extends ResultID,V extends Vertex<VID,RID,V,R>,R extends Result<VID,RID,V,R>>

Type Parameters:

VID - the type of the vertex ids

RID - the type of the result ids

V - the type of the vertices

R - the type of the result

All Known Subinterfaces:

LogicalPipelinedRegion, SchedulingPipelinedRegion

All Known Implementing Classes:

DefaultLogicalPipelinedRegion, DefaultSchedulingPipelinedRegion

public interface PipelinedRegion<VID extends VertexID,RID extends ResultID,V extends Vertex<VID,RID,V,R>,R extends Result<VID,RID,V,R>>

A pipelined region is a set of vertices connected via pipelined data exchanges.

Method Summary

Modifier and Type	Method and Description
boolean	contains(VID vertexId) Returns whether the vertex is in this pipelined region or not.
V	getVertex(VID vertexId) Returns the vertex with the specified vertex id.
Iterable<? extends V>	getVertices() Returns vertices that are in this pipelined region.

Method Detail

getVertices

Iterable<? extends V> getVertices()

Returns vertices that are in this pipelined region.

Returns:

Iterable over all vertices in this pipelined region

getVertex

V getVertex(VID vertexId)

Returns the vertex with the specified vertex id.

Parameters:

vertexId - the vertex id used to look up the vertex

Returns:

the vertex with the specified id

Throws:

IllegalArgumentException - if there is no vertex in this pipelined region with the specified vertex id

contains

boolean contains(VID vertexId)

Returns whether the vertex is in this pipelined region or not.

Parameters:

vertexId - the vertex id used to look up

Returns:

the vertex is in this pipelined region or not