Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry

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-list

    To create instances of this class use VpnToDpnListBuilder.

    See Also:
    VpnToDpnListBuilder, VpnToDpnListKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default java.lang.Class<VpnToDpnList> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull VpnToDpnList obj)
        Default implementation of Object.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 - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull VpnToDpnList thisObj,
                             java.lang.Object obj)
        Default implementation of Object.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 invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        java.lang.NullPointerException - if thisObj is null

      • bindingToString

        static java.lang.String bindingToString​(@NonNull VpnToDpnList obj)
        Default implementation of Object.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 - if obj is null

      • getDpnId

        org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
        Return dpnId, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint64 dpnId, or null if it is not present.

      • getVpnInterfaces

        @Nullable java.util.Map<VpnInterfacesKey,​VpnInterfaces> getVpnInterfaces()
        Return vpnInterfaces, or null if it is not present.
        Returns:
        java.util.Map vpnInterfaces, or null 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, or null if it is not present.
        Returns:
        java.util.Map ipAddresses, or null 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, or null 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, or null if it is not present.