org.apache.tez.runtime.api

Interface InputInitializerContext

@InterfaceStability.Unstable
 @InterfaceAudience.Public
public interface InputInitializerContext

A context that provides information to the InputInitializer

Method Summary

Modifier and Type	Method and Description
void	addCounters(TezCounters tezCounters) Add custom counters
org.apache.hadoop.yarn.api.records.ApplicationId	getApplicationId() Get the YARN application id given to the Tez Application Master
int	getDAGAttemptNumber()
String	getDAGName() Get the name of the DAG
String	getInputName() Get the name of the input
UserPayload	getInputUserPayload() Get the user payload for the input
int	getNumClusterNodes() Get the number of nodes in the cluster
int	getNumTasks() Get the number of tasks in this vertex.
org.apache.hadoop.yarn.api.records.Resource	getTotalAvailableResource() Get the total resource allocated to this vertex.
UserPayload	getUserPayload() Get the user payload for the initializer
org.apache.hadoop.conf.Configuration	getVertexConfiguration() Get vertex configuration
int	getVertexId() Get the vertex id as integer that belongs to this input.
int	getVertexNumTasks(String vertexName) Get the number of tasks in the given vertex
org.apache.hadoop.yarn.api.records.Resource	getVertexTaskResource() Get the resource allocated to a task of this vertex
void	registerForVertexStateUpdates(String vertexName, Set<VertexState> stateSet) Register to get notifications on updates to the specified vertex.

Method Detail

getApplicationId

org.apache.hadoop.yarn.api.records.ApplicationId getApplicationId()

Get the YARN application id given to the Tez Application Master

Returns:

Application id

getDAGName

String getDAGName()

Get the name of the DAG

Returns:

DAG name

getVertexConfiguration

org.apache.hadoop.conf.Configuration getVertexConfiguration()

Get vertex configuration

Returns:

Vertex configuration

getInputName

String getInputName()

Get the name of the input

Returns:

Input name

getInputUserPayload

UserPayload getInputUserPayload()

Get the user payload for the input

Returns:

User payload

getUserPayload

UserPayload getUserPayload()

Get the user payload for the initializer

Returns:

User payload

getNumTasks

int getNumTasks()

Get the number of tasks in this vertex. Maybe -1 if the vertex has not been initialized with a pre-determined number of tasks.

Returns:

number of tasks

getVertexTaskResource

org.apache.hadoop.yarn.api.records.Resource getVertexTaskResource()

Get the resource allocated to a task of this vertex

Returns:

Resource

getVertexId

int getVertexId()

Get the vertex id as integer that belongs to this input.

getTotalAvailableResource

org.apache.hadoop.yarn.api.records.Resource getTotalAvailableResource()

Get the total resource allocated to this vertex. If the DAG is running in a busy cluster then it may have no resources available dedicated to it. The DAG may divide its resources among member vertices.

Returns:

Resource

getNumClusterNodes

int getNumClusterNodes()

Get the number of nodes in the cluster

Returns:

Number of nodes

getDAGAttemptNumber

int getDAGAttemptNumber()

Returns:

DAG Attempt number

getVertexNumTasks

int getVertexNumTasks(String vertexName)

Get the number of tasks in the given vertex

Parameters:

vertexName -

Returns:

Total number of tasks in this vertex

registerForVertexStateUpdates

void registerForVertexStateUpdates(String vertexName,
                                   @Nullable
                                   Set<VertexState> stateSet)

Register to get notifications on updates to the specified vertex. Notifications will be sent via InputInitializer.onVertexStateUpdated(org.apache.tez.dag.api.event.VertexStateUpdate)

This method can only be invoked once. Duplicate invocations will result in an error.

Parameters:

vertexName - the vertex name for which notifications are required.

stateSet - the set of states for which notifications are required. null implies all

addCounters

void addCounters(TezCounters tezCounters)

Add custom counters

Parameters:

tezCounters - counters to add