public class GetMetricStatisticsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Describes the inputs for GetMetricStatistics.
NOOP
Constructor and Description |
---|
GetMetricStatisticsRequest() |
Modifier and Type | Method and Description |
---|---|
GetMetricStatisticsRequest |
clone() |
boolean |
equals(Object obj) |
List<Dimension> |
getDimensions()
A list of dimensions describing qualities of the metric.
|
Date |
getEndTime()
The time stamp to use for determining the last datapoint to return.
|
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 datapoints.
|
Date |
getStartTime()
The time stamp to use for determining the first datapoint to return.
|
List<String> |
getStatistics()
The metric statistics to return.
|
String |
getUnit()
The specific unit for a given metric.
|
int |
hashCode() |
void |
setDimensions(Collection<Dimension> dimensions)
A list of dimensions describing qualities of the metric.
|
void |
setEndTime(Date endTime)
The time stamp to use for determining the last datapoint to return.
|
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 datapoints.
|
void |
setStartTime(Date startTime)
The time stamp to use for determining the first datapoint to return.
|
void |
setStatistics(Collection<String> statistics)
The metric statistics to return.
|
void |
setUnit(StandardUnit unit)
The specific unit for a given metric.
|
void |
setUnit(String unit)
The specific unit for a given metric.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GetMetricStatisticsRequest |
withDimensions(Collection<Dimension> dimensions)
A list of dimensions describing qualities of the metric.
|
GetMetricStatisticsRequest |
withDimensions(Dimension... dimensions)
A list of dimensions describing qualities of the metric.
|
GetMetricStatisticsRequest |
withEndTime(Date endTime)
The time stamp to use for determining the last datapoint to return.
|
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 datapoints.
|
GetMetricStatisticsRequest |
withStartTime(Date startTime)
The time stamp to use for determining the first datapoint to return.
|
GetMetricStatisticsRequest |
withStatistics(Collection<String> statistics)
The metric statistics to return.
|
GetMetricStatisticsRequest |
withStatistics(Statistic... statistics)
The metric statistics to return.
|
GetMetricStatisticsRequest |
withStatistics(String... statistics)
The metric statistics to return.
|
GetMetricStatisticsRequest |
withUnit(StandardUnit unit)
The specific unit for a given metric.
|
GetMetricStatisticsRequest |
withUnit(String unit)
The specific unit for a given metric.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setNamespace(String namespace)
The namespace of the metric, with or without spaces.
namespace
- The namespace of the metric, with or without spaces.public String getNamespace()
The namespace of the metric, with or without spaces.
public GetMetricStatisticsRequest withNamespace(String namespace)
The namespace of the metric, with or without spaces.
namespace
- The namespace of the metric, with or without spaces.public void setMetricName(String metricName)
The name of the metric, with or without spaces.
metricName
- The name of the metric, with or without spaces.public String getMetricName()
The name of the metric, with or without spaces.
public GetMetricStatisticsRequest withMetricName(String metricName)
The name of the metric, with or without spaces.
metricName
- The name of the metric, with or without spaces.public List<Dimension> getDimensions()
A list of dimensions describing qualities of the metric.
public void setDimensions(Collection<Dimension> dimensions)
A list of dimensions describing qualities of the metric.
dimensions
- A list of dimensions describing qualities of the metric.public GetMetricStatisticsRequest withDimensions(Dimension... dimensions)
A list of dimensions describing qualities of 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.
dimensions
- A list of dimensions describing qualities of the metric.public GetMetricStatisticsRequest withDimensions(Collection<Dimension> dimensions)
A list of dimensions describing qualities of the metric.
dimensions
- A list of dimensions describing qualities of the metric.public void setStartTime(Date startTime)
The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
The specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks.
Data that is timestamped 24 hours or more in the past may take in excess
of 48 hours to become available from submission time using
GetMetricStatistics
.
startTime
- The time stamp to use for determining the first datapoint to
return. The value specified is inclusive; results include
datapoints with the time stamp specified. The time stamp must be
in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z). The specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks.
Data that is timestamped 24 hours or more in the past may take in
excess of 48 hours to become available from submission time using
GetMetricStatistics
.
public Date getStartTime()
The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
The specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks.
Data that is timestamped 24 hours or more in the past may take in excess
of 48 hours to become available from submission time using
GetMetricStatistics
.
The specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks.
Data that is timestamped 24 hours or more in the past may take in
excess of 48 hours to become available from submission time using
GetMetricStatistics
.
public GetMetricStatisticsRequest withStartTime(Date startTime)
The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
The specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks.
Data that is timestamped 24 hours or more in the past may take in excess
of 48 hours to become available from submission time using
GetMetricStatistics
.
startTime
- The time stamp to use for determining the first datapoint to
return. The value specified is inclusive; results include
datapoints with the time stamp specified. The time stamp must be
in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z). The specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks.
Data that is timestamped 24 hours or more in the past may take in
excess of 48 hours to become available from submission time using
GetMetricStatistics
.
public void setEndTime(Date endTime)
The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
endTime
- The time stamp to use for determining the last datapoint to
return. The value specified is exclusive; results will include
datapoints up to the time stamp specified. The time stamp must be
in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).public Date getEndTime()
The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
public GetMetricStatisticsRequest withEndTime(Date endTime)
The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
endTime
- The time stamp to use for determining the last datapoint to
return. The value specified is exclusive; results will include
datapoints up to the time stamp specified. The time stamp must be
in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).public void setPeriod(Integer period)
The granularity, in seconds, of the returned datapoints. A
Period
can be as short as one minute (60 seconds) or as long
as one day (86,400 seconds), and must be a multiple of 60. The default
value is 60.
period
- The granularity, in seconds, of the returned datapoints. A
Period
can be as short as one minute (60 seconds) or
as long as one day (86,400 seconds), and must be a multiple of 60.
The default value is 60.public Integer getPeriod()
The granularity, in seconds, of the returned datapoints. A
Period
can be as short as one minute (60 seconds) or as long
as one day (86,400 seconds), and must be a multiple of 60. The default
value is 60.
Period
can be as short as one minute (60 seconds) or
as long as one day (86,400 seconds), and must be a multiple of
60. The default value is 60.public GetMetricStatisticsRequest withPeriod(Integer period)
The granularity, in seconds, of the returned datapoints. A
Period
can be as short as one minute (60 seconds) or as long
as one day (86,400 seconds), and must be a multiple of 60. The default
value is 60.
period
- The granularity, in seconds, of the returned datapoints. A
Period
can be as short as one minute (60 seconds) or
as long as one day (86,400 seconds), and must be a multiple of 60.
The default value is 60.public List<String> getStatistics()
The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
Statistic
public void setStatistics(Collection<String> statistics)
The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
statistics
- The metric statistics to return. For information about specific
statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.Statistic
public GetMetricStatisticsRequest withStatistics(String... statistics)
The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
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.
statistics
- The metric statistics to return. For information about specific
statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.Statistic
public GetMetricStatisticsRequest withStatistics(Collection<String> statistics)
The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
statistics
- The metric statistics to return. For information about specific
statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.Statistic
public GetMetricStatisticsRequest withStatistics(Statistic... statistics)
The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
statistics
- The metric statistics to return. For information about specific
statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.Statistic
public void setUnit(String unit)
The specific 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 will have no effect.
unit
- The specific 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 will have no effect.StandardUnit
public String getUnit()
The specific 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 will have no effect.
StandardUnit
public GetMetricStatisticsRequest withUnit(String unit)
The specific 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 will have no effect.
unit
- The specific 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 will have no effect.StandardUnit
public void setUnit(StandardUnit unit)
The specific 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 will have no effect.
unit
- The specific 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 will have no effect.StandardUnit
public GetMetricStatisticsRequest withUnit(StandardUnit unit)
The specific 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 will have no effect.
unit
- The specific 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 will have no effect.StandardUnit
public String toString()
toString
in class Object
Object.toString()
public GetMetricStatisticsRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2016. All rights reserved.