Interface IpPrefixMap

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<IpPrefixMap>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<OdlFibData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

    @Generated("mdsal-binding-generator")
    public interface IpPrefixMap
    extends org.opendaylight.yangtools.yang.binding.ChildOf<OdlFibData>, org.opendaylight.yangtools.yang.binding.Augmentable<IpPrefixMap>
    Stores information about a parent vpn and prefix in that parent vpn, along with what other vpn-instances import the parent vpn

    This class represents the following YANG schema fragment defined in module odl-fib

     container ip-prefix-map {
       config false;
       list ip-prefix-info {
         key "prefix parent-primary-rd";
         leaf prefix {
           type string;
         }
         leaf parent-primary-rd {
           type string;
         }
         leaf dpn-id {
           type uint64;
         }
         leaf-list vpn-instance-list {
           type string;
         }
         leaf parent-vpnid {
           type uint32;
         }
         leaf vpn-interface-name {
           type string;
         }
         leaf elan-tag {
           type uint32;
         }
         leaf is-subnet-route {
           type boolean;
         }
         leaf encap-type {
           type enumeration {
             enum mplsgre {
               value 0;
             }
             enum vxlan {
               value 1;
             }
           }
           default mplsgre;
         }
         leaf l3vni {
           type uint32;
         }
         leaf l2vni {
           type uint32;
         }
         list route-paths {
           key nexthop-address;
           leaf nexthop-address {
             type string;
           }
           leaf label {
             type uint32;
           }
           leaf gateway_mac_address {
             type string;
           }
         }
       }
     }
     
    The schema path to identify an instance is odl-fib/ip-prefix-map

    To create instances of this class use IpPrefixMapBuilder.

    See Also:
    IpPrefixMapBuilder
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<IpPrefixMap> 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 IpPrefixMap 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 IpPrefixMap 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 IpPrefixMap 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
      • getIpPrefixInfo

        @Nullable java.util.Map<IpPrefixInfoKey,​IpPrefixInfo> getIpPrefixInfo()
        Return ipPrefixInfo, or null if it is not present.
        Returns:
        java.util.Map ipPrefixInfo, or null if it is not present.
      • nonnullIpPrefixInfo

        default @NonNull java.util.Map<IpPrefixInfoKey,​IpPrefixInfo> nonnullIpPrefixInfo()
        Return ipPrefixInfo, or an empty list if it is not present.
        Returns:
        java.util.Map ipPrefixInfo, or an empty list if it is not present.