CopyableBuilder<GetMetricStatisticsRequest.Builder,GetMetricStatisticsRequest>
, SdkBuilder<GetMetricStatisticsRequest.Builder,GetMetricStatisticsRequest>
public static interface GetMetricStatisticsRequest.Builder extends CopyableBuilder<GetMetricStatisticsRequest.Builder,GetMetricStatisticsRequest>
Modifier and Type | Method | Description |
---|---|---|
GetMetricStatisticsRequest.Builder |
dimensions(Collection<Dimension> dimensions) |
The dimensions.
|
GetMetricStatisticsRequest.Builder |
dimensions(Dimension... dimensions) |
The dimensions.
|
GetMetricStatisticsRequest.Builder |
endTime(Date endTime) |
The time stamp that determines the last data point to return.
|
GetMetricStatisticsRequest.Builder |
extendedStatistics(String... extendedStatistics) |
The percentile statistics.
|
GetMetricStatisticsRequest.Builder |
extendedStatistics(Collection<String> extendedStatistics) |
The percentile statistics.
|
GetMetricStatisticsRequest.Builder |
metricName(String metricName) |
The name of the metric, with or without spaces.
|
GetMetricStatisticsRequest.Builder |
namespace(String namespace) |
The namespace of the metric, with or without spaces.
|
GetMetricStatisticsRequest.Builder |
period(Integer period) |
The granularity, in seconds, of the returned data points.
|
GetMetricStatisticsRequest.Builder |
startTime(Date startTime) |
The time stamp that determines the first data point to return.
|
GetMetricStatisticsRequest.Builder |
statistics(String... statistics) |
The metric statistics, other than percentile.
|
GetMetricStatisticsRequest.Builder |
statistics(Collection<String> statistics) |
The metric statistics, other than percentile.
|
GetMetricStatisticsRequest.Builder |
statistics(Statistic... statistics) |
The metric statistics, other than percentile.
|
GetMetricStatisticsRequest.Builder |
unit(String unit) |
The unit for a given metric.
|
GetMetricStatisticsRequest.Builder |
unit(StandardUnit unit) |
The unit for a given metric.
|
copy
apply, build
GetMetricStatisticsRequest.Builder namespace(String namespace)
The namespace of the metric, with or without spaces.
namespace
- The namespace of the metric, with or without spaces.GetMetricStatisticsRequest.Builder metricName(String metricName)
The name of the metric, with or without spaces.
metricName
- The name of the metric, with or without spaces.GetMetricStatisticsRequest.Builder dimensions(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.
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.GetMetricStatisticsRequest.Builder dimensions(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.
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.GetMetricStatisticsRequest.Builder startTime(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.
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.
GetMetricStatisticsRequest.Builder endTime(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).
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).
GetMetricStatisticsRequest.Builder period(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).
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).
GetMetricStatisticsRequest.Builder statistics(Collection<String> statistics)
The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic
.
statistics
- The metric statistics, other than percentile. For percentile statistics, use
ExtendedStatistic
.Statistic
GetMetricStatisticsRequest.Builder statistics(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.
statistics
- The metric statistics, other than percentile. For percentile statistics, use
ExtendedStatistic
.Statistic
GetMetricStatisticsRequest.Builder statistics(Statistic... 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.
statistics
- The metric statistics, other than percentile. For percentile statistics, use
ExtendedStatistic
.Statistic
GetMetricStatisticsRequest.Builder extendedStatistics(Collection<String> extendedStatistics)
The percentile statistics. Specify values between p0.0 and p100.
extendedStatistics
- The percentile statistics. Specify values between p0.0 and p100.GetMetricStatisticsRequest.Builder extendedStatistics(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.
extendedStatistics
- The percentile statistics. Specify values between p0.0 and p100.GetMetricStatisticsRequest.Builder unit(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.
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.StandardUnit
GetMetricStatisticsRequest.Builder unit(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.
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.StandardUnit
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.