Package software.amazon.awssdk.services.emr.model

Class CloudWatchAlarmDefinition

java.lang.Object

software.amazon.awssdk.services.emr.model.CloudWatchAlarmDefinition

All Implemented Interfaces:

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

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

The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CloudWatchAlarmDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static CloudWatchAlarmDefinition.Builder	builder()
ComparisonOperator	comparisonOperator()	Determines how the metric specified by MetricName is compared to the value specified by Threshold.
String	comparisonOperatorAsString()	Determines how the metric specified by MetricName is compared to the value specified by Threshold.
List<MetricDimension>	dimensions()	A CloudWatch metric dimension.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	evaluationPeriods()	The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity.
<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 is watched to determine an alarm condition.
String	namespace()	The namespace for the CloudWatch metric.
Integer	period()	The period, in seconds, over which the statistic is applied.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CloudWatchAlarmDefinition.Builder>	serializableBuilderClass()
Statistic	statistic()	The statistic to apply to the metric associated with the alarm.
String	statisticAsString()	The statistic to apply to the metric associated with the alarm.
Double	threshold()	The value against which the specified statistic is compared.
CloudWatchAlarmDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Unit	unit()	The unit of measure associated with the CloudWatch metric being watched.
String	unitAsString()	The unit of measure associated with the CloudWatch metric being watched.

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

comparisonOperator

public final ComparisonOperator comparisonOperator()

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

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:

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

See Also:

ComparisonOperator

comparisonOperatorAsString

public final String comparisonOperatorAsString()

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

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:

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

See Also:

ComparisonOperator

evaluationPeriods

public final Integer evaluationPeriods()

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

Returns:

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

metricName

public final String metricName()

The name of the CloudWatch metric that is watched to determine an alarm condition.

Returns:

The name of the CloudWatch metric that is watched to determine an alarm condition.

namespace

public final String namespace()

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

Returns:

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

period

public final Integer period()

The period, in seconds, over which the statistic is applied. CloudWatch metrics for Amazon EMR are emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify 300.

Returns:

The period, in seconds, over which the statistic is applied. CloudWatch metrics for Amazon EMR are emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify 300 .

statistic

public final Statistic statistic()

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

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:

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

See Also:

Statistic

statisticAsString

public final String statisticAsString()

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

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:

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

See Also:

Statistic

threshold

public final Double threshold()

The value against which the specified statistic is compared.

Returns:

The value against which the specified statistic is compared.

unit

public final Unit unit()

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

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

Returns:

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

See Also:

Unit

unitAsString

public final String unitAsString()

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

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

Returns:

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

See Also:

Unit

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<MetricDimension> dimensions()

A CloudWatch metric dimension.

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:

A CloudWatch metric dimension.

toBuilder

public CloudWatchAlarmDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CloudWatchAlarmDefinition.Builder,CloudWatchAlarmDefinition>

builder

public static CloudWatchAlarmDefinition.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo