com.amazonaws.services.cloudwatch.model

Class DescribeAlarmsForMetricRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeAlarmsForMetricRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeAlarmsForMetric operation.

Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.

See Also:

AmazonCloudWatch.describeAlarmsForMetric(DescribeAlarmsForMetricRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeAlarmsForMetricRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeAlarmsForMetricRequest	clone()
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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeAlarmsForMetricRequest

public DescribeAlarmsForMetricRequest()

Method Detail

getMetricName

public String getMetricName()

The name of the metric.

Constraints:
Length: 1 - 255

Returns:

The name of the metric.

setMetricName

public void setMetricName(String metricName)

The name of the metric.

Constraints:
Length: 1 - 255

Parameters:

metricName - The name of the metric.

withMetricName

public DescribeAlarmsForMetricRequest withMetricName(String metricName)

The name of the metric.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255

Parameters:

metricName - The name of the metric.

Returns:

A reference to this updated object so that method calls can be chained together.

getNamespace

public String getNamespace()

The namespace of the metric.

Constraints:
Length: 1 - 255
Pattern: [^:].*

Returns:

The namespace of the metric.

setNamespace

public void setNamespace(String namespace)

The namespace of the metric.

Constraints:
Length: 1 - 255
Pattern: [^:].*

Parameters:

namespace - The namespace of the metric.

withNamespace

public DescribeAlarmsForMetricRequest withNamespace(String namespace)

The namespace of the metric.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255
Pattern: [^:].*

Parameters:

namespace - The namespace of the metric.

Returns:

A reference to this updated object so that method calls can be chained together.

getStatistic

public String getStatistic()

The statistic for the metric.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

Returns:

The statistic for the metric.

See Also:

Statistic

setStatistic

public void setStatistic(String statistic)

The statistic for the metric.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

Parameters:

statistic - The statistic for the metric.

See Also:

Statistic

withStatistic

public DescribeAlarmsForMetricRequest withStatistic(String statistic)

The statistic for the metric.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

Parameters:

statistic - The statistic for the metric.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Statistic

setStatistic

public void setStatistic(Statistic statistic)

The statistic for the metric.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

Parameters:

statistic - The statistic for the metric.

See Also:

Statistic

withStatistic

public DescribeAlarmsForMetricRequest withStatistic(Statistic statistic)

The statistic for the metric.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

Parameters:

statistic - The statistic for the metric.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Statistic

getDimensions

public List<Dimension> getDimensions()

The list of dimensions associated with the metric.

Constraints:
Length: 0 - 10

Returns:

The list of dimensions associated with the metric.

setDimensions

public void setDimensions(Collection<Dimension> dimensions)

The list of dimensions associated with the metric.

Constraints:
Length: 0 - 10

Parameters:

dimensions - The list of dimensions associated with the metric.

withDimensions

public DescribeAlarmsForMetricRequest withDimensions(Dimension... dimensions)

The list of dimensions associated with the metric.

NOTE: This method appends the values to the existing list (if any). Use setDimensions(java.util.Collection) or withDimensions(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 10

Parameters:

dimensions - The list of dimensions associated with the metric.

Returns:

A reference to this updated object so that method calls can be chained together.

withDimensions

public DescribeAlarmsForMetricRequest withDimensions(Collection<Dimension> dimensions)

The list of dimensions associated with the metric.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 10

Parameters:

dimensions - The list of dimensions associated with the metric.

Returns:

A reference to this updated object so that method calls can be chained together.

getPeriod

public Integer getPeriod()

The period in seconds over which the statistic is applied.

Constraints:
Range: 60 -

Returns:

The period in seconds over which the statistic is applied.

setPeriod

public void setPeriod(Integer period)

The period in seconds over which the statistic is applied.

Constraints:
Range: 60 -

Parameters:

period - The period in seconds over which the statistic is applied.

withPeriod

public DescribeAlarmsForMetricRequest withPeriod(Integer period)

The period in seconds over which the statistic is applied.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 60 -

Parameters:

period - The period in seconds over which the statistic is applied.

Returns:

A reference to this updated object so that method calls can be chained together.

getUnit

public String getUnit()

The unit for the metric.

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

Returns:

The unit for the metric.

See Also:

StandardUnit

setUnit

public void setUnit(String unit)

The unit for the metric.

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

Parameters:

unit - The unit for the metric.

See Also:

StandardUnit

withUnit

public DescribeAlarmsForMetricRequest withUnit(String unit)

The unit for the metric.

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

Parameters:

unit - The unit for the metric.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StandardUnit

setUnit

public void setUnit(StandardUnit unit)

The unit for the metric.

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

Parameters:

unit - The unit for the metric.

See Also:

StandardUnit

withUnit

public DescribeAlarmsForMetricRequest withUnit(StandardUnit unit)

The unit for the metric.

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

Parameters:

unit - The unit for the metric.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StandardUnit

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeAlarmsForMetricRequest clone()

Overrides:

clone in class AmazonWebServiceRequest