@Generated(value="software.amazon.awssdk:codegen") public final class GetMetricStatisticsRequest extends CloudWatchRequest implements ToCopyableBuilder<GetMetricStatisticsRequest.Builder,GetMetricStatisticsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
GetMetricStatisticsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static GetMetricStatisticsRequest.Builder |
builder() |
List<Dimension> |
dimensions()
The dimensions.
|
Instant |
endTime()
The time stamp that determines the last data point to return.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
List<String> |
extendedStatistics()
The percentile statistics.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasDimensions()
Returns true if the Dimensions property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasExtendedStatistics()
Returns true if the ExtendedStatistics property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasStatistics()
Returns true if the Statistics property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
String |
metricName()
The name of the metric, with or without spaces.
|
String |
namespace()
The namespace of the metric, with or without spaces.
|
Integer |
period()
The granularity, in seconds, of the returned data points.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetMetricStatisticsRequest.Builder> |
serializableBuilderClass() |
Instant |
startTime()
The time stamp that determines the first data point to return.
|
List<Statistic> |
statistics()
The metric statistics, other than percentile.
|
List<String> |
statisticsAsStrings()
The metric statistics, other than percentile.
|
GetMetricStatisticsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
StandardUnit |
unit()
The unit for a given metric.
|
String |
unitAsString()
The unit for a given metric.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public String namespace()
The namespace of the metric, with or without spaces.
public String metricName()
The name of the metric, with or without spaces.
public boolean hasDimensions()
public List<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. If a specific combination of dimensions was not published, you can't retrieve statistics for it. 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 about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDimensions()
to see if a value was sent in this field.
public Instant startTime()
The time stamp that determines the first data point to return. 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. In a raw HTTP query, 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.
If you set Period
to 5, 10, or 30, the start time of your request is rounded down to the nearest
time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at
(HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you
receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using
a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, 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.
If you set Period
to 5, 10, or 30, the start time of your request is rounded down to the
nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you
make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is
rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the
previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15
and 15:07:15.
public Instant endTime()
The time stamp that determines the last data point to return.
The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
public Integer period()
The granularity, in seconds, of the returned data points. 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.
If the StartTime
parameter specifies a time stamp that is greater than 3 hours ago, you must specify
the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
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).
PutMetricData
call that
includes a StorageResolution
of 1 second.
If the StartTime
parameter specifies a time stamp that is greater than 3 hours ago, you must
specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
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).
public List<Statistic> statistics()
The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics
.
When calling GetMetricStatistics
, you must specify either Statistics
or
ExtendedStatistics
, but not both.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasStatistics()
to see if a value was sent in this field.
ExtendedStatistics
. When calling GetMetricStatistics
, you must specify either
Statistics
or ExtendedStatistics
, but not both.public boolean hasStatistics()
public List<String> statisticsAsStrings()
The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics
.
When calling GetMetricStatistics
, you must specify either Statistics
or
ExtendedStatistics
, but not both.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasStatistics()
to see if a value was sent in this field.
ExtendedStatistics
. When calling GetMetricStatistics
, you must specify either
Statistics
or ExtendedStatistics
, but not both.public boolean hasExtendedStatistics()
public List<String> extendedStatistics()
The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics
,
you must specify either Statistics
or ExtendedStatistics
, but not both. Percentile
statistics are not available for metrics when any of the metric values are negative numbers.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasExtendedStatistics()
to see if a value was sent in this field.
GetMetricStatistics
, you must specify either Statistics
or
ExtendedStatistics
, but not both. Percentile statistics are not available for metrics when
any of the metric values are negative numbers.public StandardUnit unit()
The unit for a given metric. If you omit Unit
, 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 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.
If the service returns an enum value that is not available in the current SDK version, unit
will return
StandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
unitAsString()
.
Unit
, 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 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.StandardUnit
public String unitAsString()
The unit for a given metric. If you omit Unit
, 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 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.
If the service returns an enum value that is not available in the current SDK version, unit
will return
StandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
unitAsString()
.
Unit
, 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 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.StandardUnit
public GetMetricStatisticsRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<GetMetricStatisticsRequest.Builder,GetMetricStatisticsRequest>
toBuilder
in class CloudWatchRequest
public static GetMetricStatisticsRequest.Builder builder()
public static Class<? extends GetMetricStatisticsRequest.Builder> serializableBuilderClass()
public int hashCode()
hashCode
in class AwsRequest
public boolean equals(Object obj)
equals
in class AwsRequest
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2020. All rights reserved.