java.lang.Object
- software.amazon.awssdk.services.computeoptimizer.model.RecommendationPreferencesDetail

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<RecommendationPreferencesDetail.Builder,RecommendationPreferencesDetail>

@Generated("software.amazon.awssdk:codegen")
public final class RecommendationPreferencesDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RecommendationPreferencesDetail.Builder,RecommendationPreferencesDetail>

Describes a recommendation preference.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RecommendationPreferencesDetail.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static RecommendationPreferencesDetail.Builder`	`builder()`
`EnhancedInfrastructureMetrics`	`enhancedInfrastructureMetrics()`	The status of the enhanced infrastructure metrics recommendation preference.
`String`	`enhancedInfrastructureMetricsAsString()`	The status of the enhanced infrastructure metrics recommendation preference.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ExternalMetricsPreference`	`externalMetricsPreference()`	An object that describes the external metrics recommendation preference.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasPreferredResources()`	For responses, this returns true if the service returned a value for the PreferredResources property.
`boolean`	`hasUtilizationPreferences()`	For responses, this returns true if the service returned a value for the UtilizationPreferences property.
`InferredWorkloadTypesPreference`	`inferredWorkloadTypes()`	The status of the inferred workload types recommendation preference.
`String`	`inferredWorkloadTypesAsString()`	The status of the inferred workload types recommendation preference.
`LookBackPeriodPreference`	`lookBackPeriod()`	The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed.
`String`	`lookBackPeriodAsString()`	The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed.
`List<EffectivePreferredResource>`	`preferredResources()`	The preference to control which resource type values are considered when generating rightsizing recommendations.
`ResourceType`	`resourceType()`	The target resource type of the recommendation preference to create.
`String`	`resourceTypeAsString()`	The target resource type of the recommendation preference to create.
`SavingsEstimationMode`	`savingsEstimationMode()`	Describes the savings estimation mode used for calculating savings opportunity.
`String`	`savingsEstimationModeAsString()`	Describes the savings estimation mode used for calculating savings opportunity.
`Scope`	`scope()`	An object that describes the scope of the recommendation preference.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RecommendationPreferencesDetail.Builder>`	`serializableBuilderClass()`
`RecommendationPreferencesDetail.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<UtilizationPreference>`	`utilizationPreferences()`	The preference to control the resource’s CPU utilization thresholds - threshold and headroom.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - scope
```
public final Scope scope()
```
    An object that describes the scope of the recommendation preference.
    
    Recommendation preferences can be created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
    
    Returns:
    
    An object that describes the scope of the recommendation preference.
    
    Recommendation preferences can be created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
  - resourceType
```
public final ResourceType resourceType()
```
    The target resource type of the recommendation preference to create.
    
    The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.
    
    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 target resource type of the recommendation preference to create.
    
    The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.
    
    See Also:
    
    ResourceType
  - resourceTypeAsString
```
public final String resourceTypeAsString()
```
    The target resource type of the recommendation preference to create.
    
    The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.
    
    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 target resource type of the recommendation preference to create.
    
    The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.
    
    See Also:
    
    ResourceType
  - enhancedInfrastructureMetrics
```
public final EnhancedInfrastructureMetrics enhancedInfrastructureMetrics()
```
    The status of the enhanced infrastructure metrics recommendation preference.
    
    When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
    
    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.
    
    When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
    
    For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
    
    See Also:
    
    EnhancedInfrastructureMetrics
  - enhancedInfrastructureMetricsAsString
```
public final String enhancedInfrastructureMetricsAsString()
```
    The status of the enhanced infrastructure metrics recommendation preference.
    
    When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
    
    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.
    
    When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
    
    For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
    
    See Also:
    
    EnhancedInfrastructureMetrics
  - inferredWorkloadTypes
