All Superinterfaces:: org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

All Known Subinterfaces:: MeteringRule

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

OpenStack Layer3 Metering label rules.

This class represents the following YANG schema fragment defined in module neutron-metering

 grouping metering-rule-attributes {
   leaf direction {
     type identityref {
       base direction-base;
     }
   }
   leaf metering-label-id {
     type yang:uuid;
   }
   leaf remote-ip-prefix {
     type inet:ip-prefix;
   }
   leaf excluded {
     type boolean;
     default false;
   }
 }

The schema path to identify an instance is neutron-metering/metering-rule-attributes

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
`Class<? extends DirectionBase>`	`getDirection()`	Return direction, or `null` if it is not present.
`Boolean`	`getExcluded()`	Return excluded, or `null` if it is not present.
`org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid`	`getMeteringLabelId()`	Return meteringLabelId, or `null` if it is not present.
`org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix`	`getRemoteIpPrefix()`	Return remoteIpPrefix, or `null` if it is not present.
`Class<? extends MeteringRuleAttributes>`	`implementedInterface()`
`default @NonNull Class<? extends DirectionBase>`	`requireDirection()`	Return direction, guaranteed to be non-null.
`default @NonNull Boolean`	`requireExcluded()`	Return excluded, guaranteed to be non-null.
`default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid`	`requireMeteringLabelId()`	Return meteringLabelId, guaranteed to be non-null.
`default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix`	`requireRemoteIpPrefix()`	Return remoteIpPrefix, guaranteed to be non-null.

Field Detail

QNAME

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

Method Detail

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

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

Specified by:

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

getDirection

Class<? extends DirectionBase> getDirection()

Return direction, or null if it is not present.

     
         The direction in which metering rule is applied.

Returns:: Class<? extends DirectionBase> direction, or null if it is not present.

requireDirection
```
default @NonNull Class<? extends DirectionBase> requireDirection()
```
Return direction, guaranteed to be non-null.
```
     
         The direction in which metering rule is applied.
     
 
```
Returns:

Class<? extends DirectionBase> direction, guaranteed to be non-null.

Throws:

NoSuchElementException - if direction is not present

getMeteringLabelId

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getMeteringLabelId()

Return meteringLabelId, or null if it is not present.

     
         Metering Label ID to associate with this metering rule.

Returns:: Uuid meteringLabelId, or null if it is not present.

requireMeteringLabelId

default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireMeteringLabelId()

Return meteringLabelId, guaranteed to be non-null.

     
         Metering Label ID to associate with this metering rule.

Returns:: Uuid meteringLabelId, guaranteed to be non-null.
Throws:: NoSuchElementException - if meteringLabelId is not present

getRemoteIpPrefix

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getRemoteIpPrefix()

Return remoteIpPrefix, or null if it is not present.

     
         The remote IP prefix to be associated with this metering rule. packet.

Returns:: IpPrefix remoteIpPrefix, or null if it is not present.

requireRemoteIpPrefix

default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix requireRemoteIpPrefix()

Return remoteIpPrefix, guaranteed to be non-null.

     
         The remote IP prefix to be associated with this metering rule. packet.

Returns:: IpPrefix remoteIpPrefix, guaranteed to be non-null.
Throws:: NoSuchElementException - if remoteIpPrefix is not present

getExcluded

Boolean getExcluded()

Return excluded, or null if it is not present.

     
         Specify whether the remote_ip_prefix will be excluded or not from traffic
         counters of the metering label, ie: to not count the traffic of a specific IP
         address of a range.

Returns:: Boolean excluded, or null if it is not present.

requireExcluded

default @NonNull Boolean requireExcluded()

Return excluded, guaranteed to be non-null.

     
         Specify whether the remote_ip_prefix will be excluded or not from traffic
         counters of the metering label, ie: to not count the traffic of a specific IP
         address of a range.

Returns:: Boolean excluded, guaranteed to be non-null.
Throws:: NoSuchElementException - if excluded is not present

Interface MeteringRuleAttributes

Field Summary