com.amazonaws.services.cloudwatch.model

Class GetMetricStatisticsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudwatch.model.GetMetricStatisticsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetMetricStatisticsRequest()

Method Summary

Modifier and Type	Method and Description
GetMetricStatisticsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<Dimension>	getDimensions() The dimensions.
Date	getEndTime() The time stamp that determines the last data point to return.
List<String>	getExtendedStatistics() The percentile statistics.
String	getMetricName() The name of the metric, with or without spaces.
String	getNamespace() The namespace of the metric, with or without spaces.
Integer	getPeriod() The granularity, in seconds, of the returned data points.
Date	getStartTime() The time stamp that determines the first data point to return.
List<String>	getStatistics() The metric statistics, other than percentile.
String	getUnit() The unit for a given metric.
int	hashCode()
void	setDimensions(Collection<Dimension> dimensions) The dimensions.
void	setEndTime(Date endTime) The time stamp that determines the last data point to return.
void	setExtendedStatistics(Collection<String> extendedStatistics) The percentile statistics.
void	setMetricName(String metricName) The name of the metric, with or without spaces.
void	setNamespace(String namespace) The namespace of the metric, with or without spaces.
void	setPeriod(Integer period) The granularity, in seconds, of the returned data points.
void	setStartTime(Date startTime) The time stamp that determines the first data point to return.
void	setStatistics(Collection<String> statistics) The metric statistics, other than percentile.
void	setUnit(StandardUnit unit) The unit for a given metric.
void	setUnit(String unit) The unit for a given metric.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetMetricStatisticsRequest	withDimensions(Collection<Dimension> dimensions) The dimensions.
GetMetricStatisticsRequest	withDimensions(Dimension... dimensions) The dimensions.
GetMetricStatisticsRequest	withEndTime(Date endTime) The time stamp that determines the last data point to return.
GetMetricStatisticsRequest	withExtendedStatistics(Collection<String> extendedStatistics) The percentile statistics.
GetMetricStatisticsRequest	withExtendedStatistics(String... extendedStatistics) The percentile statistics.
GetMetricStatisticsRequest	withMetricName(String metricName) The name of the metric, with or without spaces.
GetMetricStatisticsRequest	withNamespace(String namespace) The namespace of the metric, with or without spaces.
GetMetricStatisticsRequest	withPeriod(Integer period) The granularity, in seconds, of the returned data points.
GetMetricStatisticsRequest	withStartTime(Date startTime) The time stamp that determines the first data point to return.
GetMetricStatisticsRequest	withStatistics(Collection<String> statistics) The metric statistics, other than percentile.
GetMetricStatisticsRequest	withStatistics(Statistic... statistics) The metric statistics, other than percentile.
GetMetricStatisticsRequest	withStatistics(String... statistics) The metric statistics, other than percentile.
GetMetricStatisticsRequest	withUnit(StandardUnit unit) The unit for a given metric.
GetMetricStatisticsRequest	withUnit(String unit) The unit for a given metric.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetMetricStatisticsRequest

public GetMetricStatisticsRequest()

Method Detail

setNamespace

public void setNamespace(String namespace)

The namespace of the metric, with or without spaces.

Parameters:

namespace - The namespace of the metric, with or without spaces.

getNamespace

public String getNamespace()

The namespace of the metric, with or without spaces.

Returns:

The namespace of the metric, with or without spaces.

withNamespace

public GetMetricStatisticsRequest withNamespace(String namespace)

The namespace of the metric, with or without spaces.

Parameters:

namespace - The namespace of the metric, with or without spaces.

Returns:

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

setMetricName

public void setMetricName(String metricName)

The name of the metric, with or without spaces.

Parameters:

metricName - The name of the metric, with or without spaces.

getMetricName

public String getMetricName()

The name of the metric, with or without spaces.

Returns:

The name of the metric, with or without spaces.

withMetricName

public GetMetricStatisticsRequest withMetricName(String metricName)

The name of the metric, with or without spaces.

Parameters:

metricName - The name of the metric, with or without spaces.

Returns:

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

getDimensions

public List<Dimension> getDimensions()

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information on specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Returns:

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information on specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

setDimensions

public void setDimensions(Collection<Dimension> dimensions)

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information on specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Parameters:

dimensions - The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information on specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

withDimensions

public GetMetricStatisticsRequest withDimensions(Dimension... dimensions)

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information on specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

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.

Parameters:

dimensions - The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information on specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Returns:

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

withDimensions

public GetMetricStatisticsRequest withDimensions(Collection<Dimension> dimensions)

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information on specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Parameters:

dimensions - The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information on specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Returns:

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

setStartTime

