Class PreferredResource
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<PreferredResource.Builder,
PreferredResource>
The preference to control which resource type values are considered when generating rightsizing recommendations. You
can specify this preference as a combination of include and exclude lists. You must specify either an
includeList
or excludeList
. If the preference is an empty set of resource type values, an
error occurs. For more information, see Rightsizing
recommendation preferences in the Compute Optimizer User Guide.
-
This preference is only available for the Amazon EC2 instance and Auto Scaling group resource types.
-
Compute Optimizer only supports the customization of
Ec2InstanceTypes
.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic PreferredResource.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.The preferred resource type values to exclude from the recommendation candidates.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ExcludeList property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the IncludeList property.The preferred resource type values to include in the recommendation candidates.final PreferredResourceName
name()
The type of preferred resource to customize.final String
The type of preferred resource to customize.static Class
<? extends PreferredResource.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The type of preferred resource to customize.
Compute Optimizer only supports the customization of
Ec2InstanceTypes
.If the service returns an enum value that is not available in the current SDK version,
name
will returnPreferredResourceName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The type of preferred resource to customize.
Compute Optimizer only supports the customization of
Ec2InstanceTypes
. - See Also:
-
nameAsString
The type of preferred resource to customize.
Compute Optimizer only supports the customization of
Ec2InstanceTypes
.If the service returns an enum value that is not available in the current SDK version,
name
will returnPreferredResourceName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The type of preferred resource to customize.
Compute Optimizer only supports the customization of
Ec2InstanceTypes
. - See Also:
-
hasIncludeList
public final boolean hasIncludeList()For responses, this returns true if the service returned a value for the IncludeList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
includeList
The preferred resource type values to include in the recommendation candidates. You can specify the exact resource type value, such as m5.large, or use wild card expressions, such as m5. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.
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
hasIncludeList()
method.- Returns:
- The preferred resource type values to include in the recommendation candidates. You can specify the exact resource type value, such as m5.large, or use wild card expressions, such as m5. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.
-
hasExcludeList
public final boolean hasExcludeList()For responses, this returns true if the service returned a value for the ExcludeList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
excludeList
The preferred resource type values to exclude from the recommendation candidates. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.
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
hasExcludeList()
method.- Returns:
- The preferred resource type values to exclude from the recommendation candidates. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.
-
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 interfaceToCopyableBuilder<PreferredResource.Builder,
PreferredResource> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-