org.apache.tez.dag.api

Class EntityDescriptor<T extends EntityDescriptor<T>>

java.lang.Object

org.apache.tez.dag.api.EntityDescriptor<T>

All Implemented Interfaces:

org.apache.hadoop.io.Writable

Direct Known Subclasses:

EdgeManagerPluginDescriptor, InputDescriptor, InputInitializerDescriptor, org.apache.tez.dag.api.NamedEntityDescriptor, OutputCommitterDescriptor, OutputDescriptor, ProcessorDescriptor, VertexManagerPluginDescriptor

@InterfaceAudience.Public
public abstract class EntityDescriptor<T extends EntityDescriptor<T>>
extends Object
implements org.apache.hadoop.io.Writable

Describes a given user code entity. Consists of the name of the class implementing the user logic and a payload that can be used to configure an object instance of that class. In addition some history information can be set for logging/debugging.
This is not supposed to be extended by users. Users are expected to use the derived classes for specific entities

Field Summary

Fields

Modifier and Type	Field and Description
protected String	historyText

Constructor Summary

Constructors

Constructor and Description
EntityDescriptor()
EntityDescriptor(String className)

Method Summary

Modifier and Type	Method and Description
String	getClassName()
UserPayload	getUserPayload()
void	readFields(DataInput in)
T	setHistoryText(String historyText) Provide a human-readable version of the user payload that can be used in the TEZ UI
T	setUserPayload(UserPayload userPayload) Set user payload for this entity descriptor
String	toString()
void	write(DataOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

historyText

protected String historyText

Constructor Detail

EntityDescriptor

@InterfaceAudience.Private
public EntityDescriptor()

EntityDescriptor

public EntityDescriptor(String className)

Method Detail

getUserPayload

public UserPayload getUserPayload()

setUserPayload

public T setUserPayload(UserPayload userPayload)

Set user payload for this entity descriptor

Parameters:

userPayload - User Payload

Returns:

this object for further chained method calls

setHistoryText

public T setHistoryText(String historyText)

Provide a human-readable version of the user payload that can be used in the TEZ UI

Parameters:

historyText - History text For better support in the UI, the history text should be a json-encoded string. The following keys in the json object will be recognized: "desc" : A string-value describing the entity "config" : A key-value map to represent configuration

Returns:

this object for further chained method calls

getClassName

public String getClassName()

write

public void write(DataOutput out)
           throws IOException

Specified by:

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

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

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

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object