Package software.amazon.awssdk.services.route53.model

Class CloudWatchAlarmConfiguration

java.lang.Object

software.amazon.awssdk.services.route53.model.CloudWatchAlarmConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CloudWatchAlarmConfiguration.Builder,CloudWatchAlarmConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class CloudWatchAlarmConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CloudWatchAlarmConfiguration.Builder,CloudWatchAlarmConfiguration>

A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CloudWatchAlarmConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static CloudWatchAlarmConfiguration.Builder	builder()
ComparisonOperator	comparisonOperator()	For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.
String	comparisonOperatorAsString()	For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.
List<Dimension>	dimensions()	For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	evaluationPeriods()	For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDimensions()	For responses, this returns true if the service returned a value for the Dimensions property.
int	hashCode()
String	metricName()	The name of the CloudWatch metric that the alarm is associated with.
String	namespace()	The namespace of the metric that the alarm is associated with.
Integer	period()	For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.
List<SdkField<?>>	sdkFields()
static Class<? extends CloudWatchAlarmConfiguration.Builder>	serializableBuilderClass()
Statistic	statistic()	For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
String	statisticAsString()	For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
Double	threshold()	For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.
CloudWatchAlarmConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

evaluationPeriods

public final Integer evaluationPeriods()

For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

Returns:

For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

threshold

public final Double threshold()

For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

Returns:

For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

comparisonOperator

public final ComparisonOperator comparisonOperator()

For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

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

Returns:

For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

See Also:

ComparisonOperator

comparisonOperatorAsString

public final String comparisonOperatorAsString()

For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

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

Returns:

For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

See Also:

ComparisonOperator

period

public final Integer period()

For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.

Returns:

For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.

metricName

public final String metricName()

The name of the CloudWatch metric that the alarm is associated with.

Returns:

The name of the CloudWatch metric that the alarm is associated with.

namespace

public final String namespace()

The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

Returns:

The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

statistic

public final Statistic statistic()

For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

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

Returns:

For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

See Also:

Statistic

statisticAsString

public final String statisticAsString()

For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

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

Returns:

For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

See Also:

Statistic

hasDimensions

public final boolean hasDimensions()

For responses, this returns true if the service returned a value for the Dimensions 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.

dimensions

public final List<Dimension> dimensions()

For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

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

Returns:

For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

toBuilder

public CloudWatchAlarmConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CloudWatchAlarmConfiguration.Builder,CloudWatchAlarmConfiguration>

builder

public static CloudWatchAlarmConfiguration.Builder builder()

serializableBuilderClass

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