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

Class GetRecommendationPreferencesRequest

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

  • Method Details

    • resourceType

      public final ResourceType resourceType()

      The target resource type of the recommendation preference for which to return preferences.

      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.

      The valid values for this parameter are Ec2Instance and AutoScalingGroup.

      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 for which to return preferences.

      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.

      The valid values for this parameter are Ec2Instance and AutoScalingGroup.

      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The target resource type of the recommendation preference for which to return preferences.

      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.

      The valid values for this parameter are Ec2Instance and AutoScalingGroup.

      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 for which to return preferences.

      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.

      The valid values for this parameter are Ec2Instance and AutoScalingGroup.

      See Also:

    • scope

      public final Scope scope()

      An object that describes the scope of the recommendation preference to return.

      You can return recommendation preferences that are 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 to return.

      You can return recommendation preferences that are 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.

    • nextToken

      public final String nextToken()

      The token to advance to the next page of recommendation preferences.

      Returns:
      The token to advance to the next page of recommendation preferences.

    • maxResults

      public final Integer maxResults()

      The maximum number of recommendation preferences to return with a single request.

      To retrieve the remaining results, make another request with the returned nextToken value.

      Returns:
      The maximum number of recommendation preferences to return with a single request.

      To retrieve the remaining results, make another request with the returned nextToken value.

    • toBuilder

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

    • builder

      public static GetRecommendationPreferencesRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.