org.apache.tez.runtime.api.events

Class VertexManagerEvent

java.lang.Object

org.apache.tez.runtime.api.Event

org.apache.tez.runtime.api.events.VertexManagerEvent

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

Event used to send information from a Task to the VertexManager for a vertex. This may be used to send statistics like samples etc to the VertexManager for automatic plan reconfigurations based on observed statistics

Method Summary

Modifier and Type	Method and Description
static VertexManagerEvent	create(String vertexName, ByteBuffer userPayload) Create a new VertexManagerEvent
org.apache.tez.runtime.api.TaskAttemptIdentifier	getProducerAttemptIdentifier() Get metadata about the task attempt that produced the event.
String	getTargetVertexName()
ByteBuffer	getUserPayload()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static VertexManagerEvent create(String vertexName,
                                        ByteBuffer userPayload)

Create a new VertexManagerEvent

Parameters:

vertexName -

userPayload - This should not be modified since a reference is kept

getTargetVertexName

public String getTargetVertexName()

getUserPayload

public ByteBuffer getUserPayload()

getProducerAttemptIdentifier

public org.apache.tez.runtime.api.TaskAttemptIdentifier getProducerAttemptIdentifier()

Get metadata about the task attempt that produced the event. This method will provide a valid return value only when invoked in the VertexManagerPlugin

Returns:

attempt metadata