@Generated(value="software.amazon.awssdk:codegen") public final class MetricStat extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MetricStat.Builder,MetricStat>
This structure defines the metric to be returned, along with the statistics, period, and units.
Modifier and Type | Class and Description |
---|---|
static interface |
MetricStat.Builder |
Modifier and Type | Method and Description |
---|---|
static MetricStat.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Metric |
metric()
The metric to return, including the metric name, namespace, and dimensions.
|
Integer |
period()
The granularity, in seconds, of the returned data points.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends MetricStat.Builder> |
serializableBuilderClass() |
String |
stat()
The statistic to return.
|
MetricStat.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
StandardUnit |
unit()
When you are using a
Put operation, this defines what unit you want to use when storing the metric. |
String |
unitAsString()
When you are using a
Put operation, this defines what unit you want to use when storing the metric. |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final Metric metric()
The metric to return, including the metric name, namespace, and dimensions.
public final 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 final String stat()
The statistic to return. It can include any CloudWatch statistic or extended statistic.
public final StandardUnit unit()
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, if you omit Unit
then 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 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()
.
Put
operation, this defines what unit you want to use when storing the
metric.
In a Get
operation, if you omit Unit
then 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 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 final String unitAsString()
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, if you omit Unit
then 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 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()
.
Put
operation, this defines what unit you want to use when storing the
metric.
In a Get
operation, if you omit Unit
then 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 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 MetricStat.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<MetricStat.Builder,MetricStat>
public static MetricStat.Builder builder()
public static Class<? extends MetricStat.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2021. All rights reserved.