Package software.amazon.awssdk.services.cloudwatch.model

Class MetricStreamStatisticsConfiguration

java.lang.Object

software.amazon.awssdk.services.cloudwatch.model.MetricStreamStatisticsConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MetricStreamStatisticsConfiguration.Builder,MetricStreamStatisticsConfiguration>

@Generated("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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetricStreamStatisticsConfiguration.Builder

Method Summary

Modifier and Type	Method	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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasIncludeMetrics

public final boolean hasIncludeMetrics()

For responses, this returns true if the service returned a value for the IncludeMetrics property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

includeMetrics

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.

Returns:

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.

hasAdditionalStatistics

public final boolean hasAdditionalStatistics()

For responses, this returns true if the service returned a value for the AdditionalStatistics property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

additionalStatistics

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 opentelemetry1.0 or 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.

Returns:

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 opentelemetry1.0 or 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.

toBuilder

public MetricStreamStatisticsConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricStreamStatisticsConfiguration.Builder,MetricStreamStatisticsConfiguration>

builder

public static MetricStreamStatisticsConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends MetricStreamStatisticsConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo