Package software.amazon.awssdk.services.computeoptimizer.model

Class GetEffectiveRecommendationPreferencesResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.computeoptimizer.model.ComputeOptimizerResponse
software.amazon.awssdk.services.computeoptimizer.model.GetEffectiveRecommendationPreferencesResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetEffectiveRecommendationPreferencesResponse.Builder,GetEffectiveRecommendationPreferencesResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetEffectiveRecommendationPreferencesResponse extends ComputeOptimizerResponse implements ToCopyableBuilder<GetEffectiveRecommendationPreferencesResponse.Builder,GetEffectiveRecommendationPreferencesResponse>

  • Method Details

    • enhancedInfrastructureMetrics

      public final EnhancedInfrastructureMetrics enhancedInfrastructureMetrics()

      The status of the enhanced infrastructure metrics recommendation preference. Considers all applicable preferences that you might have set at the resource, account, and organization level.

      A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied to recommendations.

      To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

      For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

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

      Returns:
      The status of the enhanced infrastructure metrics recommendation preference. Considers all applicable preferences that you might have set at the resource, account, and organization level.

      A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied to recommendations.

      To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

      For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

      See Also:

    • enhancedInfrastructureMetricsAsString

      public final String enhancedInfrastructureMetricsAsString()

      The status of the enhanced infrastructure metrics recommendation preference. Considers all applicable preferences that you might have set at the resource, account, and organization level.

      A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied to recommendations.

      To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

      For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

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

      Returns:
      The status of the enhanced infrastructure metrics recommendation preference. Considers all applicable preferences that you might have set at the resource, account, and organization level.

      A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied to recommendations.

      To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

      For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

      See Also:

    • externalMetricsPreference

      public final ExternalMetricsPreference externalMetricsPreference()

      The provider of the external metrics recommendation preference. Considers all applicable preferences that you might have set at the account and organization level.

      If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.

      To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetEC2InstanceRecommendations actions.

      For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

      Returns:
      The provider of the external metrics recommendation preference. Considers all applicable preferences that you might have set at the account and organization level.

      If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.

      To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetEC2InstanceRecommendations actions.

      For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

    • lookBackPeriod

      public final LookBackPeriodPreference lookBackPeriod()

      The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

      To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

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

      Returns:
      The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

      To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

      See Also:

    • lookBackPeriodAsString

      public final String lookBackPeriodAsString()

      The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

      To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

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

      Returns:
      The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

      To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

      See Also:

    • hasUtilizationPreferences

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

    • utilizationPreferences

      public final List<UtilizationPreference> utilizationPreferences()

      The resource’s CPU and memory utilization preferences, such as threshold and headroom, that were used to generate rightsizing recommendations. It considers all applicable preferences that you set at the resource, account, and organization level.

      To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

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

      Returns:
      The resource’s CPU and memory utilization preferences, such as threshold and headroom, that were used to generate rightsizing recommendations. It considers all applicable preferences that you set at the resource, account, and organization level.

      To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

    • hasPreferredResources

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

    • preferredResources

      public final List<EffectivePreferredResource> preferredResources()

      The resource type values that are considered as candidates when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. It also considers all applicable preferences that you set at the resource, account, and organization level.

      To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

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

      Returns:
      The resource type values that are considered as candidates when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. It also considers all applicable preferences that you set at the resource, account, and organization level.

      To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

    • toBuilder

      public GetEffectiveRecommendationPreferencesResponse.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<GetEffectiveRecommendationPreferencesResponse.Builder,GetEffectiveRecommendationPreferencesResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetEffectiveRecommendationPreferencesResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetEffectiveRecommendationPreferencesResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.