com.amazonaws.services.cloudwatch.model

Class MetricStat

java.lang.Object

com.amazonaws.services.cloudwatch.model.MetricStat

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MetricStat
extends Object
implements Serializable, Cloneable

This structure defines the metric to be returned, along with the statistics, period, and units.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetricStat()

Method Summary

Modifier and Type	Method and Description
MetricStat	clone()
boolean	equals(Object obj)
Metric	getMetric() The metric to return, including the metric name, namespace, and dimensions.
Integer	getPeriod() The granularity, in seconds, of the returned data points.
String	getStat() The statistic to return.
String	getUnit() When you are using a Put operation, this defines what unit you want to use when storing the metric.
int	hashCode()
void	setMetric(Metric metric) The metric to return, including the metric name, namespace, and dimensions.
void	setPeriod(Integer period) The granularity, in seconds, of the returned data points.
void	setStat(String stat) The statistic to return.
void	setUnit(String unit) When you are using a Put operation, this defines what unit you want to use when storing the metric.
String	toString() Returns a string representation of this object.
MetricStat	withMetric(Metric metric) The metric to return, including the metric name, namespace, and dimensions.
MetricStat	withPeriod(Integer period) The granularity, in seconds, of the returned data points.
MetricStat	withStat(String stat) The statistic to return.
MetricStat	withUnit(StandardUnit unit) When you are using a Put operation, this defines what unit you want to use when storing the metric.
MetricStat	withUnit(String unit) When you are using a Put operation, this defines what unit you want to use when storing the metric.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetricStat

public MetricStat()

Method Detail

setMetric

public void setMetric(Metric metric)

The metric to return, including the metric name, namespace, and dimensions.

Parameters:

metric - The metric to return, including the metric name, namespace, and dimensions.

getMetric

public Metric getMetric()

The metric to return, including the metric name, namespace, and dimensions.

Returns:

The metric to return, including the metric name, namespace, and dimensions.

withMetric

public MetricStat withMetric(Metric metric)

The metric to return, including the metric name, namespace, and dimensions.

Parameters:

metric - The metric to return, including the metric name, namespace, and dimensions.

Returns:

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

setPeriod

public void setPeriod(Integer period)

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

• Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

• Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

• Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

Parameters:

period - The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

• Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

• Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

• Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

getPeriod

public Integer getPeriod()

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

• Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

• Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

• Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

Returns:

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

• Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

• Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

• Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

withPeriod

public MetricStat withPeriod(Integer period)

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

• Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

• Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

• Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

Parameters:

period - The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

• Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

• Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

• Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

Returns:

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

setStat

public void setStat(String stat)

The statistic to return. It can include any CloudWatch statistic or extended statistic.

Parameters:

stat - The statistic to return. It can include any CloudWatch statistic or extended statistic.

getStat

public String getStat()

The statistic to return. It can include any CloudWatch statistic or extended statistic.

Returns:

The statistic to return. It can include any CloudWatch statistic or extended statistic.

withStat

public MetricStat withStat(String stat)

The statistic to return. It can include any CloudWatch statistic or extended statistic.

Parameters:

stat - The statistic to return. It can include any CloudWatch statistic or extended statistic.

Returns:

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

setUnit

public void setUnit(String unit)

When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Parameters:

unit - When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

See Also:

StandardUnit

getUnit

public String getUnit()

When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Returns:

When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

See Also:

StandardUnit

withUnit

public MetricStat withUnit(String unit)

When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Parameters:

unit - When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Returns:

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

See Also:

StandardUnit

withUnit

public MetricStat withUnit(StandardUnit unit)

When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Parameters:

unit - When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Returns:

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

See Also:

StandardUnit

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public MetricStat clone()

Overrides:

clone in class Object