Class CustomizableMetricParameters

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

Defines the various metric parameters that can be customized, such as threshold and headroom.

See Also:

  • Method Details

    • threshold

      public final CustomizableMetricThreshold threshold()

      The threshold value used for the specified metric parameter.

      You can only specify the threshold value for CPU utilization.

      If the service returns an enum value that is not available in the current SDK version, threshold will return CustomizableMetricThreshold.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from thresholdAsString().

      Returns:
      The threshold value used for the specified metric parameter.

      You can only specify the threshold value for CPU utilization.

      See Also:

    • thresholdAsString

      public final String thresholdAsString()

      The threshold value used for the specified metric parameter.

      You can only specify the threshold value for CPU utilization.

      If the service returns an enum value that is not available in the current SDK version, threshold will return CustomizableMetricThreshold.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from thresholdAsString().

      Returns:
      The threshold value used for the specified metric parameter.

      You can only specify the threshold value for CPU utilization.

      See Also:

    • headroom

      public final CustomizableMetricHeadroom headroom()

      The headroom value in percentage used for the specified metric parameter.

      The following lists the valid values for CPU and memory utilization.

      • CPU utilization: PERCENT_30 | PERCENT_20 | PERCENT_0

      • Memory utilization: PERCENT_30 | PERCENT_20 | PERCENT_10

      If the service returns an enum value that is not available in the current SDK version, headroom will return CustomizableMetricHeadroom.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from headroomAsString().

      Returns:
      The headroom value in percentage used for the specified metric parameter.

      The following lists the valid values for CPU and memory utilization.

      • CPU utilization: PERCENT_30 | PERCENT_20 | PERCENT_0

      • Memory utilization: PERCENT_30 | PERCENT_20 | PERCENT_10

      See Also:

    • headroomAsString

      public final String headroomAsString()

      The headroom value in percentage used for the specified metric parameter.

      The following lists the valid values for CPU and memory utilization.

      • CPU utilization: PERCENT_30 | PERCENT_20 | PERCENT_0

      • Memory utilization: PERCENT_30 | PERCENT_20 | PERCENT_10

      If the service returns an enum value that is not available in the current SDK version, headroom will return CustomizableMetricHeadroom.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from headroomAsString().

      Returns:
      The headroom value in percentage used for the specified metric parameter.

      The following lists the valid values for CPU and memory utilization.

      • CPU utilization: PERCENT_30 | PERCENT_20 | PERCENT_0

      • Memory utilization: PERCENT_30 | PERCENT_20 | PERCENT_10

      See Also:

    • toBuilder

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

    • builder

      public static CustomizableMetricParameters.Builder builder()

    • serializableBuilderClass

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