| Modifier and Type | Method and Description | 
|---|---|
| boolean | PlanEdit. addReservation(ReservationAllocation reservation,
              boolean isRecovering)Add a new  ReservationAllocationto the plan. | 
| boolean | InMemoryPlan. addReservation(ReservationAllocation reservation,
              boolean isRecovering) | 
| void | PlanEdit. archiveCompletedReservations(long tick)Method invoked to garbage collect old reservations. | 
| RLESparseResourceAllocation | SharingPolicy. availableResources(RLESparseResourceAllocation available,
                  Plan plan,
                  String user,
                  org.apache.hadoop.yarn.api.records.ReservationId oldId,
                  long start,
                  long end)This method provide a (partial) instantaneous validation by applying
 business rules (such as max number of parallel containers allowed for a
 user). | 
| RLESparseResourceAllocation | CapacityOverTimePolicy. availableResources(RLESparseResourceAllocation available,
                  Plan plan,
                  String user,
                  org.apache.hadoop.yarn.api.records.ReservationId oldId,
                  long start,
                  long end) | 
| RLESparseResourceAllocation | NoOverCommitPolicy. availableResources(RLESparseResourceAllocation available,
                  Plan plan,
                  String user,
                  org.apache.hadoop.yarn.api.records.ReservationId oldId,
                  long start,
                  long end) | 
| boolean | PlanEdit. deleteReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationID)Delete an existing  ReservationAllocationfrom the plan identified
 uniquely by itsReservationId. | 
| RLESparseResourceAllocation | InMemoryPlan. getAvailableResourceOverTime(String user,
                            org.apache.hadoop.yarn.api.records.ReservationId oldId,
                            long start,
                            long end,
                            long period) | 
| RLESparseResourceAllocation | InMemoryPlan. getCumulativeLoadOverTime(long start,
                         long end) | 
| static RLESparseResourceAllocation | RLESparseResourceAllocation. merge(org.apache.hadoop.yarn.util.resource.ResourceCalculator resCalc,
     org.apache.hadoop.yarn.api.records.Resource clusterResource,
     RLESparseResourceAllocation a,
     RLESparseResourceAllocation b,
     RLESparseResourceAllocation.RLEOperator operator,
     long start,
     long end)Merges the range start to end of two  RLESparseResourceAllocationusing a givenRLEOperator. | 
| boolean | PlanEdit. updateReservation(ReservationAllocation reservation)Updates an existing  ReservationAllocationin the plan. | 
| boolean | InMemoryPlan. updateReservation(ReservationAllocation reservation) | 
| void | SharingPolicy. validate(Plan plan,
        ReservationAllocation newAllocation)This method runs the policy validation logic, and return true/false on
 whether the  ReservationAllocationis acceptable according to this
 sharing policy. | 
| void | CapacityOverTimePolicy. validate(Plan plan,
        ReservationAllocation reservation)The validation algorithm walks over the RLE encoded allocation and
 checks that for all transition points (when the start or end of the
 checking window encounters a value in the RLE). | 
| void | NoOverCommitPolicy. validate(Plan plan,
        ReservationAllocation reservation) | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | ContractValidationExceptionThis exception is thrown if the request made is not syntactically valid. | 
| class  | PlanningQuotaExceptionThis exception is thrown if the user quota is exceed while accepting or
 updating a reservation. | 
| class  | ResourceOverCommitExceptionThis exception indicate that the reservation that has been attempted, would
 exceed the physical resources available in the  Planat the moment. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected boolean | PlanningAlgorithm. allocateUser(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
            String user,
            Plan plan,
            org.apache.hadoop.yarn.api.records.ReservationDefinition contract,
            ReservationAllocation oldReservation)Performs the actual allocation for a ReservationDefinition within a Plan. | 
| abstract RLESparseResourceAllocation | PlanningAlgorithm. computeJobAllocation(Plan plan,
                    org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                    org.apache.hadoop.yarn.api.records.ReservationDefinition reservation,
                    String user) | 
| RLESparseResourceAllocation | IterativePlanner. computeJobAllocation(Plan plan,
                    org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                    org.apache.hadoop.yarn.api.records.ReservationDefinition reservation,
                    String user) | 
| protected Map<ReservationInterval,org.apache.hadoop.yarn.api.records.Resource> | IterativePlanner. computeStageAllocation(Plan plan,
                      org.apache.hadoop.yarn.api.records.ReservationRequest rr,
                      long stageArrivalTime,
                      long stageDeadline,
                      long period,
                      String user,
                      org.apache.hadoop.yarn.api.records.ReservationId oldId) | 
| Map<ReservationInterval,org.apache.hadoop.yarn.api.records.Resource> | StageAllocator. computeStageAllocation(Plan plan,
                      RLESparseResourceAllocation planLoads,
                      RLESparseResourceAllocation planModifications,
                      org.apache.hadoop.yarn.api.records.ReservationRequest rr,
                      long stageArrival,
                      long stageDeadline,
                      long period,
                      String user,
                      org.apache.hadoop.yarn.api.records.ReservationId oldId)Computes the allocation of a stage inside a defined time interval. | 
