Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.openconfig.types.rev190416

Interface AvgMinMaxInstantStatsPct

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, MinMaxTime, StatIntervalState

All Known Subinterfaces:

HardwareInterrupt, Idle, Kernel, Nice, SoftwareInterrupt, Total, User, Wait

@Generated("mdsal-binding-generator")
public interface AvgMinMaxInstantStatsPct
extends org.opendaylight.yangtools.yang.binding.DataObject, StatIntervalState, MinMaxTime

Common grouping for percentage statistics. Values include the instantaneous, average, minimum, and maximum statistics. Statistics are computed and reported based on a moving time interval (e.g., the last 30s). If supported by the device, the time interval over which the statistics are computed, and the times at which the minimum and maximum values occurred, are also reported.

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

 grouping avg-min-max-instant-stats-pct {
   leaf instant {
     type oc-types:percentage;
   }
   leaf avg {
     type oc-types:percentage;
   }
   leaf min {
     type oc-types:percentage;
   }
   leaf max {
     type oc-types:percentage;
   }
   uses stat-interval-state;
   uses min-max-time;
 }
 

The schema path to identify an instance is openconfig-typesavg-min-max-instant-stats-pct

Field Summary

Fields

Modifier and Type	Field	Description
static @NonNull org.opendaylight.yangtools.yang.common.QName	QNAME

Method Summary

Modifier and Type	Method	Description
Percentage	getAvg()	Return avg, or null if it is not present.
Percentage	getInstant()	Return instant, or null if it is not present.
Percentage	getMax()	Return max, or null if it is not present.
Percentage	getMin()	Return min, or null if it is not present.
Class<? extends AvgMinMaxInstantStatsPct>	implementedInterface()
default @NonNull Percentage	requireAvg()	Return avg, guaranteed to be non-null.
default @NonNull Percentage	requireInstant()	Return instant, guaranteed to be non-null.
default @NonNull Percentage	requireMax()	Return max, guaranteed to be non-null.
default @NonNull Percentage	requireMin()	Return min, guaranteed to be non-null.

Methods inherited from interface org.opendaylight.yang.gen.v1.http.openconfig.net.yang.openconfig.types.rev190416.MinMaxTime

getMaxTime, getMinTime, requireMaxTime, requireMinTime

Methods inherited from interface org.opendaylight.yang.gen.v1.http.openconfig.net.yang.openconfig.types.rev190416.StatIntervalState

getInterval, requireInterval

Field Detail

QNAME

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

Method Detail

implementedInterface

Class<? extends AvgMinMaxInstantStatsPct> implementedInterface()

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

Specified by:

implementedInterface in interface MinMaxTime

Specified by:

implementedInterface in interface StatIntervalState

getInstant

Percentage getInstant()

Return instant, or null if it is not present.

     
         The instantaneous percentage value.
     
 

Returns:

Percentage instant, or null if it is not present.

requireInstant

default @NonNull Percentage requireInstant()

Return instant, guaranteed to be non-null.

     
         The instantaneous percentage value.
     
 

Returns:

Percentage instant, guaranteed to be non-null.

Throws:

NoSuchElementException - if instant is not present

getAvg

Percentage getAvg()

Return avg, or null if it is not present.

     
         The arithmetic mean value of the percentage measure of the statistic over the
         time interval.
     
 

Returns:

Percentage avg, or null if it is not present.

requireAvg

default @NonNull Percentage requireAvg()

Return avg, guaranteed to be non-null.

     
         The arithmetic mean value of the percentage measure of the statistic over the
         time interval.
     
 

Returns:

Percentage avg, guaranteed to be non-null.

Throws:

NoSuchElementException - if avg is not present

getMin

Percentage getMin()

Return min, or null if it is not present.

     
         The minimum value of the percentage measure of the statistic over the time
         interval.
     
 

Returns:

Percentage min, or null if it is not present.

requireMin

default @NonNull Percentage requireMin()

Return min, guaranteed to be non-null.

     
         The minimum value of the percentage measure of the statistic over the time
         interval.
     
 

Returns:

Percentage min, guaranteed to be non-null.

Throws:

NoSuchElementException - if min is not present

getMax

Percentage getMax()

Return max, or null if it is not present.

     
         The maximum value of the percentage measure of the statistic over the time
         interval.
     
 

Returns:

Percentage max, or null if it is not present.

requireMax

default @NonNull Percentage requireMax()

Return max, guaranteed to be non-null.

     
         The maximum value of the percentage measure of the statistic over the time
         interval.
     
 

Returns:

Percentage max, guaranteed to be non-null.

Throws:

NoSuchElementException - if max is not present