Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy

Interface SchedulableEntity

All Known Implementing Classes:

FiCaSchedulerApp, FifoAppAttempt, FSAppAttempt, SchedulerApplicationAttempt

public interface SchedulableEntity

A SchedulableEntity is a process to be scheduled. for example, an application / application attempt

Method Summary

Modifier and Type	Method	Description
int	compareInputOrderTo(SchedulableEntity other)	Compare the passed SchedulableEntity to this one for input order.
java.lang.String	getId()	Id - each entity must have a unique id.
java.lang.String	getPartition()	Get partition corresponding to this entity.
org.apache.hadoop.yarn.api.records.Priority	getPriority()	Get the priority of the application.
ResourceUsage	getSchedulingResourceUsage()	View of Resources wanted and consumed by the entity.
long	getStartTime()	Start time of the job.
boolean	isRecovering()	Whether application was running before RM restart.

Method Detail

getId

java.lang.String getId()

Id - each entity must have a unique id.

Returns:

id.

compareInputOrderTo

int compareInputOrderTo(SchedulableEntity other)

Compare the passed SchedulableEntity to this one for input order. Input order is implementation defined and should reflect the correct ordering for first-in first-out processing.

Parameters:

other - SchedulableEntity.

Returns:

correct ordering.

getSchedulingResourceUsage

ResourceUsage getSchedulingResourceUsage()

View of Resources wanted and consumed by the entity.

Returns:

ResourceUsage.

getPriority

org.apache.hadoop.yarn.api.records.Priority getPriority()

Get the priority of the application.

Returns:

priority of the application.

isRecovering

boolean isRecovering()

Whether application was running before RM restart.

Returns:

true, application was running before RM restart; otherwise false.

getPartition

java.lang.String getPartition()

Get partition corresponding to this entity.

Returns:

partition node label.

getStartTime

long getStartTime()

Start time of the job.

Returns:

start time