Class GuestOSMemoryUsage

java.lang.Object
com.ibm.virtualization.management.GuestOSMemoryUsage
public final class GuestOSMemoryUsage extends Object
This provides a snapshot of the Guest (Virtual Machine(VM)/Logical Partition(LPAR)) Memory usage statistics as seen by the Hypervisor Host. The supported Operating System and Hypervisor combinations are:
  1. Linux and Windows on VMWare (IBM Java 8 only).
  2. AIX and Linux on PowerVM.
  3. Linux and z/OS on z/VM.
  4. Guest Operating System memory usage statistics are not available on Linux for PowerKVM.
Since:
1.7.1

  • Constructor Summary

    Constructors
    Constructor
    Description
    GuestOSMemoryUsage()
    Creates a new GuestOSMemoryUsage instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    static GuestOSMemoryUsage
    from(CompositeData cd)
    Receives a CompositeData representing a GuestOSMemoryUsage object and attempts to return the root GuestOSMemoryUsage instance.
    long
    getMaxMemLimit()
    The amount of real Memory allowed to be used by the Guest as reported by the Hypervisor in MB.
    long
    getMemUsed()
    The total Memory used by the Guest as reported by the Hypervisor in MB.
    long
    getTimestamp()
    The timestamp when the usage statistics were last sampled in microseconds.
    String
    toString()
    Text description of this GuestOSMemoryUsage object.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • GuestOSMemoryUsage

      public GuestOSMemoryUsage()
      Creates a new GuestOSMemoryUsage instance.

  • Method Details

    • getMemUsed

      public long getMemUsed()
      The total Memory used by the Guest as reported by the Hypervisor in MB.
      Returns:
      Current used Memory by the Guest in MB or -1 if info not available.

    • getTimestamp

      public long getTimestamp()
      The timestamp when the usage statistics were last sampled in microseconds.
      Returns:
      The last sampling timestamp in microseconds.

    • getMaxMemLimit

      public long getMaxMemLimit()
      The amount of real Memory allowed to be used by the Guest as reported by the Hypervisor in MB.
      Returns:
      Max Memory that can be used by the Guest in MB or -1 if info not available or if no limit has been set.

    • from

      public static GuestOSMemoryUsage from(CompositeData cd)
      Receives a CompositeData representing a GuestOSMemoryUsage object and attempts to return the root GuestOSMemoryUsage instance.
      Parameters:
      cd - A CompositeData that represents a GuestOSMemoryUsage.
      Returns:
      if cd is non- null, returns a new instance of GuestOSMemoryUsage, If cd is null, returns null.
      Throws:
      IllegalArgumentException - if argument cd does not correspond to a GuestOSMemoryUsage with the following attributes:
      • memUsed(java.lang.Long)
      • timestamp(java.lang.Long)
      • maxMemLimit(java.lang.Long)

    • toString

      public String toString()
      Text description of this GuestOSMemoryUsage object.
      Overrides:
      toString in class Object
      Returns:
      text description of this GuestOSMemoryUsage object.