com.unboundid.ldap.sdk.unboundidds.monitors

Class IndicatorGaugeMonitorEntry

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry

com.unboundid.ldap.sdk.unboundidds.monitors.GaugeMonitorEntry

com.unboundid.ldap.sdk.unboundidds.monitors.IndicatorGaugeMonitorEntry

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class IndicatorGaugeMonitorEntry
extends GaugeMonitorEntry

This class defines an indicator gauge monitor entry, which obtains its information from a non-numeric value in a monitor entry.

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 and Description
IndicatorGaugeMonitorEntry(Entry entry) Creates a new indicator gauge monitor entry from the provided entry.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrentValue() Retrieves the current value for the gauge, if available.
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.util.List<java.lang.String>	getObservedValues() Retrieves the set of observed values for the gauge, if available.
java.lang.String	getPreviousValue() Retrieves the previous value for the gauge, if available.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.monitors.GaugeMonitorEntry

getCurrentSeverity, getCurrentSeverityDurationMillis, getCurrentSeverityDurationString, getCurrentSeverityStartTime, getErrorMessages, getGaugeName, getInitTime, getLastCriticalStateDurationMillis, getLastCriticalStateDurationString, getLastCriticalStateEndTime, getLastCriticalStateStartTime, getLastMajorStateDurationMillis, getLastMajorStateDurationString, getLastMajorStateEndTime, getLastMajorStateStartTime, getLastMinorStateDurationMillis, getLastMinorStateDurationString, getLastMinorStateEndTime, getLastMinorStateStartTime, getLastNormalStateDurationMillis, getLastNormalStateDurationString, getLastNormalStateEndTime, getLastNormalStateStartTime, getLastWarningStateDurationMillis, getLastWarningStateDurationString, getLastWarningStateEndTime, getLastWarningStateStartTime, getPreviousSeverity, getResource, getResourceType, getSamplesThisInterval, getSummary, getTotalCriticalStateDurationMillis, getTotalCriticalStateDurationString, getTotalMajorStateDurationMillis, getTotalMajorStateDurationString, getTotalMinorStateDurationMillis, getTotalMinorStateDurationString, getTotalNormalStateDurationMillis, getTotalNormalStateDurationString, getTotalWarningStateDurationMillis, getTotalWarningStateDurationString, getUpdateTime

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IndicatorGaugeMonitorEntry

public IndicatorGaugeMonitorEntry(@NotNull
                                  Entry entry)

Creates a new indicator gauge monitor entry from the provided entry.

Parameters:

entry - The entry to be parsed as a indicator gauge monitor entry. It must not be null.

Method Detail

getCurrentValue

@Nullable
public java.lang.String getCurrentValue()

Retrieves the current value for the gauge, if available.

Returns:

The current value for the gauge, or null if it was not included in the monitor entry.

getPreviousValue

@Nullable
public java.lang.String getPreviousValue()

Retrieves the previous value for the gauge, if available.

Returns:

The previous value for the gauge, or null if it was not included in the monitor entry.

getObservedValues

@NotNull
public java.util.List<java.lang.String> getObservedValues()

Retrieves the set of observed values for the gauge, if available.

Returns:

The set of observed values for the gauge, 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 class GaugeMonitorEntry

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 class GaugeMonitorEntry

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 class GaugeMonitorEntry

Returns:

The set of parsed monitor attributes for this monitor entry.