Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.dhcp_allocation_pool.rev161214.dhcp_allocation_pool.network

Interface AllocationPool

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

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

     list allocation-pool {
   key subnet;
   leaf subnet {
     type inet:ip-prefix;
   }
   leaf allocate-from {
     type inet:ip-address;
   }
   leaf allocate-to {
     type inet:ip-address;
   }
   leaf gateway {
     type inet:ip-address;
   }
   leaf-list dns-servers {
     type inet:ip-address;
   }
 }
    The schema path to identify an instance is dhcp_allocation_pool/dhcp_allocation_pool/network/allocation-pool

    To create instances of this class use AllocationPoolBuilder.

    See Also:
    AllocationPoolBuilder, AllocationPoolKey

    • 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 AllocationPool thisObj, java.lang.Object obj)
      Default implementation of Object.equals(Object) contract for this interface.
      static int bindingHashCode​(@NonNull AllocationPool obj)
      Default implementation of Object.hashCode() contract for this interface.
      static java.lang.String bindingToString​(@NonNull AllocationPool obj)
      Default implementation of Object.toString() contract for this interface.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAllocateFrom()
      Return allocateFrom, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAllocateTo()
      Return allocateTo, or null if it is not present.
      @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getDnsServers()
      Return dnsServers, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getGateway()
      Return gateway, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getSubnet()
      Return subnet, or null if it is not present.
      default java.lang.Class<AllocationPool> implementedInterface()  
      AllocationPoolKey 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<AllocationPool> 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 AllocationPool 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 AllocationPool 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 AllocationPool 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

      • getSubnet

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getSubnet()
        Return subnet, or null if it is not present. 
             
         subnet for the dhcp to allocate ip addresses
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix subnet, or null if it is not present.

      • getAllocateFrom

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAllocateFrom()
        Return allocateFrom, or null if it is not present. 
             
         low allocation limit
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress allocateFrom, or null if it is not present.

      • getAllocateTo

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAllocateTo()
        Return allocateTo, or null if it is not present. 
             
         high allocation limit
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress allocateTo, or null if it is not present.

      • getGateway

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getGateway()
        Return gateway, or null if it is not present. 
             
         default gateway for dhcp allocation
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress gateway, or null if it is not present.

      • getDnsServers

        @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getDnsServers()
        Return dnsServers, or null if it is not present. 
             
         dns server list
        Returns:
        java.util.List dnsServers, or null if it is not present.