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

Class GaugeMonitorEntry

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    IndicatorGaugeMonitorEntry, NumericGaugeMonitorEntry
    @NotExtensible
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public class GaugeMonitorEntry
extends MonitorEntry
    This class defines the base class for gauge monitor entries, which provide information common to all types of gauges. Subclasses may provide more specific information for that specific type of gauge.
    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 Detail

      • GaugeMonitorEntry

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

    • Method Detail

      • getGaugeName

        @Nullable
public final java.lang.String getGaugeName()
        Retrieves the name for the gauge, if available.
        Returns:
        The name for the gauge, or null if it was not included in the monitor entry.

      • getResource

        @Nullable
public final java.lang.String getResource()
        Retrieves the resource for the gauge, if available.
        Returns:
        The resource for the gauge, or null if it was not included in the monitor entry.

      • getResourceType

        @Nullable
public final java.lang.String getResourceType()
        Retrieves the resource type for the gauge, if available.
        Returns:
        The resource type for the gauge, or null if it was not included in the monitor entry.

      • getCurrentSeverity

        @Nullable
public final AlarmSeverity getCurrentSeverity()
        Retrieves the current severity for the gauge, if available.
        Returns:
        The current severity for the gauge, or null if it was not included in the monitor entry.

      • getPreviousSeverity

        @Nullable
public final AlarmSeverity getPreviousSeverity()
        Retrieves the previous severity for the gauge, if available.
        Returns:
        The previous severity for the gauge, or null if it was not included in the monitor entry.

      • getSummary

        @Nullable
public final java.lang.String getSummary()
        Retrieves the summary message for the gauge, if available.
        Returns:
        The summary message for the gauge, or null if it was not included in the monitor entry.

      • getErrorMessages

        @NotNull
public final java.util.List<java.lang.String> getErrorMessages()
        Retrieves the error messages for the gauge, if available.
        Returns:
        The list of error messages for the gauge, or an empty list if it was not included in the monitor entry.

      • getInitTime

        @Nullable
public final java.util.Date getInitTime()
        Retrieves the time the gauge was initialized, if available.
        Returns:
        The time the gauge was initialized, or null if it was not included in the monitor entry.

      • getUpdateTime

        @Nullable
public final java.util.Date getUpdateTime()
        Retrieves the time the gauge was last updated, if available.
        Returns:
        The time the gauge was last updated, or null if it was not included in the monitor entry.

      • getSamplesThisInterval

        @Nullable
public final java.lang.Long getSamplesThisInterval()
        Retrieves the number of samples taken in the current interval, if available.
        Returns:
        The number of samples taken in the current interval, or null if it was not included in the monitor entry.

      • getCurrentSeverityStartTime

        @Nullable
public final java.util.Date getCurrentSeverityStartTime()
        Retrieves the time the gauge entered the current severity, if available.
        Returns:
        The time the gauge entered the current severity, or null if it was not included in the monitor entry.

      • getCurrentSeverityDurationString

        @Nullable
public final java.lang.String getCurrentSeverityDurationString()
        Retrieves the current severity duration as a human-readable string, if available.
        Returns:
        The current severity duration as a human-readable string, or null if it was not included in the monitor entry.

      • getCurrentSeverityDurationMillis

        @Nullable
public final java.lang.Long getCurrentSeverityDurationMillis()
        Retrieves the current severity duration in milliseconds, if available.
        Returns:
        The current severity duration in milliseconds, or null if it was not included in the monitor entry.

      • getLastNormalStateStartTime

        @Nullable
public final java.util.Date getLastNormalStateStartTime()
        Retrieves the time the gauge last entered the normal state, if available.
        Returns:
        The time the gauge last entered the normal state, or null if it was not included in the monitor entry.

      • getLastNormalStateEndTime

        @Nullable
public final java.util.Date getLastNormalStateEndTime()
        Retrieves the time the gauge last exited the normal state, if available.
        Returns:
        The time the gauge last exited the normal state, or null if it was not included in the monitor entry.

      • getLastNormalStateDurationString

        @Nullable
