Class HostSystemRecentCPUAndMemoryMonitorEntry
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
-
- com.unboundid.ldap.sdk.unboundidds.monitors.HostSystemRecentCPUAndMemoryMonitorEntry
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class HostSystemRecentCPUAndMemoryMonitorEntry extends MonitorEntry
This class defines a monitor entry that provides information about the recent CPU and memory utilization of the underlying system.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description HostSystemRecentCPUAndMemoryMonitorEntry(Entry entry)
Creates a new host system recent CPU and memory monitor entry from the provided entry.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,MonitorAttribute>
getMonitorAttributes()
Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.java.lang.String
getMonitorDescription()
Retrieves a human-readable description name for this monitor entry.java.lang.String
getMonitorDisplayName()
Retrieves a human-readable display name for this monitor entry.java.lang.Double
getRecentCPUIdlePercent()
Retrieves the percentage of recent CPU idle time, if available.java.lang.Double
getRecentCPUIOWaitPercent()
Retrieves the percentage of recent CPU time spent in the I/O wait state, if available.java.lang.Double
getRecentCPUSystemPercent()
Retrieves the percentage of recent CPU time spent in the system state, if available.java.lang.Double
getRecentCPUTotalBusyPercent()
Retrieves the total percentage of recent CPU time spent in user, system, or I/O wait states, if available.java.lang.Double
getRecentCPUUserPercent()
Retrieves the percentage of recent CPU time spent in the user state, if available.java.lang.Double
getRecentSystemMemoryFreeGB()
Retrieves the recent amount of free system memory in gigabytes, if available.java.lang.Double
getRecentSystemMemoryPercentFree()
Retrieves the recent percentage of free system memory, if available.java.lang.Double
getTotalSystemMemoryGB()
Retrieves the total amount of system memory in gigabytes, if available.java.util.Date
getUpdateTime()
Retrieves the time that the CPU and memory utilization data was last updated, if available.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, decode, getBoolean, getDate, getDN, getDouble, getEntry, getInteger, getLong, getMonitorClass, getMonitorName, getString, getStrings, toString, toString
-
-
-
-
Constructor Detail
-
HostSystemRecentCPUAndMemoryMonitorEntry
public HostSystemRecentCPUAndMemoryMonitorEntry(@NotNull Entry entry)
Creates a new host system recent CPU and memory monitor entry from the provided entry.- Parameters:
entry
- The entry to be parsed as a host system recent CPU and memory monitor entry. It must not benull
.
-
-
Method Detail
-
getUpdateTime
@Nullable public java.util.Date getUpdateTime()
Retrieves the time that the CPU and memory utilization data was last updated, if available.- Returns:
- The time that the CPU and system memory utilization data was
last updated, or
null
if it was not included in the monitor entry.
-
getRecentCPUTotalBusyPercent
@Nullable public java.lang.Double getRecentCPUTotalBusyPercent()
Retrieves the total percentage of recent CPU time spent in user, system, or I/O wait states, if available.- Returns:
- The total percentage of recent CPU time spent in user, system, or
I/O wait states, or
null
if it was not included in the monitor entry.
-
getRecentCPUUserPercent
@Nullable public java.lang.Double getRecentCPUUserPercent()
Retrieves the percentage of recent CPU time spent in the user state, if available.- Returns:
- The percentage of recent CPU time spent in the user state, or
null
if it was not included in the monitor entry.
-
getRecentCPUSystemPercent
@Nullable public java.lang.Double getRecentCPUSystemPercent()
Retrieves the percentage of recent CPU time spent in the system state, if available.- Returns:
- The percentage of recent CPU time spent in the system state, or
null
if it was not included in the monitor entry.
-
getRecentCPUIOWaitPercent
@Nullable public java.lang.Double getRecentCPUIOWaitPercent()
Retrieves the percentage of recent CPU time spent in the I/O wait state, if available.- Returns:
- The percentage of recent CPU time spent in the I/O wait state, or
null
if it was not included in the monitor entry.
-
getRecentCPUIdlePercent
@Nullable public java.lang.Double getRecentCPUIdlePercent()
Retrieves the percentage of recent CPU idle time, if available.- Returns:
- The percentage of recent CPU idle time, or
null
if it was not included in the monitor entry.
-
getTotalSystemMemoryGB
@Nullable public java.lang.Double getTotalSystemMemoryGB()
Retrieves the total amount of system memory in gigabytes, if available.- Returns:
- The total amount of system memory in gigabytes, or
null
if it was not included in the monitor entry.
-
getRecentSystemMemoryFreeGB
@Nullable public java.lang.Double getRecentSystemMemoryFreeGB()
Retrieves the recent amount of free system memory in gigabytes, if available.- Returns:
- The recent amount of free system memory in gigabytes, or
null
if it was not included in the monitor entry.
-
getRecentSystemMemoryPercentFree
@Nullable public java.lang.Double getRecentSystemMemoryPercentFree()
Retrieves the recent percentage of free system memory, if available.- Returns:
- The recent percentage of free system memory, or
null
if it was not included in the monitor entry.
-
getMonitorDisplayName
@NotNull public java.lang.String getMonitorDisplayName()
Retrieves a human-readable display name for this monitor entry.- Overrides:
getMonitorDisplayName
in classMonitorEntry
- Returns:
- A human-readable display name for this monitor entry.
-
getMonitorDescription
@NotNull public java.lang.String getMonitorDescription()
Retrieves a human-readable description name for this monitor entry.- Overrides:
getMonitorDescription
in classMonitorEntry
- Returns:
- A human-readable description name for this monitor entry.
-
getMonitorAttributes
@NotNull public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.- Overrides:
getMonitorAttributes
in classMonitorEntry
- Returns:
- The set of parsed monitor attributes for this monitor entry.
-
-