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

      • getIdPool

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

      • nonnullIdPool

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