| Map<ReservationInterval,org.apache.hadoop.yarn.api.records.Resource> | StageAllocatorGreedy. computeStageAllocation(Plan plan,
                      RLESparseResourceAllocation planLoads,
                      RLESparseResourceAllocation planModifications,
                      org.apache.hadoop.yarn.api.records.ReservationRequest rr,
                      long stageEarliestStart,
                      long stageDeadline,
                      long period,
                      String user,
                      org.apache.hadoop.yarn.api.records.ReservationId oldId) | 
| Map<ReservationInterval,org.apache.hadoop.yarn.api.records.Resource> | StageAllocatorLowCostAligned. computeStageAllocation(Plan plan,
                      RLESparseResourceAllocation planLoads,
                      RLESparseResourceAllocation planModifications,
                      org.apache.hadoop.yarn.api.records.ReservationRequest rr,
                      long stageArrival,
                      long stageDeadline,
                      long period,
                      String user,
                      org.apache.hadoop.yarn.api.records.ReservationId oldId) | 
| Map<ReservationInterval,org.apache.hadoop.yarn.api.records.Resource> | StageAllocatorGreedyRLE. computeStageAllocation(Plan plan,
                      RLESparseResourceAllocation planLoads,
                      RLESparseResourceAllocation planModifications,
                      org.apache.hadoop.yarn.api.records.ReservationRequest rr,
                      long stageEarliestStart,
                      long stageDeadline,
                      long period,
                      String user,
                      org.apache.hadoop.yarn.api.records.ReservationId oldId) | 
| boolean | AlignedPlannerWithGreedy. createReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan,
                 org.apache.hadoop.yarn.api.records.ReservationDefinition contract) | 
| boolean | ReservationAgent. createReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan,
                 org.apache.hadoop.yarn.api.records.ReservationDefinition contract)Create a reservation for the user that abides by the specified contract | 
| boolean | PlanningAlgorithm. createReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan,
                 org.apache.hadoop.yarn.api.records.ReservationDefinition contract) | 
| boolean | TryManyReservationAgents. createReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan,
                 org.apache.hadoop.yarn.api.records.ReservationDefinition contract) | 
| boolean | GreedyReservationAgent. createReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan,
                 org.apache.hadoop.yarn.api.records.ReservationDefinition contract) | 
| boolean | AlignedPlannerWithGreedy. deleteReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan) | 
| boolean | ReservationAgent. deleteReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan)Delete an user reservation | 
| boolean | PlanningAlgorithm. deleteReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan) | 
| boolean | TryManyReservationAgents. deleteReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan) | 
| boolean | GreedyReservationAgent. deleteReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan) | 
| protected static StageAllocatorLowCostAligned.DurationInterval | StageAllocatorLowCostAligned. getDurationInterval(long startTime,
                   long endTime,
                   RLESparseResourceAllocation planLoads,
                   RLESparseResourceAllocation planModifications,
                   org.apache.hadoop.yarn.api.records.Resource capacity,
                   RLESparseResourceAllocation netRLERes,
                   org.apache.hadoop.yarn.util.resource.ResourceCalculator resCalc,
                   long step,
                   org.apache.hadoop.yarn.api.records.Resource requestedResources) | 
| protected static int | StageAllocatorLowCostAligned. getDurationIntervalGangsCanFit(long startTime,
                              long endTime,
                              RLESparseResourceAllocation planModifications,
                              org.apache.hadoop.yarn.api.records.Resource capacity,
                              RLESparseResourceAllocation netRLERes,
                              org.apache.hadoop.yarn.util.resource.ResourceCalculator resCalc,
                              org.apache.hadoop.yarn.api.records.Resource requestedResources) | 
| protected static double | StageAllocatorLowCostAligned. getDurationIntervalTotalCost(long startTime,
                            long endTime,
                            RLESparseResourceAllocation planLoads,
                            RLESparseResourceAllocation planModifications,
                            org.apache.hadoop.yarn.api.records.Resource capacity,
                            org.apache.hadoop.yarn.util.resource.ResourceCalculator resCalc,
                            long step) | 
| protected void | IterativePlanner. initialize(Plan plan,
          org.apache.hadoop.yarn.api.records.ReservationId reservationId,
          org.apache.hadoop.yarn.api.records.ReservationDefinition reservation) | 
| void | SimpleCapacityReplanner. plan(Plan plan,
    List<org.apache.hadoop.yarn.api.records.ReservationDefinition> contracts) | 
| void | Planner. plan(Plan plan,
    List<org.apache.hadoop.yarn.api.records.ReservationDefinition> contracts)Update the existing  Plan, by adding/removing/updating existing
 reservations, and adding a subset of the reservation requests in the
 contracts parameter. | 
| boolean | AlignedPlannerWithGreedy. updateReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan,
                 org.apache.hadoop.yarn.api.records.ReservationDefinition contract) | 
| boolean | ReservationAgent. updateReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan,
                 org.apache.hadoop.yarn.api.records.ReservationDefinition contract)Update a reservation for the user that abides by the specified contract | 
| boolean | PlanningAlgorithm. updateReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan,
                 org.apache.hadoop.yarn.api.records.ReservationDefinition contract) | 
| boolean | TryManyReservationAgents. updateReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan,
                 org.apache.hadoop.yarn.api.records.ReservationDefinition contract) | 
| boolean | GreedyReservationAgent. updateReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId,
                 String user,
                 Plan plan,
                 org.apache.hadoop.yarn.api.records.ReservationDefinition contract) | 
Copyright © 2008–2023 Apache Software Foundation. All rights reserved.