Class MetricDataQuery

java.lang.Object
software.amazon.awssdk.services.autoscaling.model.MetricDataQuery
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MetricDataQuery.Builder,MetricDataQuery>
@Generated("software.amazon.awssdk:codegen") public final class MetricDataQuery extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MetricDataQuery.Builder,MetricDataQuery>

The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.

For more information and examples, see Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide.

See Also:

  • Method Details

    • id

      public final String id()

      A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.

      Returns:
      A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.

    • expression

      public final String expression()

      The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.

      Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.

      Returns:
      The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.

      Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.

    • metricStat

      public final MetricStat metricStat()

      Information about the metric data to return.

      Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.

      Returns:
      Information about the metric data to return.

      Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.

    • label

      public final String label()

      A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.

      Returns:
      A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.

    • returnData

      public final Boolean returnData()

      Indicates whether to return the timestamps and raw data values of this metric.

      If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.

      If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).

      Returns:
      Indicates whether to return the timestamps and raw data values of this metric.

      If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.

      If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).

    • toBuilder

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

    • builder

      public static MetricDataQuery.Builder builder()

    • serializableBuilderClass

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