public final java.lang.String getLastNormalStateDurationString()
        Retrieves the duration of the last normal state as a human-readable string, if available.
        Returns:
        The duration of the last normal state as a human-readable string, or null if it was not included in the monitor entry.

      • getLastNormalStateDurationMillis

        @Nullable
public final java.lang.Long getLastNormalStateDurationMillis()
        Retrieves the duration of the last normal state in milliseconds, if available.
        Returns:
        The duration of the last normal state in milliseconds, or null if it was not included in the monitor entry.

      • getTotalNormalStateDurationString

        @Nullable
public final java.lang.String getTotalNormalStateDurationString()
        Retrieves the total length of time the gauge has been in the normal state as a human-readable string, if available.
        Returns:
        The total length of time the gauge has been in the normal state as a human-readable string, or null if it was not included in the monitor entry.

      • getTotalNormalStateDurationMillis

        @Nullable
public final java.lang.Long getTotalNormalStateDurationMillis()
        Retrieves the total length of time the gauge has been in the normal state in milliseconds, if available.
        Returns:
        The total length of time the gauge has been in the normal state in milliseconds, or null if it was not included in the monitor entry.

      • getLastWarningStateStartTime

        @Nullable
public final java.util.Date getLastWarningStateStartTime()
        Retrieves the time the gauge last entered the warning state, if available.
        Returns:
        The time the gauge last entered the warning state, or null if it was not included in the monitor entry.

      • getLastWarningStateEndTime

        @Nullable
public final java.util.Date getLastWarningStateEndTime()
        Retrieves the time the gauge last exited the warning state, if available.
        Returns:
        The time the gauge last exited the warning state, or null if it was not included in the monitor entry.

      • getLastWarningStateDurationString

        @Nullable
public final java.lang.String getLastWarningStateDurationString()
        Retrieves the duration of the last warning state as a human-readable string, if available.
        Returns:
        The duration of the last warning state as a human-readable string, or null if it was not included in the monitor entry.

      • getLastWarningStateDurationMillis

        @Nullable
public final java.lang.Long getLastWarningStateDurationMillis()
        Retrieves the duration of the last warning state in milliseconds, if available.
        Returns:
        The duration of the last warning state in milliseconds, or null if it was not included in the monitor entry.

      • getTotalWarningStateDurationString

        @Nullable
public final java.lang.String getTotalWarningStateDurationString()
        Retrieves the total length of time the gauge has been in the warning state as a human-readable string, if available.
        Returns:
        The total length of time the gauge has been in the warning state as a human-readable string, or null if it was not included in the monitor entry.

      • getTotalWarningStateDurationMillis

        @Nullable
public final java.lang.Long getTotalWarningStateDurationMillis()
        Retrieves the total length of time the gauge has been in the warning state in milliseconds, if available.
        Returns:
        The total length of time the gauge has been in the warning state in milliseconds, or null if it was not included in the monitor entry.

      • getLastMinorStateStartTime

        @Nullable
public final java.util.Date getLastMinorStateStartTime()
        Retrieves the time the gauge last entered the minor state, if available.
        Returns:
        The time the gauge last entered the minor state, or null if it was not included in the monitor entry.

      • getLastMinorStateEndTime

        @Nullable
public final java.util.Date getLastMinorStateEndTime()
        Retrieves the time the gauge last exited the minor state, if available.
        Returns:
        The time the gauge last exited the minor state, or null if it was not included in the monitor entry.

      • getLastMinorStateDurationString

        @Nullable
public final java.lang.String getLastMinorStateDurationString()
        Retrieves the duration of the last minor state as a human-readable string, if available.
        Returns:
        The duration of the last minor state as a human-readable string, or null if it was not included in the monitor entry.

      • getLastMinorStateDurationMillis

        @Nullable
public final java.lang.Long getLastMinorStateDurationMillis()
        Retrieves the duration of the last minor state in milliseconds, if available.
        Returns:
        The duration of the last minor state in milliseconds, or null if it was not included in the monitor entry.

      • getTotalMinorStateDurationString

        @Nullable
