Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps

Interface Subnetmap

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Subnetmap>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Subnetmaps>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<SubnetmapKey>, NetworkAttributes
    @Generated("mdsal-binding-generator")
public interface Subnetmap
extends org.opendaylight.yangtools.yang.binding.ChildOf<Subnetmaps>, org.opendaylight.yangtools.yang.binding.Augmentable<Subnetmap>, NetworkAttributes, org.opendaylight.yangtools.yang.binding.Identifiable<SubnetmapKey>

    This class represents the following YANG schema fragment defined in module neutronvpn 

     list subnetmap {
   key id;
   leaf id {
     type yang:uuid;
   }
   leaf subnet-ip {
     type string;
   }
   uses network-attributes;
   leaf tenant-id {
     type yang:uuid;
   }
   leaf router-id {
     type yang:uuid;
   }
   leaf router-interface-port-id {
     type yang:uuid;
   }
   leaf router-intf-mac-address {
     type string;
   }
   leaf router-interface-fixed-ip {
     type string;
   }
   leaf vpn-id {
     type yang:uuid;
   }
   leaf internet-vpn-id {
     type yang:uuid;
   }
   leaf-list port-list {
     type yang:uuid;
   }
   leaf-list direct-port-list {
     type yang:uuid;
   }
 }
    The schema path to identify an instance is neutronvpn/subnetmaps/subnetmap

    To create instances of this class use SubnetmapBuilder.

    See Also:
    SubnetmapBuilder, SubnetmapKey

    • 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 Subnetmap thisObj, java.lang.Object obj)
      Default implementation of Object.equals(Object) contract for this interface.
      static int bindingHashCode​(@NonNull Subnetmap obj)
      Default implementation of Object.hashCode() contract for this interface.
      static java.lang.String bindingToString​(@NonNull Subnetmap obj)
      Default implementation of Object.toString() contract for this interface.
      @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getDirectPortList()
      Return directPortList, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getId()
      Return id, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getInternetVpnId()
      Return internetVpnId, or null if it is not present.
      @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getPortList()
      Return portList, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getRouterId()
      Return routerId, or null if it is not present.
      java.lang.String getRouterInterfaceFixedIp()
      Return routerInterfaceFixedIp, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getRouterInterfacePortId()
      Return routerInterfacePortId, or null if it is not present.
      java.lang.String getRouterIntfMacAddress()
      Return routerIntfMacAddress, or null if it is not present.
      java.lang.String getSubnetIp()
      Return subnetIp, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()
      Return tenantId, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getVpnId()
      Return vpnId, or null if it is not present.
      default java.lang.Class<Subnetmap> implementedInterface()  
      SubnetmapKey key()  

      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation, augmentations

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • bindingHashCode

        static int bindingHashCode​(@NonNull Subnetmap 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 Subnetmap 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 Subnetmap 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

      • getId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getId()
        Return id, or null if it is not present. 
             
         UUID representing the subnet
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid id, or null if it is not present.

      • getSubnetIp

        java.lang.String getSubnetIp()
        Return subnetIp, or null if it is not present. 
             
         Specifies the subnet IP in CIDR format
        Returns:
        java.lang.String subnetIp, or null if it is not present.

      • getTenantId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()
        Return tenantId, or null if it is not present. 
             
         The UUID of the tenant that will own the subnet.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid tenantId, or null if it is not present.

      • getRouterId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getRouterId()
        Return routerId, or null if it is not present. 
             
         router to which this subnet belongs
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid routerId, or null if it is not present.

      • getRouterInterfacePortId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getRouterInterfacePortId()
        Return routerInterfacePortId, or null if it is not present. 
             
         port corresponding to router interface on this subnet
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid routerInterfacePortId, or null if it is not present.

      • getRouterIntfMacAddress

        java.lang.String getRouterIntfMacAddress()
        Return routerIntfMacAddress, or null if it is not present. 
             
         router interface mac address on this subnet
        Returns:
        java.lang.String routerIntfMacAddress, or null if it is not present.

      • getRouterInterfaceFixedIp

        java.lang.String getRouterInterfaceFixedIp()
        Return routerInterfaceFixedIp, or null if it is not present. 
             
         fixed ip of the router interface port on this subnet
        Returns:
        java.lang.String routerInterfaceFixedIp, or null if it is not present.

      • getVpnId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getVpnId()
        Return vpnId, or null if it is not present. 
             
         VPN to which this subnet belongs
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid vpnId, or null if it is not present.

      • getInternetVpnId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getInternetVpnId()
        Return internetVpnId, or null if it is not present. 
             
         internet VPN to which this IPv6 subnet belongs
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid internetVpnId, or null if it is not present.

      • getPortList

        @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getPortList()
        Return portList, or null if it is not present.
        Returns:
        java.util.List portList, or null if it is not present.

      • getDirectPortList

        @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getDirectPortList()
        Return directPortList, or null if it is not present.
        Returns:
        java.util.List directPortList, or null if it is not present.

      • key

        SubnetmapKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<SubnetmapKey>