Class Alert

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

Full alert entity, returned by both CreateAlert and GetAlert. A create and a read of the same alert describe it identically except for state, which only the read paths populate. UpdateAlert returns an empty response.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the alert.

      Returns:
      The name of the alert.

    • alertId

      public final String alertId()

      The stable alert identifier (see

      invalid reference 
      AlertId
      ), minted on create and immutable across updates. Use it (not name) to address the alert on GetAlert/UpdateAlert/DeleteAlert; it is also the ARN's resource id.

      Returns:
      The stable alert identifier (see
      invalid reference 
      AlertId
      ), minted on create and immutable across updates. Use it (not name) to address the alert on GetAlert/UpdateAlert/DeleteAlert; it is also the ARN's resource id.

    • description

      public final String description()

      An optional description of the alert.

      Returns:
      An optional description of the alert.

    • accountId

      public final String accountId()

      The AWS account ID that owns the alert.

      Returns:
      The AWS account ID that owns the alert.

    • spaceId

      public final String spaceId()

      The ID of the space the alert belongs to.

      Returns:
      The ID of the space the alert belongs to.

    • profileId

      public final String profileId()

      The ID of the access profile associated with the alert.

      Returns:
      The ID of the access profile associated with the alert.

    • rule

      public final Rule rule()

      The rule that defines how the alert is evaluated.

      Returns:
      The rule that defines how the alert is evaluated.

    • notificationStatus

      public final NotificationStatus notificationStatus()

      Whether notifications are enabled.

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

      Returns:
      Whether notifications are enabled.
      See Also:

    • notificationStatusAsString

      public final String notificationStatusAsString()

      Whether notifications are enabled.

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

      Returns:
      Whether notifications are enabled.
      See Also:

    • state

      public final AlertStateInfo state()

      Live evaluation state (read-only, system-managed). Populated by GetAlert. ListAlerts reports state on AlertSummary instead, where it stays required.

      Absent on CreateAlert: a newly created alert has never been evaluated, so any state reported there would be a default rather than an observation. Call GetAlert for live state. Not @required for that reason — GetAlert always populates it.

      contributorSummary is nested inside this member, so it too is absent on CreateAlert.

      Returns:
      Live evaluation state (read-only, system-managed). Populated by GetAlert. ListAlerts reports state on AlertSummary instead, where it stays required.

      Absent on CreateAlert: a newly created alert has never been evaluated, so any state reported there would be a default rather than an observation. Call GetAlert for live state. Not @required for that reason — GetAlert always populates it.

      contributorSummary is nested inside this member, so it too is absent on CreateAlert.

    • hasNotificationRules

      public final boolean hasNotificationRules()
      For responses, this returns true if the service returned a value for the NotificationRules 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.

    • notificationRules

      public final List<NotificationRule> notificationRules()

      The notification rules for the alert.

      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 hasNotificationRules() method.

      Returns:
      The notification rules for the alert.

    • createdAt

      public final Instant createdAt()

      The timestamp when the alert was created.

      Returns:
      The timestamp when the alert was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the alert was last updated.

      Returns:
      The timestamp when the alert was last updated.

    • alertArn

      public final String alertArn()

      The Amazon Resource Name (ARN) of the alert.

      Returns:
      The Amazon Resource Name (ARN) of the alert.

    • toBuilder

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

    • builder

      public static Alert.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.