org.apache.hadoop.yarn.server.resourcemanager.reservation
Interface PlanContext

All Known Subinterfaces:

Plan, PlanEdit, PlanView

public interface PlanContext

This interface provides read-only access to configuration-type parameter for a plan.

Method Summary

org.apache.hadoop.yarn.api.records.Resource	getMaximumAllocation() Returns the single largest Resource allocation that can be reserved in this plan
org.apache.hadoop.yarn.api.records.Resource	getMinimumAllocation() Returns the single smallest Resource allocation that can be reserved in this plan
boolean	getMoveOnExpiry() Instructs the PlanFollower on what to do for applications which are still running when the reservation is expiring (move-to-default vs kill)
QueueMetrics	getQueueMetrics() Return the QueueMetrics for the queue in the ResourceScheduler corresponding to this plan
String	getQueueName() Return the name of the queue in the ResourceScheduler corresponding to this plan
Planner	getReplanner() Return an instance of a Planner, which will be invoked in response to unexpected reduction in the resources of this plan
ReservationAgent	getReservationAgent() Return the ReservationAgent configured for this plan that is responsible for optimally placing various reservation requests
org.apache.hadoop.yarn.util.resource.ResourceCalculator	getResourceCalculator() Returns the system ResourceCalculator
SharingPolicy	getSharingPolicy() Return the configured SharingPolicy that governs the sharing of the resources of the plan between its various users
long	getStep() Returns the configured "step" or granularity of time of the plan in millis.

Method Detail

getStep

long getStep()

Returns the configured "step" or granularity of time of the plan in millis.

Returns:

plan step in millis

getReservationAgent

ReservationAgent getReservationAgent()

Return the ReservationAgent configured for this plan that is responsible for optimally placing various reservation requests

Returns:

the ReservationAgent configured for this plan

getReplanner

Planner getReplanner()

Return an instance of a Planner, which will be invoked in response to unexpected reduction in the resources of this plan

Returns:

an instance of a Planner, which will be invoked in response to unexpected reduction in the resources of this plan

getSharingPolicy

SharingPolicy getSharingPolicy()

Return the configured SharingPolicy that governs the sharing of the resources of the plan between its various users

Returns:

the configured SharingPolicy that governs the sharing of the resources of the plan between its various users

getResourceCalculator

org.apache.hadoop.yarn.util.resource.ResourceCalculator getResourceCalculator()

Returns the system ResourceCalculator

Returns:

the system ResourceCalculator

getMinimumAllocation

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

Returns the single smallest Resource allocation that can be reserved in this plan

Returns:

the single smallest Resource allocation that can be reserved in this plan

getMaximumAllocation

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

Returns the single largest Resource allocation that can be reserved in this plan

Returns:

the single largest Resource allocation that can be reserved in this plan

getQueueName

String getQueueName()

Return the name of the queue in the ResourceScheduler corresponding to this plan

Returns:

the name of the queue in the ResourceScheduler corresponding to this plan

getQueueMetrics

QueueMetrics getQueueMetrics()

Return the QueueMetrics for the queue in the ResourceScheduler corresponding to this plan

Returns:

the QueueMetrics for the queue in the ResourceScheduler corresponding to this plan

getMoveOnExpiry

boolean getMoveOnExpiry()

Instructs the PlanFollower on what to do for applications which are still running when the reservation is expiring (move-to-default vs kill)

Returns:

true if remaining applications have to be killed, false if they have to migrated