Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413

Interface SystemCpuState

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:
State
@Generated("mdsal-binding-generator") public interface SystemCpuState extends org.opendaylight.yangtools.yang.binding.DataObject
Operational state data for the system CPU(s)

This class represents the following YANG schema fragment defined in module openconfig-system 

 grouping system-cpu-state {
   leaf index {
     type union {
       type enumeration {
         enum ALL {
         }
       }
       type uint32;
     }
   }
   container total {
     uses oc-types:avg-min-max-instant-stats-pct;
   }
   container user {
     uses oc-types:avg-min-max-instant-stats-pct;
   }
   container kernel {
     uses oc-types:avg-min-max-instant-stats-pct;
   }
   container nice {
     uses oc-types:avg-min-max-instant-stats-pct;
   }
   container idle {
     uses oc-types:avg-min-max-instant-stats-pct;
   }
   container wait {
     uses oc-types:avg-min-max-instant-stats-pct;
   }
   container hardware-interrupt {
     uses oc-types:avg-min-max-instant-stats-pct;
   }
   container software-interrupt {
     uses oc-types:avg-min-max-instant-stats-pct;
   }
 }

  • 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 SystemCpuState> 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

    • getIndex

      SystemCpuState.Index getIndex()
      Return index, or null if it is not present. 
           
         The CPU index for each processor core on the system. On a single-core system,
         the index should be zero. The ALL index signifies an aggregation of the CPU
         utilization statistics over all cores in the system.
      Returns:
      Index index, or null if it is not present.

    • requireIndex

      default @NonNull SystemCpuState.Index requireIndex()
      Return index, guaranteed to be non-null. 
           
         The CPU index for each processor core on the system. On a single-core system,
         the index should be zero. The ALL index signifies an aggregation of the CPU
         utilization statistics over all cores in the system.
      Returns:
      Index index, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if index is not present

    • getTotal

      Total getTotal()
      Return total, or null if it is not present. 
           
         Total CPU utilization.
      Returns:
      Total total, or null if it is not present.

    • nonnullTotal

      @NonNull Total nonnullTotal()
      Return total, or an empty instance if it is not present.
      Returns:
      Total total, or an empty instance if it is not present.

    • getUser

      User getUser()
      Return user, or null if it is not present. 
           
         Percentage of CPU time spent running in user space.
      Returns:
      User user, or null if it is not present.

    • nonnullUser

      @NonNull User nonnullUser()
      Return user, or an empty instance if it is not present.
      Returns:
      User user, or an empty instance if it is not present.

    • getKernel

      Kernel getKernel()
      Return kernel, or null if it is not present. 
           
         Percentage of CPU time spent running in kernel space.
      Returns:
      Kernel kernel, or null if it is not present.

    • nonnullKernel

      @NonNull Kernel nonnullKernel()
      Return kernel, or an empty instance if it is not present.
      Returns:
      Kernel kernel, or an empty instance if it is not present.

    • getNice

      Nice getNice()
      Return nice, or null if it is not present. 
           
         Percentage of CPU time spent running low-priority (niced) user processes.
      Returns:
      Nice nice, or null if it is not present.

    • nonnullNice

      @NonNull Nice nonnullNice()
      Return nice, or an empty instance if it is not present.
      Returns:
      Nice nice, or an empty instance if it is not present.

    • getIdle

      Idle getIdle()
      Return idle, or null if it is not present. 
           
         Percentage of CPU time spent idle.
      Returns:
      Idle idle, or null if it is not present.

    • nonnullIdle

      @NonNull Idle nonnullIdle()
      Return idle, or an empty instance if it is not present.
      Returns:
      Idle idle, or an empty instance if it is not present.

    • getWait

      Wait getWait()
      Return wait, or null if it is not present. 
           
         Percentage of CPU time spent waiting for I/O.
      Returns:
      Wait wait, or null if it is not present.

    • nonnullWait

      @NonNull Wait nonnullWait()
      Return wait, or an empty instance if it is not present.
      Returns:
      Wait wait, or an empty instance if it is not present.

    • getHardwareInterrupt

      HardwareInterrupt getHardwareInterrupt()
      Return hardwareInterrupt, or null if it is not present. 
           
         Percentage of CPU time spent servicing hardware interrupts.
      Returns:
      HardwareInterrupt hardwareInterrupt, or null if it is not present.

    • nonnullHardwareInterrupt

      @NonNull HardwareInterrupt nonnullHardwareInterrupt()
      Return hardwareInterrupt, or an empty instance if it is not present.
      Returns:
      HardwareInterrupt hardwareInterrupt, or an empty instance if it is not present.

    • getSoftwareInterrupt

      SoftwareInterrupt getSoftwareInterrupt()
      Return softwareInterrupt, or null if it is not present. 
           
         Percentage of CPU time spent servicing software interrupts
      Returns:
      SoftwareInterrupt softwareInterrupt, or null if it is not present.

    • nonnullSoftwareInterrupt

      @NonNull SoftwareInterrupt nonnullSoftwareInterrupt()
      Return softwareInterrupt, or an empty instance if it is not present.
      Returns:
      SoftwareInterrupt softwareInterrupt, or an empty instance if it is not present.