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

Class MetricStat

java.lang.Object
software.amazon.awssdk.services.cloudwatch.model.MetricStat
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MetricStat.Builder,MetricStat>
@Generated("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.

See Also:

  • Method Details

    • metric

      public final Metric metric()

      The metric to return, including the metric name, namespace, and dimensions.

      Returns:
      The metric to return, including the metric name, namespace, and dimensions.

    • period

      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).

      Returns:
      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).

    • stat

      public final String stat()

      The statistic to return. It can include any CloudWatch statistic or extended statistic.

      Returns:
      The statistic to return. It can include any CloudWatch statistic or extended statistic.

    • unit

      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().

      Returns:
      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.

      See Also:

    • unitAsString

      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().

      Returns:
      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.

      See Also:

    • toBuilder

      public MetricStat.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<MetricStat.Builder,MetricStat>
      Returns:
      a builder for type T

    • builder

      public static MetricStat.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MetricStat.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.