org.apache.tez.runtime.api.events

Class DataMovementEvent

java.lang.Object

org.apache.tez.runtime.api.Event

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

@InterfaceAudience.Public
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.

Method Summary

Methods

Modifier and Type	Method and Description
static DataMovementEvent	create(ByteBuffer userPayload)
static DataMovementEvent	create(int sourceIndex, ByteBuffer userPayload) User Event constructor for Outputs
static DataMovementEvent	create(int sourceIndex, int targetIndex, int version, ByteBuffer userPayload)
int	getSourceIndex()
int	getTargetIndex()
ByteBuffer	getUserPayload()
int	getVersion()
DataMovementEvent	makeCopy(int targetIndex) Make a routable copy of the DataMovementEvent by adding a target input index
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

Method Detail

create

public static DataMovementEvent create(int sourceIndex,
                       ByteBuffer userPayload)

User Event constructor for Outputs

Parameters:

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

userPayload - User Payload of the User Event

create

@InterfaceAudience.Private
public static DataMovementEvent create(ByteBuffer userPayload)

create

@InterfaceAudience.Private
public static DataMovementEvent create(int sourceIndex,
                                                 int targetIndex,
                                                 int version,
                                                 ByteBuffer userPayload)

makeCopy

@InterfaceAudience.Private
public DataMovementEvent makeCopy(int targetIndex)

Make a routable copy of the DataMovementEvent by adding a target input index

Parameters:

targetIndex - The index of the physical input to which this DataMovementEvent should be routed

Returns:

Copy of this DataMovementEvent with the target input index added to it

getUserPayload

public ByteBuffer 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