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, MeterAdded, MeterConfigStats, MeterConfigStats, MeterMessage, MeterRemoved, MeterUpdated, 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;
     }
   }
 }
 

The schema path to identify an instance is opendaylight-meter-types/meter

Field Summary

Fields

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

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 Boolean	isBarrier()	Deprecated, for removal: This API element is subject to removal in a future version.

Field Detail

QNAME

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

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:

org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterFlags flags, or null if it is not present.

getMeterId

MeterId getMeterId()

Return meterId, or null if it is not present.

     
         Meter instance
     
 

Returns:

org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId meterId, or null if it is not present.

getBarrier

Boolean getBarrier()

Return barrier, or null if it is not present.

     
         If true, barrier message is sent
     
 

Returns:

java.lang.Boolean barrier, or null if it is not present.

isBarrier

@Deprecated(forRemoval=true)
default Boolean isBarrier()

Deprecated, for removal: This API element is subject to removal in a future version.

getMeterName

String getMeterName()

Return meterName, or null if it is not present.

     
         Name of meter instance
     
 

Returns:

java.lang.String meterName, or null if it is not present.

getContainerName

String getContainerName()

Return containerName, or null if it is not present.

     
         Name of container
     
 

Returns:

java.lang.String containerName, or null if it is not present.

getMeterBandHeaders

MeterBandHeaders getMeterBandHeaders()

Return meterBandHeaders, or null if it is not present.

Returns:

org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.MeterBandHeaders meterBandHeaders, or null if it is not present.