org.apache.tez.runtime.api.events
Class DataMovementEvent

java.lang.Object
  org.apache.tez.runtime.api.Event
      org.apache.tez.runtime.api.events.DataMovementEvent

public final class DataMovementEvent
extends Event

Event used by user code to send information between tasks. An output can generate an Event of this type to sending information regarding output data ( such as URI for file-based output data, port info in case of streaming-based data transfers ) to the Input on the destination vertex.

Constructor Summary

DataMovementEvent(byte[] userPayload)
Constructor for Processor-generated User Events

DataMovementEvent(int sourceIndex, byte[] userPayload)
User Event constructor

DataMovementEvent(int sourceIndex, int targetIndex, int version, byte[] userPayload)

Method Summary

int	getSourceIndex()
int	getTargetIndex()
byte[]	getUserPayload()
int	getVersion()
void	setTargetIndex(int targetIndex)
void	setVersion(int version)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataMovementEvent

public DataMovementEvent(int sourceIndex,
                         byte[] userPayload)

User Event constructor

Parameters:

sourceIndex - Index to identify the physical edge of the input/output that generated the event

userPayload - User Payload of the User Event

DataMovementEvent

@InterfaceAudience.Private
public DataMovementEvent(int sourceIndex,
                                                   int targetIndex,
                                                   int version,
                                                   byte[] userPayload)

DataMovementEvent

public DataMovementEvent(byte[] userPayload)

Constructor for Processor-generated User Events

Parameters:

userPayload -

Method Detail

getUserPayload

public byte[] getUserPayload()

getSourceIndex

public int getSourceIndex()

getTargetIndex

public int getTargetIndex()

setTargetIndex

@InterfaceAudience.Private
public void setTargetIndex(int targetIndex)

getVersion

public int getVersion()

setVersion

@InterfaceAudience.Private
public void setVersion(int version)

toString

public String toString()

Overrides:

toString in class Object