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

Interface AvgMinMaxInstantStatsPrecision2DB

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, MinMaxTime, StatIntervalState

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

Common grouping for recording dB values with 2 decimal precision. Values 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-precision2-dB {
   leaf instant {
     type decimal64 {
       fraction-digits 2;
     }
     units dB;
   }
   leaf avg {
     type decimal64 {
       fraction-digits 2;
     }
     units dB;
   }
   leaf min {
     type decimal64 {
       fraction-digits 2;
     }
     units dB;
   }
   leaf max {
     type decimal64 {
       fraction-digits 2;
     }
     units dB;
   }
   uses stat-interval-state;
   uses min-max-time;
 }
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
org.opendaylight.yangtools.yang.common.Decimal64	getAvg()	Return avg, or null if it is not present.
org.opendaylight.yangtools.yang.common.Decimal64	getInstant()	Return instant, or null if it is not present.
org.opendaylight.yangtools.yang.common.Decimal64	getMax()	Return max, or null if it is not present.
org.opendaylight.yangtools.yang.common.Decimal64	getMin()	Return min, or null if it is not present.
Class<? extends AvgMinMaxInstantStatsPrecision2DB>	implementedInterface()
default @NonNull org.opendaylight.yangtools.yang.common.Decimal64	requireAvg()	Return avg, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Decimal64	requireInstant()	Return instant, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Decimal64	requireMax()	Return max, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Decimal64	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 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 AvgMinMaxInstantStatsPrecision2DB> 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

Specified by:

implementedInterface in interface MinMaxTime

Specified by:

implementedInterface in interface StatIntervalState

getInstant

org.opendaylight.yangtools.yang.common.Decimal64 getInstant()

Return instant, or null if it is not present.

     
         The instantaneous value of the statistic.
     
 

Returns:

Decimal64 instant, or null if it is not present.

requireInstant

default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireInstant()

Return instant, guaranteed to be non-null.

     
         The instantaneous value of the statistic.
     
 

Returns:

Decimal64 instant, guaranteed to be non-null.

Throws:

NoSuchElementException - if instant is not present

getAvg

org.opendaylight.yangtools.yang.common.Decimal64 getAvg()

Return avg, or null if it is not present.

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

Returns:

Decimal64 avg, or null if it is not present.

requireAvg

default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireAvg()

Return avg, guaranteed to be non-null.

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

Returns:

Decimal64 avg, guaranteed to be non-null.

Throws:

NoSuchElementException - if avg is not present

getMin

org.opendaylight.yangtools.yang.common.Decimal64 getMin()

Return min, or null if it is not present.

     
         The minimum value of the statistic over the time interval.
     
 

Returns:

Decimal64 min, or null if it is not present.

requireMin

default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireMin()

Return min, guaranteed to be non-null.

     
         The minimum value of the statistic over the time interval.
     
 

Returns:

Decimal64 min, guaranteed to be non-null.

Throws:

NoSuchElementException - if min is not present

getMax

org.opendaylight.yangtools.yang.common.Decimal64 getMax()

Return max, or null if it is not present.

     
         The maximum value of the statistic over the time interval.
     
 

Returns:

Decimal64 max, or null if it is not present.

requireMax

default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireMax()

Return max, guaranteed to be non-null.

     
         The maximum value of the statistic over the time interval.
     
 

Returns:

Decimal64 max, guaranteed to be non-null.

Throws:

NoSuchElementException - if max is not present