Class PreferredResource

java.lang.Object
software.amazon.awssdk.services.computeoptimizer.model.PreferredResource
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PreferredResource.Builder,PreferredResource>
@Generated("software.amazon.awssdk:codegen") public final class PreferredResource extends Object implements SdkPojo, Serializable, 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:

  • Method Details

    • name

      public final PreferredResourceName 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 return PreferredResourceName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

      Returns:
      The type of preferred resource to customize.

      Compute Optimizer only supports the customization of Ec2InstanceTypes.

      See Also:

    • nameAsString

      public final String 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 return PreferredResourceName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

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

    • includeList

      public final List<String> 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 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.

    • excludeList

      public final List<String> 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

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

    • builder

      public static PreferredResource.Builder builder()

    • serializableBuilderClass

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