Class AlarmConfiguration

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

Information about alarms associated with a deployment or deployment group.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      Indicates whether the alarm configuration is enabled.

      Returns:
      Indicates whether the alarm configuration is enabled.

    • ignorePollAlarmFailure

      public final Boolean ignorePollAlarmFailure()

      Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.

      • true: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.

      • false: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.

      Returns:
      Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.

      • true: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.

      • false: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.

    • hasAlarms

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

    • alarms

      public final List<Alarm> alarms()

      A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.

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

      Returns:
      A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.

    • toBuilder

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

    • builder

      public static AlarmConfiguration.Builder builder()

    • serializableBuilderClass

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