```
public final InferredWorkloadTypesPreference inferredWorkloadTypes()
```
    The status of the inferred workload types recommendation preference.
    
    When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
    
    If the service returns an enum value that is not available in the current SDK version, inferredWorkloadTypes will return InferredWorkloadTypesPreference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inferredWorkloadTypesAsString().
    
    Returns:
    
    The status of the inferred workload types recommendation preference.
    
    When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
    
    See Also:
    
    InferredWorkloadTypesPreference
  - inferredWorkloadTypesAsString
```
public final String inferredWorkloadTypesAsString()
```
    The status of the inferred workload types recommendation preference.
    
    When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
    
    If the service returns an enum value that is not available in the current SDK version, inferredWorkloadTypes will return InferredWorkloadTypesPreference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inferredWorkloadTypesAsString().
    
    Returns:
    
    The status of the inferred workload types recommendation preference.
    
    When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
    
    See Also:
    
    InferredWorkloadTypesPreference
  - externalMetricsPreference
```
public final ExternalMetricsPreference externalMetricsPreference()
```
    An object that describes the external metrics recommendation preference.
    
    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.
    
    Returns:
    
    An object that describes the external metrics recommendation preference.
    
    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.
  - lookBackPeriod
```
public final LookBackPeriodPreference lookBackPeriod()
```
    The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. If the preference isn’t set, this object is null.
    
    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 preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. If the preference isn’t set, this object is null.
    
    See Also:
    
    LookBackPeriodPreference
  - lookBackPeriodAsString
```
public final String lookBackPeriodAsString()
```
    The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. If the preference isn’t set, this object is null.
    
    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 preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. If the preference isn’t set, this object is null.
    
    See Also:
    
    LookBackPeriodPreference
  - 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 preference to control the resource’s CPU utilization thresholds - threshold and headroom. If the preference isn’t set, this object is null.
    
    This preference is only available for the Amazon EC2 instance resource type.
    
    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 preference to control the resource’s CPU utilization thresholds - threshold and headroom. If the preference isn’t set, this object is null.
    
    This preference is only available for the Amazon EC2 instance resource type.
  - 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 preference to control which resource type values are considered when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. If the preference isn’t set, this object is null.
    
    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 preference to control which resource type values are considered when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. If the preference isn’t set, this object is null.
  - savingsEstimationMode
```
public final SavingsEstimationMode savingsEstimationMode()
```
    Describes the savings estimation mode used for calculating savings opportunity.
    
    Only the account manager or delegated administrator of your organization can activate this preference.
    
    If the service returns an enum value that is not available in the current SDK version, savingsEstimationMode will return SavingsEstimationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from savingsEstimationModeAsString().
    
    Returns:
    
    Describes the savings estimation mode used for calculating savings opportunity.
    
    Only the account manager or delegated administrator of your organization can activate this preference.
    
    See Also:
    
    SavingsEstimationMode
  - savingsEstimationModeAsString
```
public final String savingsEstimationModeAsString()
```
    Describes the savings estimation mode used for calculating savings opportunity.
    
    Only the account manager or delegated administrator of your organization can activate this preference.
    
    If the service returns an enum value that is not available in the current SDK version, savingsEstimationMode will return SavingsEstimationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from savingsEstimationModeAsString().
    
    Returns:
    
    Describes the savings estimation mode used for calculating savings opportunity.
    
    Only the account manager or delegated administrator of your organization can activate this preference.
    
    See Also:
    
    SavingsEstimationMode
  - toBuilder
```
public RecommendationPreferencesDetail.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RecommendationPreferencesDetail.Builder,RecommendationPreferencesDetail>
  - builder
```
public static RecommendationPreferencesDetail.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RecommendationPreferencesDetail.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class RecommendationPreferencesDetail

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

scope

resourceType

resourceTypeAsString

enhancedInfrastructureMetrics

enhancedInfrastructureMetricsAsString

inferredWorkloadTypes

inferredWorkloadTypesAsString

externalMetricsPreference

lookBackPeriod

lookBackPeriodAsString

hasUtilizationPreferences

utilizationPreferences

hasPreferredResources

preferredResources

savingsEstimationMode

savingsEstimationModeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields