@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 period, in seconds, to use when retrieving the metric.
|
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 Metric metric()
The metric to return, including the metric name, namespace, and dimensions.
public Integer period()
The period, in seconds, to use when retrieving the metric.
public String stat()
The statistic to return. It can include any CloudWatch statistic or extended statistic.
public 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 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 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()
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 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 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 boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
Copyright © 2019. All rights reserved.