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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAlarmRecommendation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description StringappComponentName()Deprecated.An alarm recommendation can be attached to multiple Application Components, hence this property will be replaced by the new property 'appComponentNames'.List<String>appComponentNames()List of Application Component names for the CloudWatch alarm recommendation.static AlarmRecommendation.Builderbuilder()Stringdescription()Description of the alarm recommendation.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAppComponentNames()For responses, this returns true if the service returned a value for the AppComponentNames property.inthashCode()booleanhasItems()For responses, this returns true if the service returned a value for the Items property.List<RecommendationItem>items()List of CloudWatch alarm recommendations.Stringname()Name of the alarm recommendation.Stringprerequisite()The prerequisite for the alarm recommendation.StringrecommendationId()Identifier of the alarm recommendation.RecommendationStatusrecommendationStatus()Status of the recommended Amazon CloudWatch alarm.StringrecommendationStatusAsString()Status of the recommended Amazon CloudWatch alarm.StringreferenceId()Reference identifier of the alarm recommendation.List<SdkField<?>>sdkFields()static Class<? extends AlarmRecommendation.Builder>serializableBuilderClass()AlarmRecommendation.BuildertoBuilder()StringtoString()Returns a string representation of this object.AlarmTypetype()Type of alarm recommendation.StringtypeAsString()Type of alarm recommendation.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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
appComponentNameslist.- Returns:
- Application Component name for the CloudWatch alarm recommendation. This name is saved as the first item
in the
appComponentNameslist.
-
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 theisEmpty()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 theisEmpty()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,
recommendationStatuswill returnRecommendationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrecommendationStatusAsString().- Returns:
- Status of the recommended Amazon CloudWatch alarm.
- See Also:
RecommendationStatus
-
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,
recommendationStatuswill returnRecommendationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrecommendationStatusAsString().- Returns:
- Status of the recommended Amazon CloudWatch alarm.
- See Also:
RecommendationStatus
-
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,
typewill returnAlarmType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- Type of alarm recommendation.
- See Also:
AlarmType
-
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,
typewill returnAlarmType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- Type of alarm recommendation.
- See Also:
AlarmType
-
toBuilder
public AlarmRecommendation.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AlarmRecommendation.Builder,AlarmRecommendation>
-
builder
public static AlarmRecommendation.Builder builder()
-
serializableBuilderClass
public static Class<? extends AlarmRecommendation.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-