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

Class EffectiveRecommendationPreferences

java.lang.Object

software.amazon.awssdk.services.computeoptimizer.model.EffectiveRecommendationPreferences

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EffectiveRecommendationPreferences.Builder,EffectiveRecommendationPreferences>

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

Describes the effective recommendation preferences for a resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EffectiveRecommendationPreferences.Builder

Method Summary

Modifier and Type	Method	Description
static EffectiveRecommendationPreferences.Builder	builder()
List<CpuVendorArchitecture>	cpuVendorArchitectures()	Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.
List<String>	cpuVendorArchitecturesAsStrings()	Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.
EnhancedInfrastructureMetrics	enhancedInfrastructureMetrics()	Describes the activation status of the enhanced infrastructure metrics preference.
String	enhancedInfrastructureMetricsAsString()	Describes the activation status of the enhanced infrastructure metrics 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)
boolean	hasCpuVendorArchitectures()	For responses, this returns true if the service returned a value for the CpuVendorArchitectures property.
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()	Describes the activation status of the inferred workload types preference.
String	inferredWorkloadTypesAsString()	Describes the activation status of the inferred workload types preference.
LookBackPeriodPreference	lookBackPeriod()	The number of days the utilization metrics of the Amazon Web Services resource are analyzed.
String	lookBackPeriodAsString()	The number of days the utilization metrics of the Amazon Web Services resource are analyzed.
List<EffectivePreferredResource>	preferredResources()	The resource type values that are considered as candidates when generating rightsizing recommendations.
InstanceSavingsEstimationMode	savingsEstimationMode()	Describes the savings estimation mode applied for calculating savings opportunity for a resource.
List<SdkField<?>>	sdkFields()
static Class<? extends EffectiveRecommendationPreferences.Builder>	serializableBuilderClass()
EffectiveRecommendationPreferences.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<UtilizationPreference>	utilizationPreferences()	The resource’s CPU utilization threshold preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.

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

cpuVendorArchitectures

public final List<CpuVendorArchitecture> cpuVendorArchitectures()

Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

• A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.

• A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.

• A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.

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

Returns:

Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

• A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.

• A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.

• A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.

hasCpuVendorArchitectures

public final boolean hasCpuVendorArchitectures()

For responses, this returns true if the service returned a value for the CpuVendorArchitectures 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.

cpuVendorArchitecturesAsStrings

public final List<String> cpuVendorArchitecturesAsStrings()

Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

• A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.

• A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.

• A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.

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

Returns:

Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

• A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.

• A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.

• A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.

enhancedInfrastructureMetrics

public final EnhancedInfrastructureMetrics enhancedInfrastructureMetrics()

Describes the activation status of the enhanced infrastructure metrics preference.

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.

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:

Describes the activation status of the enhanced infrastructure metrics preference.

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.

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

See Also:

EnhancedInfrastructureMetrics

enhancedInfrastructureMetricsAsString

public final String enhancedInfrastructureMetricsAsString()

Describes the activation status of the enhanced infrastructure metrics preference.

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.

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:

Describes the activation status of the enhanced infrastructure metrics preference.

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.

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

See Also:

EnhancedInfrastructureMetrics

inferredWorkloadTypes

public final InferredWorkloadTypesPreference inferredWorkloadTypes()

Describes the activation status of the inferred workload types preference.

A status of Active confirms that the preference is applied in the latest recommendation refresh. A status of Inactive confirms that it's not 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:

Describes the activation status of the inferred workload types preference.

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

See Also:

InferredWorkloadTypesPreference

inferredWorkloadTypesAsString

public final String inferredWorkloadTypesAsString()

Describes the activation status of the inferred workload types preference.

A status of Active confirms that the preference is applied in the latest recommendation refresh. A status of Inactive confirms that it's not 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:

Describes the activation status of the inferred workload types preference.

A status of Active confirms that the preference is applied in the latest recommendation refresh. A status of Inactive confirms that it's not 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 number of days the utilization metrics of the Amazon Web Services resource are analyzed.

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.

See Also:

LookBackPeriodPreference

lookBackPeriodAsString

public final String lookBackPeriodAsString()

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

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.

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 resource’s CPU utilization threshold preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.

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 resource’s CPU utilization threshold preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.

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 resource type values that are considered as candidates when generating rightsizing 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 hasPreferredResources() method.

Returns:

The resource type values that are considered as candidates when generating rightsizing recommendations.

savingsEstimationMode

public final InstanceSavingsEstimationMode savingsEstimationMode()

Describes the savings estimation mode applied for calculating savings opportunity for a resource.

Returns:

Describes the savings estimation mode applied for calculating savings opportunity for a resource.

toBuilder

public EffectiveRecommendationPreferences.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EffectiveRecommendationPreferences.Builder,EffectiveRecommendationPreferences>

builder

public static EffectiveRecommendationPreferences.Builder builder()

serializableBuilderClass

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