Package com.unboundid.ldap.sdk.unboundidds.monitors

Class NumericGaugeMonitorEntry

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
com.unboundid.ldap.sdk.unboundidds.monitors.GaugeMonitorEntry
com.unboundid.ldap.sdk.unboundidds.monitors.NumericGaugeMonitorEntry
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class NumericGaugeMonitorEntry extends GaugeMonitorEntry
This class defines a numeric gauge monitor entry, which obtains its information from a 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:

  • Constructor Details

    • NumericGaugeMonitorEntry

      public NumericGaugeMonitorEntry(@NotNull Entry entry)
      Creates a new numeric gauge monitor entry from the provided entry.
      Parameters:
      entry - The entry to be parsed as a numeric gauge monitor entry. It must not be null.

  • Method Details

    • getCurrentValue

      @Nullable public Double 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 Double 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.

    • getMinimumValue

      @Nullable public Double getMinimumValue()
      Retrieves the minimum value observed for the gauge, if available.
      Returns:
      The minimum value observed for the gauge, or null if it was not included in the monitor entry.

    • getMaximumValue

      @Nullable public Double getMaximumValue()
      Retrieves the maximum value observed for the gauge, if available.
      Returns:
      The maximum value observed for the gauge, or null if it was not included in the monitor entry.

    • getObservedValues

      @NotNull public List<Double> 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 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 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 Map<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.