Class PredictiveScalingMetricSpecification

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

This structure specifies the metrics and target utilization settings for a predictive scaling policy.

You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.

See Also:

  • Method Details

    • targetValue

      public final Double targetValue()

      Specifies the target utilization.

      Returns:
      Specifies the target utilization.

    • predefinedMetricPairSpecification

      public final PredictiveScalingPredefinedMetricPairSpecification predefinedMetricPairSpecification()

      The predefined metric pair specification that determines the appropriate scaling metric and load metric to use.

      Returns:
      The predefined metric pair specification that determines the appropriate scaling metric and load metric to use.

    • predefinedScalingMetricSpecification

      public final PredictiveScalingPredefinedScalingMetricSpecification predefinedScalingMetricSpecification()

      The predefined scaling metric specification.

      Returns:
      The predefined scaling metric specification.

    • predefinedLoadMetricSpecification

      public final PredictiveScalingPredefinedLoadMetricSpecification predefinedLoadMetricSpecification()

      The predefined load metric specification.

      Returns:
      The predefined load metric specification.

    • customizedScalingMetricSpecification

      public final PredictiveScalingCustomizedMetricSpecification customizedScalingMetricSpecification()

      The customized scaling metric specification.

      Returns:
      The customized scaling metric specification.

    • customizedLoadMetricSpecification

      public final PredictiveScalingCustomizedMetricSpecification customizedLoadMetricSpecification()

      The customized load metric specification.

      Returns:
      The customized load metric specification.

    • customizedCapacityMetricSpecification

      public final PredictiveScalingCustomizedMetricSpecification customizedCapacityMetricSpecification()

      The customized capacity metric specification.

      Returns:
      The customized capacity metric specification.

    • toBuilder

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

    • builder

      public static PredictiveScalingMetricSpecification.Builder builder()

    • serializableBuilderClass

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