software.amazon.awssdk.services.costexplorer.model

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(value="software.amazon.awssdk:codegen")
public final class GetReservationPurchaseRecommendationRequest
extends CostExplorerRequest
implements ToCopyableBuilder<GetReservationPurchaseRecommendationRequest.Builder,GetReservationPurchaseRecommendationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetReservationPurchaseRecommendationRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The account ID that is associated with the recommendation.
AccountScope	accountScope() The account scope that you want recommendations for.
String	accountScopeAsString() The account scope that you want recommendations for.
static GetReservationPurchaseRecommendationRequest.Builder	builder()
boolean	equals(Object obj)
<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 number of previous days that you want AWS to consider when it calculates your recommendations.
String	lookbackPeriodInDaysAsString() The number of previous days that you want AWS to consider when it calculates your recommendations.
String	nextPageToken() The pagination token that indicates the next set of results that you want to retrieve.
Integer	pageSize() The number of recommendations that you want returned in a single response object.
PaymentOption	paymentOption() The reservation purchase option that you want recommendations for.
String	paymentOptionAsString() The reservation purchase option that you want recommendations for.
List<SdkField<?>>	sdkFields()
static Class<? extends GetReservationPurchaseRecommendationRequest.Builder>	serializableBuilderClass()
String	service() The specific service that you want recommendations for.
ServiceSpecification	serviceSpecification() The hardware specifications for the service instances that you want recommendations for, such as standard or convertible EC2 instances.
TermInYears	termInYears() The reservation term that you want recommendations for.
String	termInYearsAsString() The reservation term that you want recommendations for.
GetReservationPurchaseRecommendationRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

accountId

public String accountId()

The account ID that is associated with the recommendation.

Returns:

The account ID that is associated with the recommendation.

service

public String service()

The specific service that you want recommendations for.

Returns:

The specific service that you want recommendations for.

accountScope

public AccountScope accountScope()

The account scope that you want recommendations for. PAYER means that AWS includes the master account and any member accounts when it calculates its recommendations. LINKED means that AWS includes only member accounts when it calculates its recommendations.

Valid values are PAYER and LINKED.

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 recommendations for. PAYER means that AWS includes the master account and any member accounts when it calculates its recommendations. LINKED means that AWS includes only member accounts when it calculates its recommendations.

Valid values are PAYER and LINKED.

See Also:

AccountScope

accountScopeAsString

public String accountScopeAsString()

The account scope that you want recommendations for. PAYER means that AWS includes the master account and any member accounts when it calculates its recommendations. LINKED means that AWS includes only member accounts when it calculates its recommendations.

Valid values are PAYER and LINKED.

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 recommendations for. PAYER means that AWS includes the master account and any member accounts when it calculates its recommendations. LINKED means that AWS includes only member accounts when it calculates its recommendations.

Valid values are PAYER and LINKED.

See Also:

AccountScope

lookbackPeriodInDays

public LookbackPeriodInDays lookbackPeriodInDays()

The number of previous days that you want AWS 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 AWS to consider when it calculates your recommendations.

See Also:

LookbackPeriodInDays

lookbackPeriodInDaysAsString

public String lookbackPeriodInDaysAsString()

The number of previous days that you want AWS 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 AWS to consider when it calculates your recommendations.

See Also:

LookbackPeriodInDays

termInYears

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

TermInYears

termInYearsAsString

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

TermInYears

paymentOption

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

PaymentOption

paymentOptionAsString

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

PaymentOption

serviceSpecification

public ServiceSpecification serviceSpecification()

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

Returns:

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

pageSize

public 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 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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