All Superinterfaces:: 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;
   }
 }

The schema path to identify an instance is openconfig-systemsystem-cpu-state

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class SystemCpuState.Index

Field Summary

Fields
Modifier and Type Field Description

static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`HardwareInterrupt`	`getHardwareInterrupt()`	Return hardwareInterrupt, or `null` if it is not present.
`Idle`	`getIdle()`	Return idle, or `null` if it is not present.
`SystemCpuState.Index`	`getIndex()`	Return index, or `null` if it is not present.
`Kernel`	`getKernel()`	Return kernel, or `null` if it is not present.
`Nice`	`getNice()`	Return nice, or `null` if it is not present.
`SoftwareInterrupt`	`getSoftwareInterrupt()`	Return softwareInterrupt, or `null` if it is not present.
`Total`	`getTotal()`	Return total, or `null` if it is not present.
`User`	`getUser()`	Return user, or `null` if it is not present.
`Wait`	`getWait()`	Return wait, or `null` if it is not present.
`Class<? extends SystemCpuState>`	`implementedInterface()`
`default @NonNull SystemCpuState.Index`	`requireIndex()`	Return index, guaranteed to be non-null.

Field Detail

QNAME

static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

Method Detail

implementedInterface
```
Class<? extends SystemCpuState> implementedInterface()
```
Specified by:

implementedInterface in interface 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.

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.

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.

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.

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.

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.

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.

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.

Interface SystemCpuState

Nested Class Summary

Field Summary