Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720

Interface InstructionQueue

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
InstructionsQueue
@Generated("mdsal-binding-generator") public interface InstructionQueue extends org.opendaylight.yangtools.yang.binding.DataObject
The bare minimum run-time information which should be exposed by an implementation of the instruction scheduler defined in this model

This class represents the following YANG schema fragment defined in module programming 

 grouping instruction-queue {
   leaf instruction-queue-id {
     type string;
   }
   list instruction {
     config false;
     leaf id {
       type instruction-id;
     }
     key id;
     leaf status {
       type instruction-status;
     }
     leaf deadline {
       type nanotime;
     }
   }
 }

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      Class<? extends InstructionQueue> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

    • getInstructionQueueId

      String getInstructionQueueId()
      Return instructionQueueId, or null if it is not present.
      Returns:
      String instructionQueueId, or null if it is not present.

    • requireInstructionQueueId

      default @NonNull String requireInstructionQueueId()
      Return instructionQueueId, guaranteed to be non-null.
      Returns:
      String instructionQueueId, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if instructionQueueId is not present

    • getInstruction

      @Nullable Map<InstructionKey,Instruction> getInstruction()
      Return instruction, or null if it is not present. 
           
         List of all instructions known to the scheduler.
      Returns:
      Map<InstructionKey, Instruction> instruction, or null if it is not present.

    • nonnullInstruction

      default @NonNull Map<InstructionKey,Instruction> nonnullInstruction()
      Return instruction, or an empty list if it is not present.
      Returns:
      Map<InstructionKey, Instruction> instruction, or an empty list if it is not present.