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

Interface IdPool

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<IdPool>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<IdPools>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<IdPoolKey>
    public interface IdPool
extends org.opendaylight.yangtools.yang.binding.ChildOf<IdPools>, org.opendaylight.yangtools.yang.binding.Augmentable<IdPool>, org.opendaylight.yangtools.yang.binding.Identifiable<IdPoolKey>

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

     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/id-pool

    To create instances of this class use IdPoolBuilder.

    See Also:
    IdPoolBuilder, IdPoolKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • getPoolName

        @Nullable java.lang.String getPoolName()
        Returns:
        java.lang.String poolName, or null if not present

      • getBlockSize

        @Nullable org.opendaylight.yangtools.yang.common.Uint16 getBlockSize()
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 blockSize, or null if not present

      • getParentPoolName

        @Nullable java.lang.String getParentPoolName()
        Returns:
        java.lang.String parentPoolName, or null if not present

      • getChildPools

        @Nullable java.util.List<ChildPools> getChildPools()
        Returns:
        java.util.List childPools, or null if not present

      • nonnullChildPools

        default @NonNull java.util.List<ChildPools> nonnullChildPools()
        Returns:
        java.util.List childPools, or an empty list if it is not present

      • getIdEntries

        @Nullable java.util.List<IdEntries> getIdEntries()
        Id entry for the given Id Pool, where id-key is used to identify the id entry
        Returns:
        java.util.List idEntries, or null if not present

      • nonnullIdEntries

        default @NonNull java.util.List<IdEntries> nonnullIdEntries()
        Returns:
        java.util.List idEntries, or an empty list if it is not present

      • getAvailableIdsHolder

        @Nullable AvailableIdsHolder getAvailableIdsHolder()
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.id.pool.AvailableIdsHolder availableIdsHolder, or null if not present

      • getReleasedIdsHolder

        @Nullable ReleasedIdsHolder getReleasedIdsHolder()
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.id.pool.ReleasedIdsHolder releasedIdsHolder, or null if not present

      • key

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