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(value="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 and Description
static interface	AlarmRecommendation.Builder

Method Summary

Modifier and Type	Method and Description
String	appComponentName() 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.Builder	builder()
String	description() Description of the alarm recommendation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAppComponentNames() For responses, this returns true if the service returned a value for the AppComponentNames property.
int	hashCode()
boolean	hasItems() For responses, this returns true if the service returned a value for the Items property.
List<RecommendationItem>	items() List of CloudWatch alarm recommendations.
String	name() Name of the alarm recommendation.
String	prerequisite() The prerequisite for the alarm recommendation.
String	recommendationId() Identifier of the alarm recommendation.
String	referenceId() Reference identifier of the alarm recommendation.
List<SdkField<?>>	sdkFields()
static Class<? extends AlarmRecommendation.Builder>	serializableBuilderClass()
AlarmRecommendation.Builder	toBuilder()
String	toString() Returns a string representation of this object.
AlarmType	type() Type of alarm recommendation.
String	typeAsString() 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 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.

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:

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, 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:

AlarmType

toBuilder

public AlarmRecommendation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AlarmRecommendation.Builder,AlarmRecommendation>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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