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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<MetricStreamStatisticsConfiguration.Builder,MetricStreamStatisticsConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.