Vertex (tez-api 0.6.0 API)

java.lang.Object
- org.apache.tez.dag.api.Vertex

Direct Known Subclasses:

PreWarmVertex
```
@InterfaceAudience.Public
public class Vertex
extends Object
```
Defines a vertex in the DAG. It represents the application logic that processes and transforms the input data to create the output data. The vertex represents the template from which tasks are created to execute the application in parallel across a distributed execution environment.

Method Summary

Methods
Modifier and Type	Method and Description
`Vertex`	`addDataSink(String outputName, DataSinkDescriptor dataSinkDescriptor)` Specifies an external data sink for a Vertex.
`Vertex`	`addDataSource(String inputName, DataSourceDescriptor dataSourceDescriptor)` Specifies an external data source for a Vertex.
`Vertex`	`addTaskLocalFiles(Map<String,org.apache.hadoop.yarn.api.records.LocalResource> localFiles)` Set the files etc that must be provided to the tasks of this vertex
`static Vertex`	`create(String vertexName, ProcessorDescriptor processorDescriptor)` Create a new vertex with the given name.
`static Vertex`	`create(String vertexName, ProcessorDescriptor processorDescriptor, int parallelism)` Create a new vertex with the given name and parallelism.
`static Vertex`	`create(String vertexName, ProcessorDescriptor processorDescriptor, int parallelism, org.apache.hadoop.yarn.api.records.Resource taskResource)` Create a new vertex with the given name.
`List<Vertex>`	`getInputVertices()` Get the input vertices for this vertex
`String`	`getName()` Get the vertex name
`List<Vertex>`	`getOutputVertices()` Get the output vertices for this vertex
`int`	`getParallelism()` Get the specified number of tasks specified to run in this vertex.
`ProcessorDescriptor`	`getProcessorDescriptor()` Get the vertex task processor descriptor
`Map<String,String>`	`getTaskEnvironment()` Get the environment variables of the tasks
`String`	`getTaskLaunchCmdOpts()` Get the launch command opts for tasks in this vertex
`Map<String,org.apache.hadoop.yarn.api.records.LocalResource>`	`getTaskLocalFiles()` Get the files etc that must be provided by the tasks of this vertex
`org.apache.hadoop.yarn.api.records.Resource`	`getTaskResource()` Get the resources for the vertex
`Vertex`	`setLocationHint(VertexLocationHint locationHint)` Specify location hints for the tasks of this vertex.
`Vertex`	`setTaskEnvironment(Map<String,String> environment)` Set the Key-Value pairs of environment variables for tasks of this vertex.
`Vertex`	`setTaskLaunchCmdOpts(String cmdOpts)` Set the command opts for tasks of this vertex.
`Vertex`	`setVertexManagerPlugin(VertexManagerPluginDescriptor vertexManagerPluginDescriptor)` Specifies a `VertexManagerPlugin` for the vertex.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - create
```
public static Vertex create(String vertexName,
            ProcessorDescriptor processorDescriptor,
            int parallelism,
            org.apache.hadoop.yarn.api.records.Resource taskResource)
```
    Create a new vertex with the given name.
    
    Parameters:
    vertexName - Name of the vertex
    processorDescriptor - Description of the processor that is executed in every task of this vertex
    parallelism - Number of tasks in this vertex. Set to -1 if this is going to be decided at runtime. Parallelism may change at runtime due to graph reconfigurations.
    taskResource - Physical resources like memory/cpu thats used by each task of this vertex.
    
    Returns:
    a new Vertex with the given parameters
  - create
```
public static Vertex create(String vertexName,
            ProcessorDescriptor processorDescriptor)
```
    Create a new vertex with the given name.
    The vertex task resource will be picked from configuration
    The vertex parallelism will be inferred. If it cannot be inferred then an error will be reported. This constructor may be used for vertices that have data sources, or connected via 1-1 edges or have runtime parallelism estimation via data source initializers or vertex managers. Calling this constructor is equivalent to calling Vertex(String, ProcessorDescriptor, int) with the parallelism set to -1.
    
    Parameters:
    vertexName - Name of the vertex
    processorDescriptor - Description of the processor that is executed in every task of this vertex
    
    Returns:
    a new Vertex with the given parameters
  - create
```
public static Vertex create(String vertexName,
            ProcessorDescriptor processorDescriptor,
            int parallelism)
```
    Create a new vertex with the given name and parallelism.
    The vertex task resource will be picked from configuration TezConfiguration.TEZ_TASK_RESOURCE_MEMORY_MB & TezConfiguration.TEZ_TASK_RESOURCE_CPU_VCORES Applications that want more control over their task resource specification may create their own logic to determine task resources and use Vertex(String, ProcessorDescriptor, int, Resource) to create the Vertex.
    
    Parameters:
    vertexName - Name of the vertex
    processorDescriptor - Description of the processor that is executed in every task of this vertex
    parallelism - Number of tasks in this vertex. Set to -1 if this is going to be decided at runtime. Parallelism may change at runtime due to graph reconfigurations.
    
    Returns:
    a new Vertex with the given parameters
  - getName
```
public String getName()
```
    Get the vertex name
    
    Returns:
    vertex name
  - getProcessorDescriptor
```
public ProcessorDescriptor getProcessorDescriptor()
```
    Get the vertex task processor descriptor
    
    Returns:
    process descriptor
  - getParallelism
