Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.platform.component.memory.state

Interface Memory

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Memory>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PlatformComponentMemoryState>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface Memory
extends org.opendaylight.yangtools.yang.binding.ChildOf<PlatformComponentMemoryState>, org.opendaylight.yangtools.yang.binding.Augmentable<Memory>
    For components that have associated memory, these values report information about available and utilized memory.

    This class represents the following YANG schema fragment defined in module openconfig-platform 

     container memory {
   leaf available {
     type uint64;
     units bytes;
   }
   leaf utilized {
     type uint64;
     units bytes;
   }
 }
    The schema path to identify an instance is openconfig-platformplatform-component-memory-statememory

    To create instances of this class use MemoryBuilder.

    See Also:
    MemoryBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<Memory> 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 Memory 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:
        NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull Memory thisObj,
                             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:
        NullPointerException - if thisObj is null

      • bindingToString

        static String bindingToString​(@NonNull Memory 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:
        NullPointerException - if obj is null

      • getAvailable

        org.opendaylight.yangtools.yang.common.Uint64 getAvailable()
        Return available, or null if it is not present. 
             
         The available memory physically installed, or logically allocated to the
         component.
        Returns:
        Uint64 available, or null if it is not present.

      • requireAvailable

        default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireAvailable()
        Return available, guaranteed to be non-null. 
             
         The available memory physically installed, or logically allocated to the
         component.
        Returns:
        Uint64 available, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if available is not present

      • getUtilized

        org.opendaylight.yangtools.yang.common.Uint64 getUtilized()
        Return utilized, or null if it is not present. 
             
         The memory currently in use by processes running on the component, not
         considering reserved memory that is not available for use.
        Returns:
        Uint64 utilized, or null if it is not present.

      • requireUtilized

        default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireUtilized()
        Return utilized, guaranteed to be non-null. 
             
         The memory currently in use by processes running on the component, not
         considering reserved memory that is not available for use.
        Returns:
        Uint64 utilized, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if utilized is not present