Package software.amazon.awssdk.services.resiliencehub.model

Class AlarmRecommendation

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

Defines a recommendation for a CloudWatch alarm.

See Also:

  • Method Details

    • appComponentName

      @Deprecated public final String appComponentName()
      Deprecated.
      An alarm recommendation can be attached to multiple Application Components, hence this property will be replaced by the new property 'appComponentNames'.

      Application Component name for the CloudWatch alarm recommendation. This name is saved as the first item in the appComponentNames list.

      Returns:
      Application Component name for the CloudWatch alarm recommendation. This name is saved as the first item in the appComponentNames list.

    • hasAppComponentNames

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

    • appComponentNames

      public final List<String> appComponentNames()

      List of Application Component names for the CloudWatch alarm recommendation.

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

      Returns:
      List of Application Component names for the CloudWatch alarm recommendation.

    • description

      public final String description()

      Description of the alarm recommendation.

      Returns:
      Description of the alarm recommendation.

    • hasItems

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

    • items

      public final List<RecommendationItem> items()

      List of CloudWatch alarm recommendations.

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

      Returns:
      List of CloudWatch alarm recommendations.

    • name

      public final String name()

      Name of the alarm recommendation.

      Returns:
      Name of the alarm recommendation.

    • prerequisite

      public final String prerequisite()

      The prerequisite for the alarm recommendation.

      Returns:
      The prerequisite for the alarm recommendation.

    • recommendationId

      public final String recommendationId()

      Identifier of the alarm recommendation.

      Returns:
      Identifier of the alarm recommendation.

    • recommendationStatus

      public final RecommendationStatus recommendationStatus()

      Status of the recommended Amazon CloudWatch alarm.

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

      Returns:
      Status of the recommended Amazon CloudWatch alarm.
      See Also:

    • recommendationStatusAsString

      public final String recommendationStatusAsString()

      Status of the recommended Amazon CloudWatch alarm.

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

      Returns:
      Status of the recommended Amazon CloudWatch alarm.
      See Also:

    • referenceId

      public final String referenceId()

      Reference identifier of the alarm recommendation.

      Returns:
      Reference identifier of the alarm recommendation.

    • type

      public final AlarmType type()

      Type of alarm recommendation.

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

      Returns:
      Type of alarm recommendation.
      See Also:

    • typeAsString

      public final String typeAsString()

      Type of alarm recommendation.

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

      Returns:
      Type of alarm recommendation.
      See Also:

    • toBuilder

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

    • builder

      public static AlarmRecommendation.Builder builder()

    • serializableBuilderClass

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