Package 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("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	Description
static interface	SavingsPlansPurchaseRecommendation.Builder

Method Summary

Modifier and Type	Method	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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSavingsPlansPurchaseRecommendationDetails()	For responses, this returns true if the service returned a value for the SavingsPlansPurchaseRecommendationDetails property.
LookbackPeriodInDays	lookbackPeriodInDays()	The lookback period in days that's used to generate the recommendation.
String	lookbackPeriodInDaysAsString()	The lookback period in days that's used to generate the recommendation.
PaymentOption	paymentOption()	The payment option that's used to generate the recommendation.
String	paymentOptionAsString()	The payment option that's used to generate the recommendation.
List<SavingsPlansPurchaseRecommendationDetail>	savingsPlansPurchaseRecommendationDetails()	Details for the Savings Plans that 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.
String	termInYearsAsString()	The Savings Plans recommendation term in years.
SavingsPlansPurchaseRecommendation.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, 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 that include 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 that include 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 that include 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 that include 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. It's 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. It's used to generate the recommendation.

See Also:

TermInYears

termInYearsAsString

public final String termInYearsAsString()

The Savings Plans recommendation term in years. It's 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. It's used to generate the recommendation.

See Also:

TermInYears

paymentOption

public final PaymentOption paymentOption()

The payment option that's 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 that's used to generate the recommendation.

See Also:

PaymentOption

paymentOptionAsString

public final String paymentOptionAsString()

The payment option that's 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 that's used to generate the recommendation.

See Also:

PaymentOption

lookbackPeriodInDays

public final LookbackPeriodInDays lookbackPeriodInDays()

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

See Also:

LookbackPeriodInDays

lookbackPeriodInDaysAsString

public final String lookbackPeriodInDaysAsString()

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

See Also:

LookbackPeriodInDays

hasSavingsPlansPurchaseRecommendationDetails

public final boolean hasSavingsPlansPurchaseRecommendationDetails()

For responses, this returns true if the service returned a value for the SavingsPlansPurchaseRecommendationDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

savingsPlansPurchaseRecommendationDetails

public final List<SavingsPlansPurchaseRecommendationDetail> savingsPlansPurchaseRecommendationDetails()

Details for the Savings Plans that 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSavingsPlansPurchaseRecommendationDetails() method.

Returns:

Details for the Savings Plans that 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()

Specified by:

toBuilder in interface ToCopyableBuilder<SavingsPlansPurchaseRecommendation.Builder,SavingsPlansPurchaseRecommendation>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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