Class RecommendationSummary

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

A summary of a recommendation.

See Also:

  • Method Details

    • hasSummaries

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

    • summaries

      public final List<Summary> summaries()

      An array of objects that describe a recommendation summary.

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

      Returns:
      An array of objects that describe a recommendation summary.

    • recommendationResourceType

      public final RecommendationSourceType recommendationResourceType()

      The resource type that the recommendation summary applies to.

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

      Returns:
      The resource type that the recommendation summary applies to.
      See Also:

    • recommendationResourceTypeAsString

      public final String recommendationResourceTypeAsString()

      The resource type that the recommendation summary applies to.

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

      Returns:
      The resource type that the recommendation summary applies to.
      See Also:

    • accountId

      public final String accountId()

      The Amazon Web Services account ID of the recommendation summary.

      Returns:
      The Amazon Web Services account ID of the recommendation summary.

    • savingsOpportunity

      public final SavingsOpportunity savingsOpportunity()

      An object that describes the savings opportunity for a given resource type. Savings opportunity includes the estimated monthly savings amount and percentage.

      Returns:
      An object that describes the savings opportunity for a given resource type. Savings opportunity includes the estimated monthly savings amount and percentage.

    • currentPerformanceRiskRatings

      public final CurrentPerformanceRiskRatings currentPerformanceRiskRatings()

      An object that describes the performance risk ratings for a given resource type.

      Returns:
      An object that describes the performance risk ratings for a given resource type.

    • hasInferredWorkloadSavings

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

    • inferredWorkloadSavings

      public final List<InferredWorkloadSaving> inferredWorkloadSavings()

      An array of objects that describes the estimated monthly saving amounts for the instances running on the specified inferredWorkloadTypes. The array contains the top five savings opportunites for the instances that run inferred workload types.

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

      Returns:
      An array of objects that describes the estimated monthly saving amounts for the instances running on the specified inferredWorkloadTypes. The array contains the top five savings opportunites for the instances that run inferred workload types.

    • toBuilder

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

    • builder

      public static RecommendationSummary.Builder builder()

    • serializableBuilderClass

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