```
public int getParallelism()
```
    Get the specified number of tasks specified to run in this vertex. It may be -1 if the parallelism is defined at runtime. Parallelism may change at runtime
    
    Returns:
    vertex parallelism
  - getTaskResource
```
public org.apache.hadoop.yarn.api.records.Resource getTaskResource()
```
    Get the resources for the vertex
    
    Returns:
    the physical resources like pcu/memory of each vertex task
  - setLocationHint
```
public Vertex setLocationHint(VertexLocationHint locationHint)
```
    Specify location hints for the tasks of this vertex. Hints must be specified for all tasks as defined by the parallelism
    
    Parameters:
    locationHint - list of locations for each task in the vertex
    
    Returns:
    this Vertex
  - addTaskLocalFiles
```
public Vertex addTaskLocalFiles(Map<String,org.apache.hadoop.yarn.api.records.LocalResource> localFiles)
```
    Set the files etc that must be provided to the tasks of this vertex
    
    Parameters:
    localFiles - files that must be available locally for each task. These files may be regular files, archives etc. as specified by the value elements of the map.
    
    Returns:
    this Vertex
  - getTaskLocalFiles
```
public Map<String,org.apache.hadoop.yarn.api.records.LocalResource> getTaskLocalFiles()
```
    Get the files etc that must be provided by the tasks of this vertex
    
    Returns:
    local files of the vertex. Key is the file name.
  - setTaskEnvironment
```
public Vertex setTaskEnvironment(Map<String,String> environment)
```
    Set the Key-Value pairs of environment variables for tasks of this vertex. This method should be used if different vertices need different env. Else, set environment for all vertices via Tezconfiguration#TEZ_TASK_LAUNCH_ENV
    
    Parameters:
    environment -
    
    Returns:
    this Vertex
  - getTaskEnvironment
```
public Map<String,String> getTaskEnvironment()
```
    Get the environment variables of the tasks
    
    Returns:
    environment variable map
  - setTaskLaunchCmdOpts
```
public Vertex setTaskLaunchCmdOpts(String cmdOpts)
```
    Set the command opts for tasks of this vertex. This method should be used when different vertices have different opts. Else, set the launch opts for ' all vertices via Tezconfiguration#TEZ_TASK_LAUNCH_CMD_OPTS
    
    Parameters:
    cmdOpts -
    
    Returns:
    this Vertex
  - addDataSource
```
public Vertex addDataSource(String inputName,
                   DataSourceDescriptor dataSourceDescriptor)
```
    Specifies an external data source for a Vertex. This is meant to be used when a Vertex reads Input directly from an external source
    For vertices which read data generated by another vertex - use the addEdge method. If a vertex needs to use data generated by another vertex in the DAG and also from an external source, a combination of this API and the DAG.addEdge API can be used.
    Note: If more than one RootInput exists on a vertex, which generates events which need to be routed, or generates information to set parallelism, a custom vertex manager should be setup to handle this. Not using a custom vertex manager for such a scenario will lead to a runtime failure.
    
    Parameters:
    inputName - the name of the input. This will be used when accessing the input in the LogicalIOProcessor
    dataSourceDescriptor - the @{link DataSourceDescriptor} for this input.
    
    Returns:
    this Vertex
  - addDataSink
```
public Vertex addDataSink(String outputName,
                 DataSinkDescriptor dataSinkDescriptor)
```
    Specifies an external data sink for a Vertex. This is meant to be used when a Vertex writes Output directly to an external destination.
    If an output of the vertex is meant to be consumed by another Vertex in the DAG - use the addEdge method. If a vertex needs generate data to an external source as well as for another Vertex in the DAG, a combination of this API and the DAG.addEdge API can be used.
    
    Parameters:
    outputName - the name of the output. This will be used when accessing the output in the LogicalIOProcessor
    dataSinkDescriptor - the DataSinkDescriptor for this output
    
    Returns:
    this Vertex
  - setVertexManagerPlugin
```
public Vertex setVertexManagerPlugin(VertexManagerPluginDescriptor vertexManagerPluginDescriptor)
```
    Specifies a VertexManagerPlugin for the vertex. This plugin can be used to modify the parallelism or reconfigure the vertex at runtime using user defined code embedded in the plugin
    
    Parameters:
    vertexManagerPluginDescriptor -
    
    Returns:
    this Vertex
  - getTaskLaunchCmdOpts
```
public String getTaskLaunchCmdOpts()
```
    Get the launch command opts for tasks in this vertex
    
    Returns:
    launch command opts
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getInputVertices
```
public List<Vertex> getInputVertices()
```
    Get the input vertices for this vertex
    
    Returns:
    List of input vertices
  - getOutputVertices
```
public List<Vertex> getOutputVertices()
```
    Get the output vertices for this vertex
    
    Returns:
    List of output vertices

Class Vertex

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

create

getName

getProcessorDescriptor

getParallelism

getTaskResource

setLocationHint

addTaskLocalFiles

getTaskLocalFiles

setTaskEnvironment

getTaskEnvironment

setTaskLaunchCmdOpts

addDataSource

addDataSink

setVertexManagerPlugin

getTaskLaunchCmdOpts

toString

getInputVertices

getOutputVertices