Interface VpnToDpnList
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<VpnToDpnList>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<VpnInstanceOpDataEntry>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.Identifiable<VpnToDpnListKey>
@Generated("mdsal-binding-generator") public interface VpnToDpnList extends org.opendaylight.yangtools.yang.binding.ChildOf<VpnInstanceOpDataEntry>, org.opendaylight.yangtools.yang.binding.Augmentable<VpnToDpnList>, org.opendaylight.yangtools.yang.binding.Identifiable<VpnToDpnListKey>
This class represents the following YANG schema fragment defined in module odl-l3vpn
list vpn-to-dpn-list { key dpnId; leaf dpnId { type uint64; } list vpn-interfaces { key interface-name; leaf interface-name { type string; } } list ip-addresses { key ip-address; leaf ip-address { type string; } leaf ip-address-source { type enumeration { enum ExternalFixedIP; enum FloatingIP; } } } leaf dpn-state { type enumeration { enum active { value 0; } enum inactive { value 1; } } default active; } }
The schema path to identify an instance is odl-l3vpn/vpn-instance-op-data/vpn-instance-op-data-entry/vpn-to-dpn-listTo create instances of this class use
VpnToDpnListBuilder
.- See Also:
VpnToDpnListBuilder
,VpnToDpnListKey
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
VpnToDpnList.DpnState
-
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 VpnToDpnList thisObj, java.lang.Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull VpnToDpnList obj)
Default implementation ofObject.hashCode()
contract for this interface.static java.lang.String
bindingToString(@NonNull VpnToDpnList obj)
Default implementation ofObject.toString()
contract for this interface.org.opendaylight.yangtools.yang.common.Uint64
getDpnId()
Return dpnId, ornull
if it is not present.VpnToDpnList.DpnState
getDpnState()
Return dpnState, ornull
if it is not present.@Nullable java.util.Map<IpAddressesKey,IpAddresses>
getIpAddresses()
Return ipAddresses, ornull
if it is not present.@Nullable java.util.Map<VpnInterfacesKey,VpnInterfaces>
getVpnInterfaces()
Return vpnInterfaces, ornull
if it is not present.default java.lang.Class<VpnToDpnList>
implementedInterface()
VpnToDpnListKey
key()
default @NonNull java.util.Map<IpAddressesKey,IpAddresses>
nonnullIpAddresses()
Return ipAddresses, or an empty list if it is not present.default @NonNull java.util.Map<VpnInterfacesKey,VpnInterfaces>
nonnullVpnInterfaces()
Return vpnInterfaces, or an empty list if it is not present.
-
-
-
Method Detail
-
implementedInterface
default java.lang.Class<VpnToDpnList> 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 VpnToDpnList 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:
java.lang.NullPointerException
- ifobj
is null
-
bindingEquals
static boolean bindingEquals(@NonNull VpnToDpnList thisObj, java.lang.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:
java.lang.NullPointerException
- ifthisObj
is null
-
bindingToString
static java.lang.String bindingToString(@NonNull VpnToDpnList 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:
java.lang.NullPointerException
- ifobj
is null
-
getDpnId
org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
Return dpnId, ornull
if it is not present.- Returns:
org.opendaylight.yangtools.yang.common.Uint64
dpnId, ornull
if it is not present.
-
getVpnInterfaces
@Nullable java.util.Map<VpnInterfacesKey,VpnInterfaces> getVpnInterfaces()
Return vpnInterfaces, ornull
if it is not present.- Returns:
java.util.Map
vpnInterfaces, ornull
if it is not present.
-
nonnullVpnInterfaces
default @NonNull java.util.Map<VpnInterfacesKey,VpnInterfaces> nonnullVpnInterfaces()
Return vpnInterfaces, or an empty list if it is not present.- Returns:
java.util.Map
vpnInterfaces, or an empty list if it is not present.
-
getIpAddresses
@Nullable java.util.Map<IpAddressesKey,IpAddresses> getIpAddresses()
Return ipAddresses, ornull
if it is not present.- Returns:
java.util.Map
ipAddresses, ornull
if it is not present.
-
nonnullIpAddresses
default @NonNull java.util.Map<IpAddressesKey,IpAddresses> nonnullIpAddresses()
Return ipAddresses, or an empty list if it is not present.- Returns:
java.util.Map
ipAddresses, or an empty list if it is not present.
-
getDpnState
VpnToDpnList.DpnState getDpnState()
Return dpnState, ornull
if it is not present.This flag indicates the state of the DPN. Active state indicates atleast one vpn interface present on that DPN for the vpn. Inactive state indicates no vpn interface present on that DPN for this vpn.
- Returns:
org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList.DpnState
dpnState, ornull
if it is not present.
-
key
VpnToDpnListKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<VpnToDpnListKey>
-
-