Package org.apache.hadoop.yarn.server.resourcemanager.reservation

Interface PlanContext

All Known Subinterfaces:
Plan, PlanEdit, org.apache.hadoop.yarn.server.resourcemanager.reservation.PlanView
All Known Implementing Classes:
InMemoryPlan
public interface PlanContext
This interface provides read-only access to configuration-type parameter for a plan.

  • Method Details

    • 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

    • getMaximumPeriodicity

      long getMaximumPeriodicity()
      Returns the maximum periodicity allowed in a recurrence expression for reservations of a particular plan. This value must be divisible by the recurrence expression of a newly submitted reservation. Otherwise, the reservation submission will fail.
      Returns:
      the maximum periodicity allowed in a recurrence expression for reservations of a particular 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