Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406

Interface IdPools

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<IdPools>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<IdManagerData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface IdPools
extends org.opendaylight.yangtools.yang.binding.ChildOf<IdManagerData>, org.opendaylight.yangtools.yang.binding.Augmentable<IdPools>
    Parent Id Pool is responsible allocating block (or) set of Ids to child Id Pools. The number of child pools are determined using some algorthimic approach inside IdManager. For example, spawning child pools based on Id allocation request rate for the given Pool, one child pool per blade in the cluster etc

    This class represents the following YANG schema fragment defined in module id-manager 

     container id-pools {
   list id-pool {
     key pool-name;
     leaf pool-name {
       type string;
     }
     leaf block-size {
       type uint16;
     }
     leaf parent-pool-name {
       type string;
     }
     list child-pools {
       key child-pool-name;
       leaf child-pool-name {
         type string;
       }
       leaf last-access-time {
         type uint32;
       }
     }
     list id-entries {
       key id-key;
       leaf id-key {
         type string;
       }
       leaf-list id-value {
         type uint32;
       }
     }
     container available-ids-holder {
       uses available-ids;
     }
     container released-ids-holder {
       uses released-ids;
     }
   }
 }
    The schema path to identify an instance is id-manager/id-pools

    To create instances of this class use IdPoolsBuilder.

    See Also:
    IdPoolsBuilder

    • 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<IdPools> 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 IdPools 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 IdPools 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 IdPools 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

      • getIdPool

        @Nullable java.util.Map<IdPoolKey,​IdPool> getIdPool()
        Return idPool, or null if it is not present.
        Returns:
        java.util.Map idPool, or null if it is not present.

      • nonnullIdPool

        default @NonNull java.util.Map<IdPoolKey,​IdPool> nonnullIdPool()
        Return idPool, or an empty list if it is not present.
        Returns:
        java.util.Map idPool, or an empty list if it is not present.