@Generated(value="software.amazon.awssdk:codegen") public final class GetSavingsPlansPurchaseRecommendationRequest extends CostExplorerRequest implements ToCopyableBuilder<GetSavingsPlansPurchaseRecommendationRequest.Builder,GetSavingsPlansPurchaseRecommendationRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
GetSavingsPlansPurchaseRecommendationRequest.Builder |
Modifier and Type | Method and Description |
---|---|
AccountScope |
accountScope()
The account scope that you want your recommendations for.
|
String |
accountScopeAsString()
The account scope that you want your recommendations for.
|
static GetSavingsPlansPurchaseRecommendationRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
Expression |
filter()
You can filter your recommendations by Account ID with the
LINKED_ACCOUNT dimension. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
LookbackPeriodInDays |
lookbackPeriodInDays()
The lookback period used to generate the recommendation.
|
String |
lookbackPeriodInDaysAsString()
The lookback period used to generate the recommendation.
|
String |
nextPageToken()
The token to retrieve the next set of results.
|
Integer |
pageSize()
The number of recommendations that you want returned in a single response object.
|
PaymentOption |
paymentOption()
The payment option used to generate these recommendations.
|
String |
paymentOptionAsString()
The payment option used to generate these recommendations.
|
SupportedSavingsPlansType |
savingsPlansType()
The Savings Plans recommendation type requested.
|
String |
savingsPlansTypeAsString()
The Savings Plans recommendation type requested.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetSavingsPlansPurchaseRecommendationRequest.Builder> |
serializableBuilderClass() |
TermInYears |
termInYears()
The savings plan recommendation term used to generate these recommendations.
|
String |
termInYearsAsString()
The savings plan recommendation term used to generate these recommendations.
|
GetSavingsPlansPurchaseRecommendationRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final SupportedSavingsPlansType savingsPlansType()
The Savings Plans recommendation type 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()
.
SupportedSavingsPlansType
public final String savingsPlansTypeAsString()
The Savings Plans recommendation type 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()
.
SupportedSavingsPlansType
public final TermInYears termInYears()
The savings plan recommendation term 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()
.
TermInYears
public final String termInYearsAsString()
The savings plan recommendation term 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()
.
TermInYears
public final PaymentOption paymentOption()
The payment option 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()
.
PaymentOption
public final String paymentOptionAsString()
The payment option 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()
.
PaymentOption
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()
.
PAYER
. If the
value is LINKED
, recommendations are calculated for individual member accounts only.AccountScope
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()
.
PAYER
. If the
value is LINKED
, recommendations are calculated for individual member accounts only.AccountScope
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.
public final Integer pageSize()
The number of recommendations that you want returned in a single response object.
public final LookbackPeriodInDays lookbackPeriodInDays()
The lookback period 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()
.
LookbackPeriodInDays
public final String lookbackPeriodInDaysAsString()
The lookback period 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()
.
LookbackPeriodInDays
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) for which you want to see Savings Plans purchase recommendations.
For GetSavingsPlansPurchaseRecommendation, the Filter
does not 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 for which you want to see Savings Plans Purchase Recommendations. AND
and
OR
operators are not supported.
LINKED_ACCOUNT
dimension. To
filter your recommendations by Account ID, specify Key
as LINKED_ACCOUNT
and
Value
as the comma-separated Acount ID(s) for which you want to see Savings Plans purchase
recommendations.
For GetSavingsPlansPurchaseRecommendation, the Filter
does not 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 for which you want to see Savings Plans
Purchase Recommendations. AND
and OR
operators are not supported.
public GetSavingsPlansPurchaseRecommendationRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetSavingsPlansPurchaseRecommendationRequest.Builder,GetSavingsPlansPurchaseRecommendationRequest>
toBuilder
in class CostExplorerRequest
public static GetSavingsPlansPurchaseRecommendationRequest.Builder builder()
public static Class<? extends GetSavingsPlansPurchaseRecommendationRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.