- 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:- Linux and Windows on VMWare (IBM Java 8 only).
- AIX and Linux on PowerVM.
- Linux and z/OS on z/VM.
- 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 newGuestOSMemoryUsageinstance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GuestOSMemoryUsagefrom(CompositeData cd)Receives aCompositeDatarepresenting aGuestOSMemoryUsageobject and attempts to return the rootGuestOSMemoryUsageinstance.longgetMaxMemLimit()The amount of real Memory allowed to be used by the Guest as reported by the Hypervisor in MB.longgetMemUsed()The total Memory used by the Guest as reported by the Hypervisor in MB.longgetTimestamp()The timestamp when the usage statistics were last sampled in microseconds.StringtoString()Text description of thisGuestOSMemoryUsageobject.
-
-
-
Constructor Detail
-
GuestOSMemoryUsage
public GuestOSMemoryUsage()
Creates a newGuestOSMemoryUsageinstance.
-
-
Method Detail
-
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 aCompositeDatarepresenting aGuestOSMemoryUsageobject and attempts to return the rootGuestOSMemoryUsageinstance.- Parameters:
cd- ACompositeDatathat represents aGuestOSMemoryUsage.- Returns:
- if
cdis non-null, returns a new instance ofGuestOSMemoryUsage, Ifcdisnull, returnsnull. - Throws:
IllegalArgumentException- if argumentcddoes not correspond to aGuestOSMemoryUsagewith the following attributes:memUsed(java.lang.Long)timestamp(java.lang.Long)maxMemLimit(java.lang.Long)
-
toString
public String toString()
Text description of thisGuestOSMemoryUsageobject.- Overrides:
toStringin classObject- Returns:
- text description of this
GuestOSMemoryUsageobject.
-
-