Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918

Interface Meter

All Superinterfaces:

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

All Known Subinterfaces:

AddMeterInput, BatchAddMeters, BatchRemoveMeters, FlatBatchAddMeter, FlatBatchRemoveMeter, Meter, MeterConfigStats, MeterConfigStats, MeterMessage, NodeMeter, OriginalBatchedMeter, OriginalMeter, RemoveMeterInput, StaleMeter, UpdatedBatchedMeter, UpdatedMeter

@Generated("mdsal-binding-generator")
public interface Meter
extends org.opendaylight.yangtools.yang.binding.DataObject

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

 grouping meter {
   leaf flags {
     type meter-flags;
   }
   leaf meter-id {
     type meter-id;
   }
   leaf barrier {
     type boolean;
   }
   leaf meter-name {
     type string;
   }
   leaf container-name {
     type string;
   }
   container meter-band-headers {
     list meter-band-header {
       key band-id;
       leaf band-id {
         type band-id;
       }
       container meter-band-types {
         leaf flags {
           type meter-band-type;
         }
       }
       leaf band-rate {
         type uint32;
       }
       leaf band-burst-size {
         type uint32;
       }
       uses band-type;
     }
   }
 }
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Boolean	getBarrier()	Return barrier, or null if it is not present.
String	getContainerName()	Return containerName, or null if it is not present.
MeterFlags	getFlags()	Return flags, or null if it is not present.
MeterBandHeaders	getMeterBandHeaders()	Return meterBandHeaders, or null if it is not present.
MeterId	getMeterId()	Return meterId, or null if it is not present.
String	getMeterName()	Return meterName, or null if it is not present.
Class<? extends Meter>	implementedInterface()
default @NonNull Boolean	requireBarrier()	Return barrier, guaranteed to be non-null.
default @NonNull String	requireContainerName()	Return containerName, guaranteed to be non-null.
default @NonNull MeterFlags	requireFlags()	Return flags, guaranteed to be non-null.
default @NonNull MeterId	requireMeterId()	Return meterId, guaranteed to be non-null.
default @NonNull String	requireMeterName()	Return meterName, guaranteed to be non-null.

Field Detail

QNAME

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

YANG identifier of the statement represented by this class.

Method Detail

implementedInterface

Class<? extends Meter> implementedInterface()

Specified by:

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

Specified by:

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

getFlags

MeterFlags getFlags()

Return flags, or null if it is not present.

     
         Meter configuration flags
     
 

Returns:

MeterFlags flags, or null if it is not present.

requireFlags

default @NonNull MeterFlags requireFlags()

Return flags, guaranteed to be non-null.

     
         Meter configuration flags
     
 

Returns:

MeterFlags flags, guaranteed to be non-null.

Throws:

NoSuchElementException - if flags is not present

getMeterId

MeterId getMeterId()

Return meterId, or null if it is not present.

     
         Meter instance
     
 

Returns:

MeterId meterId, or null if it is not present.

requireMeterId

default @NonNull MeterId requireMeterId()

Return meterId, guaranteed to be non-null.

     
         Meter instance
     
 

Returns:

MeterId meterId, guaranteed to be non-null.

Throws:

NoSuchElementException - if meterId is not present

getBarrier

Boolean getBarrier()

Return barrier, or null if it is not present.

     
         If true, barrier message is sent
     
 

Returns:

Boolean barrier, or null if it is not present.

requireBarrier

default @NonNull Boolean requireBarrier()

Return barrier, guaranteed to be non-null.

     
         If true, barrier message is sent
     
 

Returns:

Boolean barrier, guaranteed to be non-null.

Throws:

NoSuchElementException - if barrier is not present

getMeterName

String getMeterName()

Return meterName, or null if it is not present.

     
         Name of meter instance
     
 

Returns:

String meterName, or null if it is not present.

requireMeterName

default @NonNull String requireMeterName()

Return meterName, guaranteed to be non-null.

     
         Name of meter instance
     
 

Returns:

String meterName, guaranteed to be non-null.

Throws:

NoSuchElementException - if meterName is not present

getContainerName

String getContainerName()

Return containerName, or null if it is not present.

     
         Name of container
     
 

Returns:

String containerName, or null if it is not present.

requireContainerName

default @NonNull String requireContainerName()

Return containerName, guaranteed to be non-null.

     
         Name of container
     
 

Returns:

String containerName, guaranteed to be non-null.

Throws:

NoSuchElementException - if containerName is not present

getMeterBandHeaders

MeterBandHeaders getMeterBandHeaders()

Return meterBandHeaders, or null if it is not present.

Returns:

MeterBandHeaders meterBandHeaders, or null if it is not present.