Interface IpPrefixInfo

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

    @Generated("mdsal-binding-generator")
    public interface IpPrefixInfo
    extends org.opendaylight.yangtools.yang.binding.ChildOf<IpPrefixMap>, org.opendaylight.yangtools.yang.binding.Augmentable<IpPrefixInfo>, org.opendaylight.yangtools.yang.binding.Identifiable<IpPrefixInfoKey>

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

     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/ip-prefix-info

    To create instances of this class use IpPrefixInfoBuilder.

    See Also:
    IpPrefixInfoBuilder, IpPrefixInfoKey
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  IpPrefixInfo.EncapType  
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<IpPrefixInfo> 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 IpPrefixInfo 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 IpPrefixInfo 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 IpPrefixInfo 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
      • getPrefix

        java.lang.String getPrefix()
        Return prefix, or null if it is not present.
        Returns:
        java.lang.String prefix, or null if it is not present.
      • getParentPrimaryRd

        java.lang.String getParentPrimaryRd()
        Return parentPrimaryRd, or null if it is not present.
        Returns:
        java.lang.String parentPrimaryRd, or null if it is not present.
      • 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.
      • getVpnInstanceList

        @Nullable java.util.List<java.lang.String> getVpnInstanceList()
        Return vpnInstanceList, or null if it is not present.
        Returns:
        java.util.List vpnInstanceList, or null if it is not present.
      • getParentVpnid

        org.opendaylight.yangtools.yang.common.Uint32 getParentVpnid()
        Return parentVpnid, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 parentVpnid, or null if it is not present.
      • getVpnInterfaceName

        java.lang.String getVpnInterfaceName()
        Return vpnInterfaceName, or null if it is not present.
        Returns:
        java.lang.String vpnInterfaceName, or null if it is not present.
      • getElanTag

        org.opendaylight.yangtools.yang.common.Uint32 getElanTag()
        Return elanTag, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 elanTag, or null if it is not present.
      • getIsSubnetRoute

        java.lang.Boolean getIsSubnetRoute()
        Return isSubnetRoute, or null if it is not present.
        Returns:
        java.lang.Boolean isSubnetRoute, or null if it is not present.
      • isIsSubnetRoute

        @Deprecated(forRemoval=true)
        default java.lang.Boolean isIsSubnetRoute()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getEncapType

        IpPrefixInfo.EncapType getEncapType()
        Return encapType, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.ip.prefix.map.IpPrefixInfo.EncapType encapType, or null if it is not present.
      • getL3vni

        org.opendaylight.yangtools.yang.common.Uint32 getL3vni()
        Return l3vni, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 l3vni, or null if it is not present.
      • getL2vni

        org.opendaylight.yangtools.yang.common.Uint32 getL2vni()
        Return l2vni, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 l2vni, or null if it is not present.
      • getRoutePaths

        @Nullable java.util.Map<RoutePathsKey,​RoutePaths> getRoutePaths()
        Return routePaths, or null if it is not present.
        Returns:
        java.util.Map routePaths, or null if it is not present.
      • nonnullRoutePaths

        default @NonNull java.util.Map<RoutePathsKey,​RoutePaths> nonnullRoutePaths()
        Return routePaths, or an empty list if it is not present.
        Returns:
        java.util.Map routePaths, or an empty list if it is not present.