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

Interface AutoCreatedQueueManagementPolicy

All Known Implementing Classes:
GuaranteedOrZeroCapacityOverTimePolicy
public interface AutoCreatedQueueManagementPolicy

  • Method Details

    • init

      void init(AbstractParentQueue parentQueue) throws IOException
      Initialize policy.
      Parameters:
      parentQueue - parent queue
      Throws:
      IOException - an I/O exception has occurred.

    • reinitialize

      void reinitialize(AbstractParentQueue parentQueue) throws IOException
      Reinitialize policy state ( if required ).
      Parameters:
      parentQueue - parent queue
      Throws:
      IOException - an I/O exception has occurred.

    • getInitialLeafQueueConfiguration

      AutoCreatedLeafQueueConfig getInitialLeafQueueConfiguration(AbstractAutoCreatedLeafQueue leafQueue) throws SchedulerDynamicEditException
      Get initial template for the specified leaf queue.
      Parameters:
      leafQueue - the leaf queue
      Returns:
      initial leaf queue template configurations and capacities for auto created queue
      Throws:
      SchedulerDynamicEditException - when get initialLeafQueue Configuration fails.

    • computeQueueManagementChanges

      List<QueueManagementChange> computeQueueManagementChanges() throws SchedulerDynamicEditException
      Compute/Adjust child queue capacities for auto created leaf queues This computes queue entitlements but does not update LeafQueueState or queue capacities. Scheduler calls commitQueueManagemetChanges after validation after applying queue changes and commits to LeafQueueState are done in commitQueueManagementChanges.
      Returns:
      returns a list of suggested QueueEntitlementChange(s) which may or may not be enforced by the scheduler
      Throws:
      SchedulerDynamicEditException - when compute QueueManagementChanges fails.

    • commitQueueManagementChanges

      void commitQueueManagementChanges(List<QueueManagementChange> queueManagementChanges) throws SchedulerDynamicEditException
      Commit/Update state for the specified queue management changes.
      Parameters:
      queueManagementChanges - QueueManagementChange List.
      Throws:
      SchedulerDynamicEditException - when commit QueueManagementChanges fails.