com.amazonaws.services.applicationsignals.model

Class MetricStat

java.lang.Object

com.amazonaws.services.applicationsignals.model.MetricStat

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

This structure defines the metric to be used as the service level indicator, along with the statistics, period, and unit.

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 use as the service level indicator, including the metric name, namespace, and dimensions.
Integer	getPeriod() The granularity, in seconds, to be used for the metric.
String	getStat() The statistic to use for comparison to the threshold.
String	getUnit() 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.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setMetric(Metric metric) The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
void	setPeriod(Integer period) The granularity, in seconds, to be used for the metric.
void	setStat(String stat) The statistic to use for comparison to the threshold.
void	setUnit(String unit) 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.
String	toString() Returns a string representation of this object.
MetricStat	withMetric(Metric metric) The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
MetricStat	withPeriod(Integer period) The granularity, in seconds, to be used for the metric.
MetricStat	withStat(String stat) The statistic to use for comparison to the threshold.
MetricStat	withUnit(StandardUnit unit) 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.
MetricStat	withUnit(String unit) 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.

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 use as the service level indicator, including the metric name, namespace, and dimensions.

Parameters:

metric - The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

getMetric

public Metric getMetric()

The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

Returns:

The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

withMetric

public MetricStat withMetric(Metric metric)

The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

Parameters:

metric - The metric to use as the service level indicator, 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, to be used for the metric. 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.

Parameters:

period - The granularity, in seconds, to be used for the metric. 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.

getPeriod

public Integer getPeriod()

The granularity, in seconds, to be used for the metric. 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.

Returns:

The granularity, in seconds, to be used for the metric. 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.

withPeriod

public MetricStat withPeriod(Integer period)

The granularity, in seconds, to be used for the metric. 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.

Parameters:

period - The granularity, in seconds, to be used for the metric. 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.

Returns:

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

setStat

public void setStat(String stat)

The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

Parameters:

stat - The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

getStat

public String getStat()

The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

Returns:

The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

withStat

public MetricStat withStat(String stat)

The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

Parameters:

stat - The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

Returns:

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

setUnit

public void setUnit(String unit)

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 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 - 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 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()

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

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

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

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

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.