Class PreviewResult

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

Contains the results of previewing an automation rule against available recommendations.

See Also:

  • Method Details

    • recommendedActionId

      public final String recommendedActionId()

      The ID of the recommended action being previewed.

      Returns:
      The ID of the recommended action being previewed.

    • resourceArn

      public final String resourceArn()

      The Amazon Resource Name (ARN) of the resource affected by the recommended action.

      Returns:
      The Amazon Resource Name (ARN) of the resource affected by the recommended action.

    • resourceId

      public final String resourceId()

      The ID of the resource affected by the recommended action.

      Returns:
      The ID of the resource affected by the recommended action.

    • accountId

      public final String accountId()

      The Amazon Web Services account ID associated with the resource.

      Returns:
      The Amazon Web Services account ID associated with the resource.

    • region

      public final String region()

      The Amazon Web Services Region where the resource is located.

      Returns:
      The Amazon Web Services Region where the resource is located.

    • resourceType

      public final ResourceType resourceType()

      The type of resource being evaluated.

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

      Returns:
      The type of resource being evaluated.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of resource being evaluated.

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

      Returns:
      The type of resource being evaluated.
      See Also:

    • lookBackPeriodInDays

      public final Integer lookBackPeriodInDays()

      The number of days of historical data used to analyze the resource.

      Returns:
      The number of days of historical data used to analyze the resource.

    • recommendedActionType

      public final RecommendedActionType recommendedActionType()

      The type of recommended action being previewed.

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

      Returns:
      The type of recommended action being previewed.
      See Also:

    • recommendedActionTypeAsString

      public final String recommendedActionTypeAsString()

      The type of recommended action being previewed.

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

      Returns:
      The type of recommended action being previewed.
      See Also:

    • currentResourceSummary

      public final String currentResourceSummary()

      A summary of the resource's current configuration.

      Returns:
      A summary of the resource's current configuration.

    • currentResourceDetails

      public final ResourceDetails currentResourceDetails()
      Returns the value of the CurrentResourceDetails property for this object.
      Returns:
      The value of the CurrentResourceDetails property for this object.

    • recommendedResourceSummary

      public final String recommendedResourceSummary()

      A summary of the resource's recommended configuration.

      Returns:
      A summary of the resource's recommended configuration.

    • recommendedResourceDetails

      public final ResourceDetails recommendedResourceDetails()
      Returns the value of the RecommendedResourceDetails property for this object.
      Returns:
      The value of the RecommendedResourceDetails property for this object.

    • restartNeeded

      public final Boolean restartNeeded()

      Indicates whether implementing the recommended action requires a resource restart.

      Returns:
      Indicates whether implementing the recommended action requires a resource restart.

    • estimatedMonthlySavings

      public final EstimatedMonthlySavings estimatedMonthlySavings()
      Returns the value of the EstimatedMonthlySavings property for this object.
      Returns:
      The value of the EstimatedMonthlySavings property for this object.

    • hasResourceTags

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

    • resourceTags

      public final List<Tag> resourceTags()

      The tags associated with the 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 hasResourceTags() method.

      Returns:
      The tags associated with the resource.

    • toBuilder

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

    • builder

      public static PreviewResult.Builder builder()

    • serializableBuilderClass

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