org.apache.tez.dag.records

Class TezVertexID

java.lang.Object

org.apache.tez.dag.records.TezID

org.apache.tez.dag.records.TezVertexID

All Implemented Interfaces:

Comparable<TezID>, org.apache.hadoop.io.Writable, org.apache.hadoop.io.WritableComparable<TezID>, DAGIDAware

@InterfaceAudience.Public
 @InterfaceStability.Stable
public class TezVertexID
extends TezID
implements DAGIDAware

TezVertexID represents the immutable and unique identifier for a Vertex in a Tez DAG. Each TezVertexID encompasses multiple Tez Tasks. TezVertezID consists of 2 parts. The first part is the TezDAGID, that is the Tez DAG that this vertex belongs to. The second part is the vertex number.

See Also:

TezDAGID, TezTaskID

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERTEX

Fields inherited from class org.apache.tez.dag.records.TezID

id, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
TezVertexID()

Method Summary

Modifier and Type	Method and Description
protected StringBuilder	appendTo(StringBuilder builder) Add the unique string to the given builder.
int	compareTo(TezID o) Compare TaskInProgressIds by first jobIds, then by tip numbers and type.
boolean	equals(Object o)
static TezVertexID	fromString(String vertexIdStr)
TezDAGID	getDAGID() Returns the TezDAGID object that this tip belongs to
static TezVertexID	getInstance(TezDAGID dagId, int id) Constructs a TezVertexID object from given TezDAGID.
int	hashCode()
void	readFields(DataInput in)
static TezVertexID	readTezVertexID(DataInput in)
String	toString()
void	write(DataOutput out)

Methods inherited from class org.apache.tez.dag.records.TezID

getId, readID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tez.dag.records.DAGIDAware

getApplicationId

Field Detail

VERTEX

public static final String VERTEX

See Also:

Constant Field Values

Constructor Detail

TezVertexID

public TezVertexID()

Method Detail

getInstance

public static TezVertexID getInstance(TezDAGID dagId,
                                      int id)

Constructs a TezVertexID object from given TezDAGID.

Parameters:

dagId - TezDAGID object for this TezVertexID

id - the tip number

Throws:

NullPointerException - if dagId is null

getDAGID

public TezDAGID getDAGID()

Returns the TezDAGID object that this tip belongs to

Specified by:

getDAGID in interface DAGIDAware

equals

public boolean equals(Object o)

Overrides:

equals in class TezID

compareTo

public int compareTo(TezID o)

Compare TaskInProgressIds by first jobIds, then by tip numbers and type.

Specified by:

compareTo in interface Comparable<TezID>

Overrides:

compareTo in class TezID

toString

public String toString()

Overrides:

toString in class TezID

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Overrides:

readFields in class TezID

Throws:

IOException

readTezVertexID

public static TezVertexID readTezVertexID(DataInput in)
                                   throws IOException

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Overrides:

write in class TezID

Throws:

IOException

appendTo

protected StringBuilder appendTo(StringBuilder builder)

Add the unique string to the given builder.

Parameters:

builder - the builder to append to

Returns:

the builder that was passed in

hashCode

public int hashCode()

Overrides:

hashCode in class TezID

fromString

public static TezVertexID fromString(String vertexIdStr)