public class DescribeAlarmsForMetricRequest extends AmazonWebServiceRequest implements Serializable
DescribeAlarmsForMetric operation
.
Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
NOOP
Constructor and Description |
---|
DescribeAlarmsForMetricRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
List<Dimension> |
getDimensions()
The list of dimensions associated with the metric.
|
String |
getMetricName()
The name of the metric.
|
String |
getNamespace()
The namespace of the metric.
|
Integer |
getPeriod()
The period in seconds over which the statistic is applied.
|
String |
getStatistic()
The statistic for the metric.
|
String |
getUnit()
The unit for the metric.
|
int |
hashCode() |
void |
setDimensions(Collection<Dimension> dimensions)
The list of dimensions associated with the metric.
|
void |
setMetricName(String metricName)
The name of the metric.
|
void |
setNamespace(String namespace)
The namespace of the metric.
|
void |
setPeriod(Integer period)
The period in seconds over which the statistic is applied.
|
void |
setStatistic(Statistic statistic)
The statistic for the metric.
|
void |
setStatistic(String statistic)
The statistic for the metric.
|
void |
setUnit(StandardUnit unit)
The unit for the metric.
|
void |
setUnit(String unit)
The unit for the metric.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeAlarmsForMetricRequest |
withDimensions(Collection<Dimension> dimensions)
The list of dimensions associated with the metric.
|
DescribeAlarmsForMetricRequest |
withDimensions(Dimension... dimensions)
The list of dimensions associated with the metric.
|
DescribeAlarmsForMetricRequest |
withMetricName(String metricName)
The name of the metric.
|
DescribeAlarmsForMetricRequest |
withNamespace(String namespace)
The namespace of the metric.
|
DescribeAlarmsForMetricRequest |
withPeriod(Integer period)
The period in seconds over which the statistic is applied.
|
DescribeAlarmsForMetricRequest |
withStatistic(Statistic statistic)
The statistic for the metric.
|
DescribeAlarmsForMetricRequest |
withStatistic(String statistic)
The statistic for the metric.
|
DescribeAlarmsForMetricRequest |
withUnit(StandardUnit unit)
The unit for the metric.
|
DescribeAlarmsForMetricRequest |
withUnit(String unit)
The unit for the metric.
|
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getMetricName()
Constraints:
Length: 1 - 255
public void setMetricName(String metricName)
Constraints:
Length: 1 - 255
metricName
- The name of the metric.public DescribeAlarmsForMetricRequest withMetricName(String metricName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
metricName
- The name of the metric.public String getNamespace()
Constraints:
Length: 1 - 255
Pattern: [^:].*
public void setNamespace(String namespace)
Constraints:
Length: 1 - 255
Pattern: [^:].*
namespace
- The namespace of the metric.public DescribeAlarmsForMetricRequest withNamespace(String namespace)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
Pattern: [^:].*
namespace
- The namespace of the metric.public String getStatistic()
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
Statistic
public void setStatistic(String statistic)
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
statistic
- The statistic for the metric.Statistic
public DescribeAlarmsForMetricRequest withStatistic(String statistic)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
statistic
- The statistic for the metric.Statistic
public void setStatistic(Statistic statistic)
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
statistic
- The statistic for the metric.Statistic
public DescribeAlarmsForMetricRequest withStatistic(Statistic statistic)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
statistic
- The statistic for the metric.Statistic
public List<Dimension> getDimensions()
Constraints:
Length: 0 - 10
public void setDimensions(Collection<Dimension> dimensions)
Constraints:
Length: 0 - 10
dimensions
- The list of dimensions associated with the metric.public DescribeAlarmsForMetricRequest withDimensions(Dimension... dimensions)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 10
dimensions
- The list of dimensions associated with the metric.public DescribeAlarmsForMetricRequest withDimensions(Collection<Dimension> dimensions)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 10
dimensions
- The list of dimensions associated with the metric.public Integer getPeriod()
Constraints:
Range: 60 -
public void setPeriod(Integer period)
Constraints:
Range: 60 -
period
- The period in seconds over which the statistic is applied.public DescribeAlarmsForMetricRequest withPeriod(Integer period)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 60 -
period
- The period in seconds over which the statistic is applied.public String getUnit()
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
StandardUnit
public void setUnit(String unit)
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
unit
- The unit for the metric.StandardUnit
public DescribeAlarmsForMetricRequest withUnit(String unit)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
unit
- The unit for the metric.StandardUnit
public void setUnit(StandardUnit unit)
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
unit
- The unit for the metric.StandardUnit
public DescribeAlarmsForMetricRequest withUnit(StandardUnit unit)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
unit
- The unit for the metric.StandardUnit
public String toString()
toString
in class Object
Object.toString()
Copyright © 2015. All rights reserved.