Class MonitoringAlertSummary

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

Provides summary information about a monitor alert.

See Also:

  • Method Details

    • monitoringAlertName

      public final String monitoringAlertName()

      The name of a monitoring alert.

      Returns:
      The name of a monitoring alert.

    • creationTime

      public final Instant creationTime()

      A timestamp that indicates when a monitor alert was created.

      Returns:
      A timestamp that indicates when a monitor alert was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      A timestamp that indicates when a monitor alert was last updated.

      Returns:
      A timestamp that indicates when a monitor alert was last updated.

    • alertStatus

      public final MonitoringAlertStatus alertStatus()

      The current status of an alert.

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

      Returns:
      The current status of an alert.
      See Also:

    • alertStatusAsString

      public final String alertStatusAsString()

      The current status of an alert.

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

      Returns:
      The current status of an alert.
      See Also:

    • datapointsToAlert

      public final Integer datapointsToAlert()

      Within EvaluationPeriod, how many execution failures will raise an alert.

      Returns:
      Within EvaluationPeriod, how many execution failures will raise an alert.

    • evaluationPeriod

      public final Integer evaluationPeriod()

      The number of most recent monitoring executions to consider when evaluating alert status.

      Returns:
      The number of most recent monitoring executions to consider when evaluating alert status.

    • actions

      public final MonitoringAlertActions actions()

      A list of alert actions taken in response to an alert going into InAlert status.

      Returns:
      A list of alert actions taken in response to an alert going into InAlert status.

    • toBuilder

      public MonitoringAlertSummary.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<MonitoringAlertSummary.Builder,MonitoringAlertSummary>
      Returns:
      a builder for type T

    • builder

      public static MonitoringAlertSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MonitoringAlertSummary.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.