@Generated(value="software.amazon.awssdk:codegen") public final class MetricStreamStatisticsConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MetricStreamStatisticsConfiguration.Builder,MetricStreamStatisticsConfiguration>
By default, a metric stream always sends the MAX
, MIN
, SUM
, and
SAMPLECOUNT
statistics for each metric that is streamed. This structure contains information for one
metric that includes additional statistics in the stream. For more information about statistics, see CloudWatch,
listed in
CloudWatch statistics definitions.
Modifier and Type | Class and Description |
---|---|
static interface |
MetricStreamStatisticsConfiguration.Builder |
Modifier and Type | Method and Description |
---|---|
List<String> |
additionalStatistics()
The list of additional statistics that are to be streamed for the metrics listed in the
IncludeMetrics array in this structure. |
static MetricStreamStatisticsConfiguration.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAdditionalStatistics()
For responses, this returns true if the service returned a value for the AdditionalStatistics property.
|
int |
hashCode() |
boolean |
hasIncludeMetrics()
For responses, this returns true if the service returned a value for the IncludeMetrics property.
|
List<MetricStreamStatisticsMetric> |
includeMetrics()
An array of metric name and namespace pairs that stream the additional statistics listed in the value of the
AdditionalStatistics parameter. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends MetricStreamStatisticsConfiguration.Builder> |
serializableBuilderClass() |
MetricStreamStatisticsConfiguration.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final boolean hasIncludeMetrics()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<MetricStreamStatisticsMetric> includeMetrics()
An array of metric name and namespace pairs that stream the additional statistics listed in the value of the
AdditionalStatistics
parameter. There can be as many as 100 pairs in the array.
All metrics that match the combination of metric name and namespace will be streamed with the additional statistics, no matter their dimensions.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasIncludeMetrics()
method.
AdditionalStatistics
parameter. There can be as many as 100 pairs in the array.
All metrics that match the combination of metric name and namespace will be streamed with the additional statistics, no matter their dimensions.
public final boolean hasAdditionalStatistics()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> additionalStatistics()
The list of additional statistics that are to be streamed for the metrics listed in the
IncludeMetrics
array in this structure. This list can include as many as 20 statistics.
If the OutputFormat
for the stream is opentelemetry0.7
, the only valid values are
p??
percentile statistics such as p90
, p99
and so on.
If the OutputFormat
for the stream is json
, the valid values include the abbreviations
for all of the statistics listed in
CloudWatch statistics definitions. For example, this includes tm98,
wm90
,
PR(:300)
, and so on.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAdditionalStatistics()
method.
IncludeMetrics
array in this structure. This list can include as many as 20 statistics.
If the OutputFormat
for the stream is opentelemetry0.7
, the only valid values
are p??
percentile statistics such as p90
, p99
and so on.
If the OutputFormat
for the stream is json
, the valid values include the
abbreviations for all of the statistics listed in
CloudWatch statistics definitions. For example, this includes tm98,
wm90
,
PR(:300)
, and so on.
public MetricStreamStatisticsConfiguration.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<MetricStreamStatisticsConfiguration.Builder,MetricStreamStatisticsConfiguration>
public static MetricStreamStatisticsConfiguration.Builder builder()
public static Class<? extends MetricStreamStatisticsConfiguration.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.