Package software.amazon.awssdk.services.savingsplans.model

Class CreateSavingsPlanRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.savingsplans.model.SavingsplansRequest

software.amazon.awssdk.services.savingsplans.model.CreateSavingsPlanRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSavingsPlanRequest.Builder,CreateSavingsPlanRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateSavingsPlanRequest
extends SavingsplansRequest
implements ToCopyableBuilder<CreateSavingsPlanRequest.Builder,CreateSavingsPlanRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateSavingsPlanRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateSavingsPlanRequest.Builder	builder()
String	clientToken()	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	commitment()	The hourly commitment, in USD.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Instant	purchaseTime()	The time at which to purchase the Savings Plan, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
String	savingsPlanOfferingId()	The ID of the offering.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSavingsPlanRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	One or more tags.
CreateSavingsPlanRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	upfrontPaymentAmount()	The up-front payment amount.

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

overrideConfiguration

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

savingsPlanOfferingId

public final String savingsPlanOfferingId()

The ID of the offering.

Returns:

The ID of the offering.

commitment

public final String commitment()

The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more than five digits after the decimal point.

Returns:

The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more than five digits after the decimal point.

upfrontPaymentAmount

public final String upfrontPaymentAmount()

The up-front payment amount. This is a whole number between 50 and 99 percent of the total value of the Savings Plan. This parameter is supported only if the payment option is Partial Upfront.

Returns:

The up-front payment amount. This is a whole number between 50 and 99 percent of the total value of the Savings Plan. This parameter is supported only if the payment option is Partial Upfront.

purchaseTime

public final Instant purchaseTime()

The time at which to purchase the Savings Plan, in UTC format (YYYY-MM-DDTHH:MM:SSZ).

Returns:

The time at which to purchase the Savings Plan, in UTC format (YYYY-MM-DDTHH:MM:SSZ).

clientToken

public final String clientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final Map<String,String> tags()

One or more tags.

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 hasTags() method.

Returns:

One or more tags.

toBuilder

public CreateSavingsPlanRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSavingsPlanRequest.Builder,CreateSavingsPlanRequest>

Specified by:

toBuilder in class SavingsplansRequest

builder

public static CreateSavingsPlanRequest.Builder builder()

serializableBuilderClass

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

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo