Class GetSavingsPlansPurchaseRecommendationRequest

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.GetSavingsPlansPurchaseRecommendationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetSavingsPlansPurchaseRecommendationRequest.Builder,GetSavingsPlansPurchaseRecommendationRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetSavingsPlansPurchaseRecommendationRequest extends CostExplorerRequest implements ToCopyableBuilder<GetSavingsPlansPurchaseRecommendationRequest.Builder,GetSavingsPlansPurchaseRecommendationRequest>

  • Method Details

    • savingsPlansType

      public final SupportedSavingsPlansType savingsPlansType()

      The Savings Plans recommendation type that's requested.

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

      Returns:
      The Savings Plans recommendation type that's requested.
      See Also:

    • savingsPlansTypeAsString

      public final String savingsPlansTypeAsString()

      The Savings Plans recommendation type that's requested.

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

      Returns:
      The Savings Plans recommendation type that's requested.
      See Also:

    • termInYears

      public final TermInYears termInYears()

      The savings plan recommendation term that's used to generate these recommendations.

      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 savings plan recommendation term that's used to generate these recommendations.
      See Also:

    • termInYearsAsString

      public final String termInYearsAsString()

      The savings plan recommendation term that's used to generate these recommendations.

      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 savings plan recommendation term that's used to generate these recommendations.
      See Also:

    • paymentOption

      public final PaymentOption paymentOption()

      The payment option that's used to generate these recommendations.

      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 payment option that's used to generate these recommendations.
      See Also:

    • paymentOptionAsString

      public final String paymentOptionAsString()

      The payment option that's used to generate these recommendations.

      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 payment option that's used to generate these recommendations.
      See Also:

    • 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:

    • nextPageToken

      public final String nextPageToken()

      The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

      Returns:
      The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

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

    • lookbackPeriodInDays

      public final LookbackPeriodInDays lookbackPeriodInDays()

      The lookback period that's used to generate the recommendation.

      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 lookback period that's used to generate the recommendation.
      See Also:

    • lookbackPeriodInDaysAsString

      public final String lookbackPeriodInDaysAsString()

      The lookback period that's used to generate the recommendation.

      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 lookback period that's used to generate the recommendation.
      See Also:

    • filter

      public final Expression filter()

      You can filter your recommendations by Account ID with the LINKED_ACCOUNT dimension. To filter your recommendations by Account ID, specify Key as LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) that you want to see Savings Plans purchase recommendations for.

      For GetSavingsPlansPurchaseRecommendation, the Filter doesn't include CostCategories or Tags. It only includes Dimensions. With Dimensions, Key must be LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated Account IDs that you want to see Savings Plans Purchase Recommendations for. AND and OR operators are not supported.

      Returns:
      You can filter your recommendations by Account ID with the LINKED_ACCOUNT dimension. To filter your recommendations by Account ID, specify Key as LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) that you want to see Savings Plans purchase recommendations for.

      For GetSavingsPlansPurchaseRecommendation, the Filter doesn't include CostCategories or Tags. It only includes Dimensions. With Dimensions, Key must be LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated Account IDs that you want to see Savings Plans Purchase Recommendations for. AND and OR operators are not supported.

    • toBuilder

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

    • builder

      public static GetSavingsPlansPurchaseRecommendationRequest.Builder builder()

    • serializableBuilderClass

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