Interface AllowedAddressPairs
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<AllowedAddressPairs>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<PortAttributes>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.Identifiable<AllowedAddressPairsKey>
@Generated("mdsal-binding-generator") public interface AllowedAddressPairs extends org.opendaylight.yangtools.yang.binding.ChildOf<PortAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<AllowedAddressPairs>, org.opendaylight.yangtools.yang.binding.Identifiable<AllowedAddressPairsKey>
Allowed address pairs for this port. For example: neutron port-create net1 --allowed-address-pairs type=dict list=true mac_address=<mac_address>,ip_address=<ip_cidr> Setting an allowed-address-pair that matches the mac_address and ip_address of a port is prevented. This is because that would have no effect since traffic matching the mac_address and ip_address is already allowed to pass through the portThis class represents the following YANG schema fragment defined in module neutron-ports
list allowed-address-pairs { key "mac-address ip-address"; leaf mac-address { type yang:mac-address; } leaf ip-address { type types:ip-prefix-or-address; } }
The schema path to identify an instance is neutron-ports/port-attributes/allowed-address-pairsTo create instances of this class use
AllowedAddressPairsBuilder
.- See Also:
AllowedAddressPairsBuilder
,AllowedAddressPairsKey
-
-
Field Summary
Fields Modifier and Type Field Description static @NonNull org.opendaylight.yangtools.yang.common.QName
QNAME
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static boolean
bindingEquals(@NonNull AllowedAddressPairs thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull AllowedAddressPairs obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull AllowedAddressPairs obj)
Default implementation ofObject.toString()
contract for this interface.IpPrefixOrAddress
getIpAddress()
Return ipAddress, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
getMacAddress()
Return macAddress, ornull
if it is not present.default Class<AllowedAddressPairs>
implementedInterface()
AllowedAddressPairsKey
key()
default @NonNull IpPrefixOrAddress
requireIpAddress()
Return ipAddress, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
requireMacAddress()
Return macAddress, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
default Class<AllowedAddressPairs> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
bindingHashCode
static int bindingHashCode(@NonNull AllowedAddressPairs obj)
Default implementation ofObject.hashCode()
contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.- Parameters:
obj
- Object for which to generate hashCode() result.- Returns:
- Hash code value of data modeled by this interface.
- Throws:
NullPointerException
- ifobj
is null
-
bindingEquals
static boolean bindingEquals(@NonNull AllowedAddressPairs thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.- Parameters:
thisObj
- Object acting as the receiver of equals invocationobj
- Object acting as argument to equals invocation- Returns:
- True if thisObj and obj are considered equal
- Throws:
NullPointerException
- ifthisObj
is null
-
bindingToString
static String bindingToString(@NonNull AllowedAddressPairs obj)
Default implementation ofObject.toString()
contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.- Parameters:
obj
- Object for which to generate toString() result.- Returns:
String
value of data modeled by this interface.- Throws:
NullPointerException
- ifobj
is null
-
key
AllowedAddressPairsKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<AllowedAddressPairsKey>
-
getMacAddress
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMacAddress()
Return macAddress, ornull
if it is not present.- Returns:
MacAddress
macAddress, ornull
if it is not present.
-
requireMacAddress
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress requireMacAddress()
Return macAddress, guaranteed to be non-null.- Returns:
MacAddress
macAddress, guaranteed to be non-null.- Throws:
NoSuchElementException
- if macAddress is not present
-
getIpAddress
IpPrefixOrAddress getIpAddress()
Return ipAddress, ornull
if it is not present.- Returns:
IpPrefixOrAddress
ipAddress, ornull
if it is not present.
-
requireIpAddress
default @NonNull IpPrefixOrAddress requireIpAddress()
Return ipAddress, guaranteed to be non-null.- Returns:
IpPrefixOrAddress
ipAddress, guaranteed to be non-null.- Throws:
NoSuchElementException
- if ipAddress is not present
-
-