public void setStartTime(Date startTime)

The time stamp that determines the first data point to return. Note that start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

• Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

• Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

• Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

Parameters:

startTime - The time stamp that determines the first data point to return. Note that start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

• Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

• Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

• Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

getStartTime

public Date getStartTime()

The time stamp that determines the first data point to return. Note that start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

• Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

• Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

• Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

Returns:

The time stamp that determines the first data point to return. Note that start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

• Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

• Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

• Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

withStartTime

public GetMetricStatisticsRequest withStartTime(Date startTime)

The time stamp that determines the first data point to return. Note that start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

• Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

• Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

• Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

Parameters:

startTime - The time stamp that determines the first data point to return. Note that start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

• Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

• Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

• Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

Returns:

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

setEndTime

public void setEndTime(Date endTime)

The time stamp that determines the last data point to return.

The value specified is exclusive; results will include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

Parameters:

endTime - The time stamp that determines the last data point to return.

The value specified is exclusive; results will include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

getEndTime

public Date getEndTime()

The time stamp that determines the last data point to return.

The value specified is exclusive; results will include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

Returns:

The time stamp that determines the last data point to return.

The value specified is exclusive; results will include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

withEndTime

public GetMetricStatisticsRequest withEndTime(Date endTime)

The time stamp that determines the last data point to return.

The value specified is exclusive; results will include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

Parameters:

endTime - The time stamp that determines the last data point to return.

The value specified is exclusive; results will include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

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. A period can be as short as one minute (60 seconds) and must be a multiple of 60. The default value is 60.

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

• 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. A period can be as short as one minute (60 seconds) and must be a multiple of 60. The default value is 60.

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

• 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. A period can be as short as one minute (60 seconds) and must be a multiple of 60. The default value is 60.

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

• 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. A period can be as short as one minute (60 seconds) and must be a multiple of 60. The default value is 60.

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

• 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 GetMetricStatisticsRequest withPeriod(Integer period)

The granularity, in seconds, of the returned data points. A period can be as short as one minute (60 seconds) and must be a multiple of 60. The default value is 60.

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

• 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. A period can be as short as one minute (60 seconds) and must be a multiple of 60. The default value is 60.

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

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

getStatistics

public List<String> getStatistics()

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic.

Returns:

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic.

See Also:

Statistic

setStatistics

public void setStatistics(Collection<String> statistics)

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic.

Parameters:

statistics - The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic.

See Also:

Statistic

withStatistics

public GetMetricStatisticsRequest withStatistics(String... statistics)

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic.

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

Parameters:

statistics - The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic.

Returns:

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

See Also:

Statistic

withStatistics

public GetMetricStatisticsRequest withStatistics(Collection<String> statistics)

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic.

Parameters:

statistics - The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic.

Returns:

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

See Also:

Statistic

withStatistics

public GetMetricStatisticsRequest withStatistics(Statistic... statistics)

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic.

Parameters:

statistics - The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic.

Returns:

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

See Also:

Statistic

getExtendedStatistics

public List<String> getExtendedStatistics()

The percentile statistics. Specify values between p0.0 and p100.

Returns:

The percentile statistics. Specify values between p0.0 and p100.

setExtendedStatistics

public void setExtendedStatistics(Collection<String> extendedStatistics)

The percentile statistics. Specify values between p0.0 and p100.

Parameters:

extendedStatistics - The percentile statistics. Specify values between p0.0 and p100.

withExtendedStatistics

public GetMetricStatisticsRequest withExtendedStatistics(String... extendedStatistics)

The percentile statistics. Specify values between p0.0 and p100.

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

Parameters:

extendedStatistics - The percentile statistics. Specify values between p0.0 and p100.

Returns:

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

withExtendedStatistics

public GetMetricStatisticsRequest withExtendedStatistics(Collection<String> extendedStatistics)

The percentile statistics. Specify values between p0.0 and p100.

Parameters:

extendedStatistics - The percentile statistics. Specify values between p0.0 and p100.

Returns:

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

setUnit

public void setUnit(String unit)

The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.

Parameters:

unit - The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.

See Also:

StandardUnit

getUnit

public String getUnit()

The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.

Returns:

The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.

See Also:

StandardUnit

withUnit

public GetMetricStatisticsRequest withUnit(String unit)

The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.

Parameters:

unit - The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.

Returns:

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

See Also:

StandardUnit

setUnit

public void setUnit(StandardUnit unit)

The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.

Parameters:

unit - The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.

See Also:

StandardUnit

withUnit

public GetMetricStatisticsRequest withUnit(StandardUnit unit)

The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.

Parameters:

unit - The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.

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; useful for testing and debugging.

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()