org.apache.tez.runtime.api

Interface OutputContext

All Superinterfaces:

TaskContext

@InterfaceAudience.Public
public interface OutputContext
extends TaskContext

Context handle for the Output to initialize itself. This interface is not supposed to be implemented by users

Method Summary

Modifier and Type	Method and Description
String	getDestinationVertexName() Get the Vertex Name of the Destination that is the recipient of this Output's data
String	getInputOutputVertexNames() Returns a convenient, human-readable string describing the input and output vertices.
int	getOutputIndex() Get the index of the output in the set of all outputs for the task.
OutputStatisticsReporter	getStatisticsReporter() Get an OutputStatisticsReporter for this Output that can be used to report statistics like data size
void	trapEvents(org.apache.hadoop.yarn.event.EventHandler eventHandler) Notify the context that at this point no more events should be sent.

Methods inherited from interface org.apache.tez.runtime.api.TaskContext

fatalError, getApplicationId, getContainerConfiguration, getCounters, getDAGAttemptNumber, getDagIdentifier, getDAGName, getExecutionContext, getObjectRegistry, getServiceConsumerMetaData, getServiceProviderMetaData, getTaskAttemptNumber, getTaskIndex, getTaskVertexIndex, getTaskVertexName, getTotalMemoryAvailableToTask, getUniqueIdentifier, getUserPayload, getVertexParallelism, getWorkDirs, notifyProgress, reportFailure, requestInitialMemory, sendEvents

Method Detail

getDestinationVertexName

String getDestinationVertexName()

Get the Vertex Name of the Destination that is the recipient of this Output's data

Returns:

Name of the Destination Vertex

getInputOutputVertexNames

String getInputOutputVertexNames()

Returns a convenient, human-readable string describing the input and output vertices.

Returns:

the convenient string

getOutputIndex

int getOutputIndex()

Get the index of the output in the set of all outputs for the task. The index will be consistent and valid only among the tasks of this vertex.

Returns:

index

getStatisticsReporter

OutputStatisticsReporter getStatisticsReporter()

Get an OutputStatisticsReporter for this Output that can be used to report statistics like data size

Returns:

OutputStatisticsReporter

trapEvents

void trapEvents(org.apache.hadoop.yarn.event.EventHandler eventHandler)

Notify the context that at this point no more events should be sent. This is used as a safety measure to prevent events being sent after close or in cleanup. After this is called events being queued to be sent to the AM will instead be passed to the event handler.

Parameters:

eventHandler - should handle the events after the call.