org.apache.tez.runtime.api.events

Class InputInitializerEvent

java.lang.Object

org.apache.tez.runtime.api.Event

org.apache.tez.runtime.api.events.InputInitializerEvent

@InterfaceStability.Unstable
 @InterfaceAudience.Public
public class InputInitializerEvent
extends Event

An event that is routed to the specified InputInitializer. This can be used to send information/metadata to the InputInitializer

These events are routed to the InputInitializer, only after the task which generated the event succeeds. Also, the events will only be sent once per task - irrespective of how many attempts were run, or succeeded. An example of this is when a task is retried because the node on which it was running failed. If the Task had succeeded once, the event would already have been sent - and will not be resent when the task reruns and succeeds.

Method Summary

Modifier and Type	Method and Description
static InputInitializerEvent	create(String targetVertexName, String targetInputName, ByteBuffer eventPayload)
String	getSourceVertexName() Returns the name of the vertex which generated the event.
String	getTargetInputName() Get the input name to which this event is targeted
String	getTargetVertexName() Get the vertex name on which the targeted Input exists
ByteBuffer	getUserPayload() Get the actual user payload
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static InputInitializerEvent create(String targetVertexName,
                                           String targetInputName,
                                           ByteBuffer eventPayload)

Parameters:

targetVertexName - the vertex on which the targeted Input exists

targetInputName - the name of the input

eventPayload - the payload for the event. It is advisable to limit the size of the payload to a few KB at max

getTargetVertexName

public String getTargetVertexName()

Get the vertex name on which the targeted Input exists

Returns:

the vertex name

getTargetInputName

public String getTargetInputName()

Get the input name to which this event is targeted

Returns:

the input name

getUserPayload

public ByteBuffer getUserPayload()

Get the actual user payload

Returns:

a byte representation of the payload

getSourceVertexName

public String getSourceVertexName()

Returns the name of the vertex which generated the event. This will only be populated after the event has been routed by the AM.

Returns:

the name of the source vertex

toString

public String toString()

Overrides:

toString in class Object