Class IdleRecommendation

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

Describes an Idle resource recommendation.

See Also:

  • Method Details

    • resourceArn

      public final String resourceArn()

      The ARN of the current idle resource.

      Returns:
      The ARN of the current idle resource.

    • resourceId

      public final String resourceId()

      The unique identifier for the resource.

      Returns:
      The unique identifier for the resource.

    • resourceType

      public final IdleRecommendationResourceType resourceType()

      The type of resource that is idle.

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

      Returns:
      The type of resource that is idle.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of resource that is idle.

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

      Returns:
      The type of resource that is idle.
      See Also:

    • accountId

      public final String accountId()

      The Amazon Web Services account ID of the idle resource.

      Returns:
      The Amazon Web Services account ID of the idle resource.

    • finding

      public final IdleFinding finding()

      The finding classification of an idle resource.

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

      Returns:
      The finding classification of an idle resource.
      See Also:

    • findingAsString

      public final String findingAsString()

      The finding classification of an idle resource.

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

      Returns:
      The finding classification of an idle resource.
      See Also:

    • findingDescription

      public final String findingDescription()

      A summary of the findings for the resource.

      Returns:
      A summary of the findings for the resource.

    • savingsOpportunity

      public final IdleSavingsOpportunity savingsOpportunity()

      The savings opportunity for the idle resource.

      Returns:
      The savings opportunity for the idle resource.

    • savingsOpportunityAfterDiscounts

      public final IdleSavingsOpportunityAfterDiscounts savingsOpportunityAfterDiscounts()

      The savings opportunity for the idle resource after any applying discounts.

      Returns:
      The savings opportunity for the idle resource after any applying discounts.

    • hasUtilizationMetrics

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

    • utilizationMetrics

      public final List<IdleUtilizationMetric> utilizationMetrics()

      An array of objects that describe the utilization metrics of the idle resource.

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

      Returns:
      An array of objects that describe the utilization metrics of the idle resource.

    • lookBackPeriodInDays

      public final Double lookBackPeriodInDays()

      The number of days the idle resource utilization metrics were analyzed.

      Returns:
      The number of days the idle resource utilization metrics were analyzed.

    • lastRefreshTimestamp

      public final Instant lastRefreshTimestamp()

      The timestamp of when the idle resource recommendation was last generated.

      Returns:
      The timestamp of when the idle resource recommendation was last generated.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      A list of tags assigned to your idle resource recommendations.

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

      Returns:
      A list of tags assigned to your idle resource recommendations.

    • toBuilder

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

    • builder

      public static IdleRecommendation.Builder builder()

    • serializableBuilderClass

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