Class AlertSummary

java.lang.Object
software.amazon.awssdk.services.lookoutmetrics.model.AlertSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AlertSummary.Builder,AlertSummary>
@Generated("software.amazon.awssdk:codegen") public final class AlertSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AlertSummary.Builder,AlertSummary>

Provides a summary of an alert's configuration.

See Also:

  • Method Details

    • alertArn

      public final String alertArn()

      The ARN of the alert.

      Returns:
      The ARN of the alert.

    • anomalyDetectorArn

      public final String anomalyDetectorArn()

      The ARN of the detector to which the alert is attached.

      Returns:
      The ARN of the detector to which the alert is attached.

    • alertName

      public final String alertName()

      The name of the alert.

      Returns:
      The name of the alert.

    • alertSensitivityThreshold

      public final Integer alertSensitivityThreshold()

      The minimum severity for an anomaly to trigger the alert.

      Returns:
      The minimum severity for an anomaly to trigger the alert.

    • alertType

      public final AlertType alertType()

      The type of the alert.

      If the service returns an enum value that is not available in the current SDK version, alertType will return AlertType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from alertTypeAsString().

      Returns:
      The type of the alert.
      See Also:

    • alertTypeAsString

      public final String alertTypeAsString()

      The type of the alert.

      If the service returns an enum value that is not available in the current SDK version, alertType will return AlertType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from alertTypeAsString().

      Returns:
      The type of the alert.
      See Also:

    • alertStatus

      public final AlertStatus alertStatus()

      The status of the alert.

      If the service returns an enum value that is not available in the current SDK version, alertStatus will return AlertStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from alertStatusAsString().

      Returns:
      The status of the alert.
      See Also:

    • alertStatusAsString

      public final String alertStatusAsString()

      The status of the alert.

      If the service returns an enum value that is not available in the current SDK version, alertStatus will return AlertStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from alertStatusAsString().

      Returns:
      The status of the alert.
      See Also:

    • lastModificationTime

      public final Instant lastModificationTime()

      The time at which the alert was last modified.

      Returns:
      The time at which the alert was last modified.

    • creationTime

      public final Instant creationTime()

      The time at which the alert was created.

      Returns:
      The time at which the alert was created.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      The alert's tags.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The alert's tags.

    • toBuilder

      public AlertSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AlertSummary.Builder,AlertSummary>
      Returns:
      a builder for type T

    • builder

      public static AlertSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AlertSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.