public final java.lang.String getTotalMinorStateDurationString()
        Retrieves the total length of time the gauge has been in the minor state as a human-readable string, if available.
        Returns:
        The total length of time the gauge has been in the minor state as a human-readable string, or null if it was not included in the monitor entry.

      • getTotalMinorStateDurationMillis

        @Nullable
public final java.lang.Long getTotalMinorStateDurationMillis()
        Retrieves the total length of time the gauge has been in the minor state in milliseconds, if available.
        Returns:
        The total length of time the gauge has been in the minor state in milliseconds, or null if it was not included in the monitor entry.

      • getLastMajorStateStartTime

        @Nullable
public final java.util.Date getLastMajorStateStartTime()
        Retrieves the time the gauge last entered the major state, if available.
        Returns:
        The time the gauge last entered the major state, or null if it was not included in the monitor entry.

      • getLastMajorStateEndTime

        @Nullable
public final java.util.Date getLastMajorStateEndTime()
        Retrieves the time the gauge last exited the major state, if available.
        Returns:
        The time the gauge last exited the major state, or null if it was not included in the monitor entry.

      • getLastMajorStateDurationString

        @Nullable
public final java.lang.String getLastMajorStateDurationString()
        Retrieves the duration of the last major state as a human-readable string, if available.
        Returns:
        The duration of the last major state as a human-readable string, or null if it was not included in the monitor entry.

      • getLastMajorStateDurationMillis

        @Nullable
public final java.lang.Long getLastMajorStateDurationMillis()
        Retrieves the duration of the last major state in milliseconds, if available.
        Returns:
        The duration of the last major state in milliseconds, or null if it was not included in the monitor entry.

      • getTotalMajorStateDurationString

        @Nullable
public final java.lang.String getTotalMajorStateDurationString()
        Retrieves the total length of time the gauge has been in the major state as a human-readable string, if available.
        Returns:
        The total length of time the gauge has been in the major state as a human-readable string, or null if it was not included in the monitor entry.

      • getTotalMajorStateDurationMillis

        @Nullable
public final java.lang.Long getTotalMajorStateDurationMillis()
        Retrieves the total length of time the gauge has been in the major state in milliseconds, if available.
        Returns:
        The total length of time the gauge has been in the major state in milliseconds, or null if it was not included in the monitor entry.

      • getLastCriticalStateStartTime

        @Nullable
public final java.util.Date getLastCriticalStateStartTime()
        Retrieves the time the gauge last entered the critical state, if available.
        Returns:
        The time the gauge last entered the critical state, or null if it was not included in the monitor entry.

      • getLastCriticalStateEndTime

        @Nullable
public final java.util.Date getLastCriticalStateEndTime()
        Retrieves the time the gauge last exited the critical state, if available.
        Returns:
        The time the gauge last exited the critical state, or null if it was not included in the monitor entry.

      • getLastCriticalStateDurationString

        @Nullable
public final java.lang.String getLastCriticalStateDurationString()
        Retrieves the duration of the last critical state as a human-readable string, if available.
        Returns:
        The duration of the last critical state as a human-readable string, or null if it was not included in the monitor entry.

      • getLastCriticalStateDurationMillis

        @Nullable
public final java.lang.Long getLastCriticalStateDurationMillis()
        Retrieves the duration of the last critical state in milliseconds, if available.
        Returns:
        The duration of the last critical state in milliseconds, or null if it was not included in the monitor entry.

      • getTotalCriticalStateDurationString

        @Nullable
public final java.lang.String getTotalCriticalStateDurationString()
        Retrieves the total length of time the gauge has been in the critical state as a human-readable string, if available.
        Returns:
        The total length of time the gauge has been in the critical state as a human-readable string, or null if it was not included in the monitor entry.

      • getTotalCriticalStateDurationMillis

        @Nullable
public final java.lang.Long getTotalCriticalStateDurationMillis()
        Retrieves the total length of time the gauge has been in the critical state in milliseconds, if available.
        Returns:
        The total length of time the gauge has been in the critical state in milliseconds, or null if it was not included in the 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 MonitorEntry
        Returns:
        The set of parsed monitor attributes for this monitor entry.