org.apache.tez.serviceplugins.api

Interface TaskSchedulerContext

All Superinterfaces:

org.apache.tez.serviceplugins.api.ServicePluginContextBase

@InterfaceAudience.Public
@InterfaceStability.Unstable
public interface TaskSchedulerContext
extends org.apache.tez.serviceplugins.api.ServicePluginContextBase

Context for a TaskScheduler

This provides methods for a scheduler to interact with the Tez framework.

Calls into this should be outside of locks, which may also be obtained by methods in the scheduler which implement the TaskScheduler interface

Method Summary

Methods

Modifier and Type	Method and Description
void	appShutdownRequested() Inform the framework that an app shutdown is required.
void	containerBeingReleased(org.apache.hadoop.yarn.api.records.ContainerId containerId) Indicates to the framework that a container is being released.
void	containerCompleted(Object taskLastAllocated, org.apache.hadoop.yarn.api.records.ContainerStatus containerStatus) Indicate to the framework that a container has completed.
org.apache.tez.serviceplugins.api.TaskSchedulerContext.AMState	getAMState() Get the state of the AppMaster
int	getAppClientPort() Get the port on which the DAG client is listening
String	getAppHostName() Get the hostname on which the app is running
org.apache.hadoop.yarn.api.records.ApplicationAttemptId	getApplicationAttemptId() Get the application attempt id for the running application.
String	getAppTrackingUrl() Get the tracking URL for the application.
ContainerSignatureMatcher	getContainerSignatureMatcher() Get an instance of ContainerSignatureMatcher which can be used to check whether the specifications of a container match what is required by a task.
long	getCustomClusterIdentifier() A custom cluster identifier allocated to schedulers to generate an AppId, if not making use of YARN
org.apache.tez.serviceplugins.api.TaskSchedulerContext.AppFinalStatus	getFinalAppStatus() Get the final status for the application, which could be provided to the coordinator of the source.
float	getProgress() Request the framework for progress of the running DAG.
boolean	isSession() Check whether the AM is running in session mode.
void	nodesUpdated(List<org.apache.hadoop.yarn.api.records.NodeReport> updatedNodes) Provide an update to the framework about the status of nodes available to this report
void	preemptContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId) Inform the framework that the scheduler has determined that a previously allocated container needs to be preempted
void	setApplicationRegistrationData(org.apache.hadoop.yarn.api.records.Resource maxContainerCapability, Map<org.apache.hadoop.yarn.api.records.ApplicationAccessType,String> appAcls, ByteBuffer clientAMSecretKey) Provide an update to the framework about specific information about the source managed by this scheduler.
void	taskAllocated(Object task, Object appCookie, org.apache.hadoop.yarn.api.records.Container container) Indicate to the framework that a container is being assigned to a task.

Methods inherited from interface org.apache.tez.serviceplugins.api.ServicePluginContextBase

getCurrentDagInfo, getInitialUserPayload, reportError

Method Detail

taskAllocated

void taskAllocated(Object task,
                 Object appCookie,
                 org.apache.hadoop.yarn.api.records.Container container)

Indicate to the framework that a container is being assigned to a task.

Parameters:

task - the task for which a container is being assigned. This should be the same instance that was provided when requesting for an allocation

appCookie - the cookie which was provided while requesting allocation for this task

container - the actual container assigned to the task

containerCompleted

void containerCompleted(Object taskLastAllocated,
                      org.apache.hadoop.yarn.api.records.ContainerStatus containerStatus)

Indicate to the framework that a container has completed. This is typically used by sources which have a means to indicate a container failure to the scheduler (typically centrally managed schedulers - YARN)

Parameters:

taskLastAllocated - the task that was allocated to this container, if any. This is the same instance that was passed in while requesting an allocation

containerStatus - the status with which the container ended

containerBeingReleased

void containerBeingReleased(org.apache.hadoop.yarn.api.records.ContainerId containerId)

Indicates to the framework that a container is being released.

Parameters:

containerId - the id of the container being released

nodesUpdated

void nodesUpdated(List<org.apache.hadoop.yarn.api.records.NodeReport> updatedNodes)

Provide an update to the framework about the status of nodes available to this report

Parameters:

updatedNodes - a list of updated node reports

appShutdownRequested

void appShutdownRequested()

Inform the framework that an app shutdown is required. This should typically not be used, other than by the YARN scheduler.

setApplicationRegistrationData

void setApplicationRegistrationData(org.apache.hadoop.yarn.api.records.Resource maxContainerCapability,
                                  Map<org.apache.hadoop.yarn.api.records.ApplicationAccessType,String> appAcls,
                                  ByteBuffer clientAMSecretKey)

Provide an update to the framework about specific information about the source managed by this scheduler.

Parameters:

maxContainerCapability - the total resource capability of the source

appAcls - ACLs for the source

clientAMSecretKey - a secret key provided by the source

preemptContainer

void preemptContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId)

Inform the framework that the scheduler has determined that a previously allocated container needs to be preempted

Parameters:

containerId - the containerId to be preempted

getFinalAppStatus

org.apache.tez.serviceplugins.api.TaskSchedulerContext.AppFinalStatus getFinalAppStatus()

Get the final status for the application, which could be provided to the coordinator of the source. Primarily relevant to YARN

Returns:

the final Application status

getAppTrackingUrl

String getAppTrackingUrl()

Get the tracking URL for the application. Primarily relevant to YARN

Returns:

the trackingUrl for the app

getProgress

float getProgress()

Request the framework for progress of the running DAG. This value must be between 0 and 1

Returns:

progress

getCustomClusterIdentifier

long getCustomClusterIdentifier()

A custom cluster identifier allocated to schedulers to generate an AppId, if not making use of YARN

Returns:

the custom cluster identifier

getContainerSignatureMatcher

ContainerSignatureMatcher getContainerSignatureMatcher()

Get an instance of ContainerSignatureMatcher which can be used to check whether the specifications of a container match what is required by a task.

Returns:

an instance of ContainerSignatureMatcher

getApplicationAttemptId

org.apache.hadoop.yarn.api.records.ApplicationAttemptId getApplicationAttemptId()

Get the application attempt id for the running application. Relevant when running under YARN

Returns:

the applicationAttemptId for the running app

getAppHostName

String getAppHostName()

Get the hostname on which the app is running

Returns:

the hostname

getAppClientPort

int getAppClientPort()

Get the port on which the DAG client is listening

Returns:

the client port

isSession

boolean isSession()

Check whether the AM is running in session mode.

Returns:

true if session mode, false otherwise

getAMState

org.apache.tez.serviceplugins.api.TaskSchedulerContext.AMState getAMState()

Get the state of the AppMaster

Returns:

the app master state