software.amazon.awssdk.services.costexplorer.model

Class SavingsPlansPurchaseRecommendation

java.lang.Object

software.amazon.awssdk.services.costexplorer.model.SavingsPlansPurchaseRecommendation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SavingsPlansPurchaseRecommendation.Builder,SavingsPlansPurchaseRecommendation>

@Generated(value="software.amazon.awssdk:codegen")
public final class SavingsPlansPurchaseRecommendation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SavingsPlansPurchaseRecommendation.Builder,SavingsPlansPurchaseRecommendation>

Contains your request parameters, Savings Plan Recommendations Summary, and Details.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SavingsPlansPurchaseRecommendation.Builder

Method Summary

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 SavingsPlansPurchaseRecommendation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSavingsPlansPurchaseRecommendationDetails() Returns true if the SavingsPlansPurchaseRecommendationDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
LookbackPeriodInDays	lookbackPeriodInDays() The lookback period in days, used to generate the recommendation.
String	lookbackPeriodInDaysAsString() The lookback period in days, used to generate the recommendation.
PaymentOption	paymentOption() The payment option used to generate the recommendation.
String	paymentOptionAsString() The payment option used to generate the recommendation.
List<SavingsPlansPurchaseRecommendationDetail>	savingsPlansPurchaseRecommendationDetails() Details for the Savings Plans we recommend that you purchase to cover existing Savings Plans eligible workloads.
SavingsPlansPurchaseRecommendationSummary	savingsPlansPurchaseRecommendationSummary() Summary metrics for your Savings Plans Recommendations.
SupportedSavingsPlansType	savingsPlansType() The requested Savings Plans recommendation type.
String	savingsPlansTypeAsString() The requested Savings Plans recommendation type.
List<SdkField<?>>	sdkFields()
static Class<? extends SavingsPlansPurchaseRecommendation.Builder>	serializableBuilderClass()
TermInYears	termInYears() The Savings Plans recommendation term in years, used to generate the recommendation.
String	termInYearsAsString() The Savings Plans recommendation term in years, used to generate the recommendation.
SavingsPlansPurchaseRecommendation.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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

AccountScope

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:

AccountScope

savingsPlansType

public final SupportedSavingsPlansType savingsPlansType()

The requested Savings Plans recommendation type.

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 requested Savings Plans recommendation type.

See Also:

SupportedSavingsPlansType

savingsPlansTypeAsString

public final String savingsPlansTypeAsString()

The requested Savings Plans recommendation type.

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 requested Savings Plans recommendation type.

See Also:

SupportedSavingsPlansType

termInYears

public final TermInYears termInYears()

The Savings Plans recommendation term in years, used to generate the recommendation.

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 Plans recommendation term in years, used to generate the recommendation.

See Also:

TermInYears

termInYearsAsString

public final String termInYearsAsString()

The Savings Plans recommendation term in years, used to generate the recommendation.

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 Plans recommendation term in years, used to generate the recommendation.

See Also:

TermInYears

paymentOption

public final PaymentOption paymentOption()

The payment option used to generate the recommendation.

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 used to generate the recommendation.

See Also:

PaymentOption

paymentOptionAsString

public final String paymentOptionAsString()

The payment option used to generate the recommendation.

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 used to generate the recommendation.

See Also:

PaymentOption

lookbackPeriodInDays

public final LookbackPeriodInDays lookbackPeriodInDays()

The lookback period in days, 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 in days, used to generate the recommendation.

See Also:

LookbackPeriodInDays

lookbackPeriodInDaysAsString

public final String lookbackPeriodInDaysAsString()

The lookback period in days, 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 in days, used to generate the recommendation.

See Also:

LookbackPeriodInDays

hasSavingsPlansPurchaseRecommendationDetails

public final boolean hasSavingsPlansPurchaseRecommendationDetails()

Returns true if the SavingsPlansPurchaseRecommendationDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

savingsPlansPurchaseRecommendationDetails

public final List<SavingsPlansPurchaseRecommendationDetail> savingsPlansPurchaseRecommendationDetails()

Details for the Savings Plans we recommend that you purchase to cover existing Savings Plans eligible workloads.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSavingsPlansPurchaseRecommendationDetails() to see if a value was sent in this field.

Returns:

Details for the Savings Plans we recommend that you purchase to cover existing Savings Plans eligible workloads.

savingsPlansPurchaseRecommendationSummary

public final SavingsPlansPurchaseRecommendationSummary savingsPlansPurchaseRecommendationSummary()

Summary metrics for your Savings Plans Recommendations.

Returns:

Summary metrics for your Savings Plans Recommendations.

toBuilder

public SavingsPlansPurchaseRecommendation.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<SavingsPlansPurchaseRecommendation.Builder,SavingsPlansPurchaseRecommendation>

Returns:

a builder for type T

builder

public static SavingsPlansPurchaseRecommendation.Builder builder()

serializableBuilderClass

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