Class GetReservationPurchaseRecommendationRequest

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

  • Method Details

    • accountId

      public final String accountId()

      The account ID that's associated with the recommendation.

      Returns:
      The account ID that's associated with the recommendation.

    • service

      public final String service()

      The specific service that you want recommendations for.

      Returns:
      The specific service that you want recommendations for.

    • filter

      public final Expression filter()
      Returns the value of the Filter property for this object.
      Returns:
      The value of the Filter property for this object.

    • accountScope

      public final AccountScope accountScope()

      The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

      If the service returns an enum value that is not available in the current SDK version, accountScope will return AccountScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountScopeAsString().

      Returns:
      The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.
      See Also:

    • accountScopeAsString

      public final String accountScopeAsString()

      The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

      If the service returns an enum value that is not available in the current SDK version, accountScope will return AccountScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountScopeAsString().

      Returns:
      The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.
      See Also:

    • lookbackPeriodInDays

      public final LookbackPeriodInDays lookbackPeriodInDays()

      The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.

      If the service returns an enum value that is not available in the current SDK version, lookbackPeriodInDays will return LookbackPeriodInDays.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lookbackPeriodInDaysAsString().

      Returns:
      The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.
      See Also:

    • lookbackPeriodInDaysAsString

      public final String lookbackPeriodInDaysAsString()

      The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.

      If the service returns an enum value that is not available in the current SDK version, lookbackPeriodInDays will return LookbackPeriodInDays.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lookbackPeriodInDaysAsString().

      Returns:
      The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.
      See Also:

    • termInYears

      public final TermInYears termInYears()

      The reservation term that you want recommendations for.

      If the service returns an enum value that is not available in the current SDK version, termInYears will return TermInYears.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from termInYearsAsString().

      Returns:
      The reservation term that you want recommendations for.
      See Also:

    • termInYearsAsString

      public final String termInYearsAsString()

      The reservation term that you want recommendations for.

      If the service returns an enum value that is not available in the current SDK version, termInYears will return TermInYears.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from termInYearsAsString().

      Returns:
      The reservation term that you want recommendations for.
      See Also:

    • paymentOption

      public final PaymentOption paymentOption()

      The reservation purchase option that you want recommendations for.

      If the service returns an enum value that is not available in the current SDK version, paymentOption will return PaymentOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paymentOptionAsString().

      Returns:
      The reservation purchase option that you want recommendations for.
      See Also:

    • paymentOptionAsString

      public final String paymentOptionAsString()

      The reservation purchase option that you want recommendations for.

      If the service returns an enum value that is not available in the current SDK version, paymentOption will return PaymentOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paymentOptionAsString().

      Returns:
      The reservation purchase option that you want recommendations for.
      See Also:

    • serviceSpecification

      public final ServiceSpecification serviceSpecification()

      The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.

      Returns:
      The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.

    • pageSize

      public final Integer pageSize()

      The number of recommendations that you want returned in a single response object.

      Returns:
      The number of recommendations that you want returned in a single response object.

    • nextPageToken

      public final String nextPageToken()

      The pagination token that indicates the next set of results that you want to retrieve.

      Returns:
      The pagination token that indicates the next set of results that you want to retrieve.

    • toBuilder

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

    • builder

      public static GetReservationPurchaseRecommendationRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.