Class RecommendedOptionProjectedMetric

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

Describes a projected utilization metric of a recommendation option.

The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

See Also:

  • Method Details

    • recommendedInstanceType

      public final String recommendedInstanceType()

      The recommended instance type.

      Returns:
      The recommended instance type.

    • rank

      public final Integer rank()

      The rank of the recommendation option projected metric.

      The top recommendation option is ranked as 1.

      The projected metric rank correlates to the recommendation option rank. For example, the projected metric ranked as 1 is related to the recommendation option that is also ranked as 1 in the same response.

      Returns:
      The rank of the recommendation option projected metric.

      The top recommendation option is ranked as 1.

      The projected metric rank correlates to the recommendation option rank. For example, the projected metric ranked as 1 is related to the recommendation option that is also ranked as 1 in the same response.

    • hasProjectedMetrics

      public final boolean hasProjectedMetrics()
      For responses, this returns true if the service returned a value for the ProjectedMetrics 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.

    • projectedMetrics

      public final List<ProjectedMetric> projectedMetrics()

      An array of objects that describe a projected utilization metric.

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

      Returns:
      An array of objects that describe a projected utilization metric.

    • toBuilder

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

    • builder

      public static RecommendedOptionProjectedMetric.Builder builder()

    • serializableBuilderClass

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