/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.elasticmapreduce.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* 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 AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CloudWatchAlarmDefinition implements Serializable, Cloneable, StructuredPojo { /** *
* Determines how the metric specified by MetricName
is compared to the value specified by
* Threshold
.
*
* 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
.
*
* The name of the CloudWatch metric that is watched to determine an alarm condition. *
*/ private String metricName; /** *
* The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce
.
*
* 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
.
*
* The statistic to apply to the metric associated with the alarm. The default is AVERAGE
.
*
* The value against which the specified statistic is compared. *
*/ private Double threshold; /** *
* 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.
*
* A CloudWatch metric dimension. *
*/ private com.amazonaws.internal.SdkInternalList
* Determines how the metric specified by MetricName
is compared to the value specified by
* Threshold
.
*
MetricName
is compared to the value specified by
* Threshold
.
* @see ComparisonOperator
*/
public void setComparisonOperator(String comparisonOperator) {
this.comparisonOperator = comparisonOperator;
}
/**
*
* Determines how the metric specified by MetricName
is compared to the value specified by
* Threshold
.
*
MetricName
is compared to the value specified by
* Threshold
.
* @see ComparisonOperator
*/
public String getComparisonOperator() {
return this.comparisonOperator;
}
/**
*
* Determines how the metric specified by MetricName
is compared to the value specified by
* Threshold
.
*
MetricName
is compared to the value specified by
* Threshold
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ComparisonOperator
*/
public CloudWatchAlarmDefinition withComparisonOperator(String comparisonOperator) {
setComparisonOperator(comparisonOperator);
return this;
}
/**
*
* Determines how the metric specified by MetricName
is compared to the value specified by
* Threshold
.
*
MetricName
is compared to the value specified by
* Threshold
.
* @see ComparisonOperator
*/
public void setComparisonOperator(ComparisonOperator comparisonOperator) {
withComparisonOperator(comparisonOperator);
}
/**
*
* Determines how the metric specified by MetricName
is compared to the value specified by
* Threshold
.
*
MetricName
is compared to the value specified by
* Threshold
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ComparisonOperator
*/
public CloudWatchAlarmDefinition withComparisonOperator(ComparisonOperator comparisonOperator) {
this.comparisonOperator = comparisonOperator.toString();
return this;
}
/**
*
* 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
.
*
1
.
*/
public void setEvaluationPeriods(Integer evaluationPeriods) {
this.evaluationPeriods = 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
.
*
1
.
*/
public Integer getEvaluationPeriods() {
return this.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
.
*
1
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CloudWatchAlarmDefinition withEvaluationPeriods(Integer evaluationPeriods) {
setEvaluationPeriods(evaluationPeriods);
return this;
}
/**
* * The name of the CloudWatch metric that is watched to determine an alarm condition. *
* * @param metricName * The name of the CloudWatch metric that is watched to determine an alarm condition. */ public void setMetricName(String metricName) { this.metricName = metricName; } /** ** The name of the CloudWatch metric that is watched to determine an alarm condition. *
* * @return The name of the CloudWatch metric that is watched to determine an alarm condition. */ public String getMetricName() { return this.metricName; } /** ** The name of the CloudWatch metric that is watched to determine an alarm condition. *
* * @param metricName * The name of the CloudWatch metric that is watched to determine an alarm condition. * @return Returns a reference to this object so that method calls can be chained together. */ public CloudWatchAlarmDefinition withMetricName(String metricName) { setMetricName(metricName); return this; } /** *
* The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce
.
*
AWS/ElasticMapReduce
.
*/
public void setNamespace(String namespace) {
this.namespace = namespace;
}
/**
*
* The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce
.
*
AWS/ElasticMapReduce
.
*/
public String getNamespace() {
return this.namespace;
}
/**
*
* The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce
.
*
AWS/ElasticMapReduce
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CloudWatchAlarmDefinition withNamespace(String namespace) {
setNamespace(namespace);
return this;
}
/**
*
* 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
.
*
300
.
*/
public void setPeriod(Integer period) {
this.period = 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
.
*
300
* .
*/
public Integer getPeriod() {
return this.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
.
*
300
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CloudWatchAlarmDefinition withPeriod(Integer period) {
setPeriod(period);
return this;
}
/**
*
* The statistic to apply to the metric associated with the alarm. The default is AVERAGE
.
*
AVERAGE
.
* @see Statistic
*/
public void setStatistic(String statistic) {
this.statistic = statistic;
}
/**
*
* The statistic to apply to the metric associated with the alarm. The default is AVERAGE
.
*
AVERAGE
.
* @see Statistic
*/
public String getStatistic() {
return this.statistic;
}
/**
*
* The statistic to apply to the metric associated with the alarm. The default is AVERAGE
.
*
AVERAGE
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Statistic
*/
public CloudWatchAlarmDefinition withStatistic(String statistic) {
setStatistic(statistic);
return this;
}
/**
*
* The statistic to apply to the metric associated with the alarm. The default is AVERAGE
.
*
AVERAGE
.
* @see Statistic
*/
public void setStatistic(Statistic statistic) {
withStatistic(statistic);
}
/**
*
* The statistic to apply to the metric associated with the alarm. The default is AVERAGE
.
*
AVERAGE
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Statistic
*/
public CloudWatchAlarmDefinition withStatistic(Statistic statistic) {
this.statistic = statistic.toString();
return this;
}
/**
* * The value against which the specified statistic is compared. *
* * @param threshold * The value against which the specified statistic is compared. */ public void setThreshold(Double threshold) { this.threshold = threshold; } /** ** The value against which the specified statistic is compared. *
* * @return The value against which the specified statistic is compared. */ public Double getThreshold() { return this.threshold; } /** ** The value against which the specified statistic is compared. *
* * @param threshold * The value against which the specified statistic is compared. * @return Returns a reference to this object so that method calls can be chained together. */ public CloudWatchAlarmDefinition withThreshold(Double threshold) { setThreshold(threshold); return this; } /** *
* 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.
*
Unit
must correspond to the units specified in the CloudWatch metric.
* @see Unit
*/
public void setUnit(String unit) {
this.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.
*
Unit
must correspond to the units specified in the CloudWatch metric.
* @see Unit
*/
public String getUnit() {
return this.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.
*
Unit
must correspond to the units specified in the CloudWatch metric.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Unit
*/
public CloudWatchAlarmDefinition withUnit(String unit) {
setUnit(unit);
return this;
}
/**
*
* 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.
*
Unit
must correspond to the units specified in the CloudWatch metric.
* @see Unit
*/
public void setUnit(Unit unit) {
withUnit(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.
*
Unit
must correspond to the units specified in the CloudWatch metric.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Unit
*/
public CloudWatchAlarmDefinition withUnit(Unit unit) {
this.unit = unit.toString();
return this;
}
/**
* * A CloudWatch metric dimension. *
* * @return A CloudWatch metric dimension. */ public java.util.List* A CloudWatch metric dimension. *
* * @param dimensions * A CloudWatch metric dimension. */ public void setDimensions(java.util.Collection* A CloudWatch metric dimension. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setDimensions(java.util.Collection)} or {@link #withDimensions(java.util.Collection)} if you want to * override the existing values. *
* * @param dimensions * A CloudWatch metric dimension. * @return Returns a reference to this object so that method calls can be chained together. */ public CloudWatchAlarmDefinition withDimensions(MetricDimension... dimensions) { if (this.dimensions == null) { setDimensions(new com.amazonaws.internal.SdkInternalList* A CloudWatch metric dimension. *
* * @param dimensions * A CloudWatch metric dimension. * @return Returns a reference to this object so that method calls can be chained together. */ public CloudWatchAlarmDefinition withDimensions(java.util.Collection