Class AlarmRecommendation
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AlarmRecommendation.Builder,
AlarmRecommendation>
Defines a recommendation for a CloudWatch alarm.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Deprecated.An alarm recommendation can be attached to multiple Application Components, hence this property will be replaced by the new property 'appComponentNames'.List of Application Component names for the CloudWatch alarm recommendation.static AlarmRecommendation.Builder
builder()
final String
Description of the alarm recommendation.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AppComponentNames property.final int
hashCode()
final boolean
hasItems()
For responses, this returns true if the service returned a value for the Items property.final List
<RecommendationItem> items()
List of CloudWatch alarm recommendations.final String
name()
Name of the alarm recommendation.final String
The prerequisite for the alarm recommendation.final String
Identifier of the alarm recommendation.final RecommendationStatus
Status of the recommended Amazon CloudWatch alarm.final String
Status of the recommended Amazon CloudWatch alarm.final String
Reference identifier of the alarm recommendation.static Class
<? extends AlarmRecommendation.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final AlarmType
type()
Type of alarm recommendation.final String
Type of alarm recommendation.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 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
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
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
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
Name of the alarm recommendation.
- Returns:
- Name of the alarm recommendation.
-
prerequisite
The prerequisite for the alarm recommendation.
- Returns:
- The prerequisite for the alarm recommendation.
-
recommendationId
Identifier of the alarm recommendation.
- Returns:
- Identifier of the alarm recommendation.
-
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 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:
-
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 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:
-
referenceId
Reference identifier of the alarm recommendation.
- Returns:
- Reference identifier of the alarm recommendation.
-
type
Type of alarm recommendation.
If the service returns an enum value that is not available in the current SDK version,
type
will returnAlarmType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Type of alarm recommendation.
- See Also:
-
typeAsString
Type of alarm recommendation.
If the service returns an enum value that is not available in the current SDK version,
type
will returnAlarmType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Type of alarm recommendation.
- See Also:
-
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 interfaceToCopyableBuilder<AlarmRecommendation.Builder,
AlarmRecommendation> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-