software.amazon.awssdk.services.emr.model

Class CloudWatchAlarmDefinition

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<CloudWatchAlarmDefinition.Builder,CloudWatchAlarmDefinition>

@Generated(value="software.amazon.awssdk:codegen")
public class CloudWatchAlarmDefinition
extends Object
implements StructuredPojo, 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CloudWatchAlarmDefinition.Builder

Method Summary

Modifier and Type	Method and 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)
Integer	evaluationPeriods() The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
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.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

comparisonOperator

public 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 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 Integer evaluationPeriods()

The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

Returns:

The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

metricName

public 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 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 Integer period()

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

Returns:

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

statistic

public 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 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 Double threshold()

The value against which the specified statistic is compared.

Returns:

The value against which the specified statistic is compared.

unit

public 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 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

dimensions

public List<MetricDimension> dimensions()

A CloudWatch metric dimension.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A CloudWatch metric dimension.

toBuilder

public CloudWatchAlarmDefinition.Builder 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 interface ToCopyableBuilder<CloudWatchAlarmDefinition.Builder,CloudWatchAlarmDefinition>

Returns:

a builder for type T

builder

public static CloudWatchAlarmDefinition.Builder builder()

serializableBuilderClass

public static Class<? extends CloudWatchAlarmDefinition.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.