Class GetMetricStatisticsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
A list of dimensions describing qualities of the metric.The time stamp to use for determining the last datapoint to return.The name of the metric, with or without spaces.The namespace of the metric, with or without spaces.The granularity, in seconds, of the returned datapoints.The time stamp to use for determining the first datapoint to return.The metric statistics to return.getUnit()
The unit for the 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
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 unit for the metric.void
The unit for the metric.toString()
Returns a string representation of this object; useful for testing and debugging.withDimensions
(Dimension... dimensions) A list of dimensions describing qualities of the metric.withDimensions
(Collection<Dimension> dimensions) A list of dimensions describing qualities of the metric.withEndTime
(Date endTime) The time stamp to use for determining the last datapoint to return.withMetricName
(String metricName) The name of the metric, with or without spaces.withNamespace
(String namespace) The namespace of the metric, with or without spaces.withPeriod
(Integer period) The granularity, in seconds, of the returned datapoints.withStartTime
(Date startTime) The time stamp to use for determining the first datapoint to return.withStatistics
(Statistic... statistics) The metric statistics to return.withStatistics
(String... statistics) The metric statistics to return.withStatistics
(Collection<String> statistics) The metric statistics to return.withUnit
(StandardUnit unit) The unit for the metric.The unit for the metric.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
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
-
Constructor Details
-
GetMetricStatisticsRequest
public GetMetricStatisticsRequest()
-
-
Method Details
-
setNamespace
The namespace of the metric, with or without spaces.
- Parameters:
namespace
- The namespace of the metric, with or without spaces.
-
getNamespace
The namespace of the metric, with or without spaces.
- Returns:
- The namespace of the metric, with or without spaces.
-
withNamespace
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
The name of the metric, with or without spaces.
- Parameters:
metricName
- The name of the metric, with or without spaces.
-
getMetricName
The name of the metric, with or without spaces.
- Returns:
- The name of the metric, with or without spaces.
-
withMetricName
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
A list of dimensions describing qualities of the metric.
- Returns:
- A list of dimensions describing qualities of the metric.
-
setDimensions
A list of dimensions describing qualities of the metric.
- Parameters:
dimensions
- A list of dimensions describing qualities of the metric.
-
withDimensions
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)
orwithDimensions(java.util.Collection)
if you want to override the existing values.- Parameters:
dimensions
- A list of dimensions describing qualities of the metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDimensions
A list of dimensions describing qualities of the metric.
- Parameters:
dimensions
- A list of dimensions describing qualities of the metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStartTime
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
.- Parameters:
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
.
-
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
.- Returns:
- 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
.
-
withStartTime
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
.- Parameters:
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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEndTime
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).
- Parameters:
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).
-
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).
- Returns:
- 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).
-
withEndTime
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).
- Parameters:
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).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPeriod
The granularity, in seconds, of the returned datapoints.
Period
must be at least 60 seconds and must be a multiple of 60. The default value is 60.- Parameters:
period
- The granularity, in seconds, of the returned datapoints.Period
must be at least 60 seconds and must be a multiple of 60. The default value is 60.
-
getPeriod
The granularity, in seconds, of the returned datapoints.
Period
must be at least 60 seconds and must be a multiple of 60. The default value is 60.- Returns:
- The granularity, in seconds, of the returned datapoints.
Period
must be at least 60 seconds and must be a multiple of 60. The default value is 60.
-
withPeriod
The granularity, in seconds, of the returned datapoints.
Period
must be at least 60 seconds and must be a multiple of 60. The default value is 60.- Parameters:
period
- The granularity, in seconds, of the returned datapoints.Period
must be at least 60 seconds and must be a multiple of 60. The default value is 60.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getStatistics
The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
- Returns:
- The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
- See Also:
-
setStatistics
The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
- Parameters:
statistics
- The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.- See Also:
-
withStatistics
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)
orwithStatistics(java.util.Collection)
if you want to override the existing values.- Parameters:
statistics
- The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
withStatistics
The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
- Parameters:
statistics
- The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
withStatistics
The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
- Parameters:
statistics
- The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setUnit
The unit for the metric.
- Parameters:
unit
- The unit for the metric.- See Also:
-
getUnit
The unit for the metric.
- Returns:
- The unit for the metric.
- See Also:
-
withUnit
The unit for the metric.
- Parameters:
unit
- The unit for the metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setUnit
The unit for the metric.
- Parameters:
unit
- The unit for the metric.- See Also:
-
withUnit
The unit for the metric.
- Parameters:
unit
- The unit for the metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-