org.apache.tez.runtime.api

Interface InputContext

All Superinterfaces:

TaskContext

@InterfaceAudience.Public
public interface InputContext
extends TaskContext

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

Method Summary

Modifier and Type	Method and Description
int	getInputIndex() Get the index of the input in the set of all inputs for the task.
String	getInputOutputVertexNames() Returns a convenient, human-readable string describing the input and output vertices.
String	getSourceVertexName() Get the Vertex Name of the Source that generated data for this Input
InputStatisticsReporter	getStatisticsReporter() Get an InputStatisticsReporter for this Input that can be used to report statistics like data size
void	inputIsReady() Inform the framework that the specific Input is ready for consumption.

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

getSourceVertexName

String getSourceVertexName()

Get the Vertex Name of the Source that generated data for this Input

Returns:

Name of the Source Vertex

getInputOutputVertexNames

String getInputOutputVertexNames()

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

Returns:

the convenient string

getInputIndex

int getInputIndex()

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

Returns:

index

inputIsReady

void inputIsReady()

Inform the framework that the specific Input is ready for consumption. This method can be invoked multiple times.

getStatisticsReporter

InputStatisticsReporter getStatisticsReporter()

Get an InputStatisticsReporter for this Input that can be used to report statistics like data size

Returns:

InputStatisticsReporter