org.apache.tez.dag.api

Class EdgeProperty

java.lang.Object

org.apache.tez.dag.api.EdgeProperty

@InterfaceAudience.Public
public class EdgeProperty
extends Object

An @link EdgeProperty defines the relation between the source and destination vertices of an edge. The relation consists of defining their communication pattern and dependencies. It also defines the user code that actually does the job of writing out data at the source and reading that data at the destination via the @link InputDescriptor and @link OutputDescriptor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EdgeProperty.DataMovementType Defines the manner of data movement between source and destination tasks.
static class	EdgeProperty.DataSourceType Determines the lifetime of the data produced on this edge by a source task.
static class	EdgeProperty.SchedulingType Determines when the destination task is eligible to run, once the source task is eligible to run.

Method Summary

Methods

Modifier and Type	Method and Description
static EdgeProperty	create(EdgeManagerPluginDescriptor edgeManagerDescriptor, EdgeProperty.DataMovementType dataMovementType, EdgeProperty.DataSourceType dataSourceType, EdgeProperty.SchedulingType schedulingType, OutputDescriptor edgeSource, InputDescriptor edgeDestination)
static EdgeProperty	create(EdgeManagerPluginDescriptor edgeManagerDescriptor, EdgeProperty.DataSourceType dataSourceType, EdgeProperty.SchedulingType schedulingType, OutputDescriptor edgeSource, InputDescriptor edgeDestination) Setup an Edge which uses a custom EdgeManager
static EdgeProperty	create(EdgeProperty.DataMovementType dataMovementType, EdgeProperty.DataSourceType dataSourceType, EdgeProperty.SchedulingType schedulingType, OutputDescriptor edgeSource, InputDescriptor edgeDestination) Setup an EdgeProperty which makes use of one of the provided EdgeProperty.DataMovementTypes
EdgeProperty.DataMovementType	getDataMovementType() Get the EdgeProperty.DataMovementType
EdgeProperty.DataSourceType	getDataSourceType() Get the EdgeProperty.DataSourceType
InputDescriptor	getEdgeDestination()
EdgeManagerPluginDescriptor	getEdgeManagerDescriptor() Returns the Edge Manager specifications for this edge.
OutputDescriptor	getEdgeSource()
EdgeProperty.SchedulingType	getSchedulingType() Get the EdgeProperty.SchedulingType
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static EdgeProperty create(EdgeProperty.DataMovementType dataMovementType,
                  EdgeProperty.DataSourceType dataSourceType,
                  EdgeProperty.SchedulingType schedulingType,
                  OutputDescriptor edgeSource,
                  InputDescriptor edgeDestination)

Setup an EdgeProperty which makes use of one of the provided EdgeProperty.DataMovementTypes

Parameters:

dataMovementType -

dataSourceType -

schedulingType -

edgeSource - The OutputDescriptor that generates data on the edge.

edgeDestination - The InputDescriptor which will consume data from the edge.

create

public static EdgeProperty create(EdgeManagerPluginDescriptor edgeManagerDescriptor,
                  EdgeProperty.DataSourceType dataSourceType,
                  EdgeProperty.SchedulingType schedulingType,
                  OutputDescriptor edgeSource,
                  InputDescriptor edgeDestination)

Setup an Edge which uses a custom EdgeManager

Parameters:

edgeManagerDescriptor - the EdgeManager specifications. This can be null if the edge manager will be setup at runtime

dataSourceType -

schedulingType -

edgeSource - The OutputDescriptor that generates data on the edge.

edgeDestination - The InputDescriptor which will consume data from the edge.

create

@InterfaceAudience.Private
public static EdgeProperty create(EdgeManagerPluginDescriptor edgeManagerDescriptor,
                                            EdgeProperty.DataMovementType dataMovementType,
                                            EdgeProperty.DataSourceType dataSourceType,
                                            EdgeProperty.SchedulingType schedulingType,
                                            OutputDescriptor edgeSource,
                                            InputDescriptor edgeDestination)

getDataMovementType

public EdgeProperty.DataMovementType getDataMovementType()

Get the EdgeProperty.DataMovementType

Returns:

EdgeProperty.DataMovementType

getDataSourceType

public EdgeProperty.DataSourceType getDataSourceType()

Get the EdgeProperty.DataSourceType

Returns:

EdgeProperty.DataSourceType

getSchedulingType

public EdgeProperty.SchedulingType getSchedulingType()

Get the EdgeProperty.SchedulingType

Returns:

EdgeProperty.SchedulingType

getEdgeDestination

public InputDescriptor getEdgeDestination()

Returns:

the InputDescriptor which will consume data from the edge.

getEdgeSource

public OutputDescriptor getEdgeSource()

Returns:

the OutputDescriptor which produces data on the edge.

getEdgeManagerDescriptor

@InterfaceAudience.Private
public EdgeManagerPluginDescriptor getEdgeManagerDescriptor()

Returns the Edge Manager specifications for this edge.

Returns:

@link EdgeManagerPluginDescriptor if a custom edge was setup, null otherwise.

toString

public String toString()

Overrides:

toString in class Object