SavingsPlan (AWS Java SDK :: Services :: Savingsplans 2.17.33 API)

java.lang.Object
- software.amazon.awssdk.services.savingsplans.model.SavingsPlan

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<SavingsPlan.Builder,SavingsPlan>

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

Information about a Savings Plan.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SavingsPlan.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SavingsPlan.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SavingsPlan.Builder`	`builder()`
`String`	`commitment()` The hourly commitment, in USD.
`CurrencyCode`	`currency()` The currency.
`String`	`currencyAsString()` The currency.
`String`	`description()` The description.
`String`	`ec2InstanceFamily()` The EC2 instance family.
`String`	`end()` The end time.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasProductTypes()` For responses, this returns true if the service returned a value for the ProductTypes property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`offeringId()` The ID of the offering.
`SavingsPlanPaymentOption`	`paymentOption()` The payment option.
`String`	`paymentOptionAsString()` The payment option.
`List<SavingsPlanProductType>`	`productTypes()` The product types.
`List<String>`	`productTypesAsStrings()` The product types.
`String`	`recurringPaymentAmount()` The recurring payment amount.
`String`	`region()` The AWS Region.
`String`	`savingsPlanArn()` The Amazon Resource Name (ARN) of the Savings Plan.
`String`	`savingsPlanId()` The ID of the Savings Plan.
`SavingsPlanType`	`savingsPlanType()` The plan type.
`String`	`savingsPlanTypeAsString()` The plan type.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SavingsPlan.Builder>`	`serializableBuilderClass()`
`String`	`start()` The start time.
`SavingsPlanState`	`state()` The state.
`String`	`stateAsString()` The state.
`Map<String,String>`	`tags()` One or more tags.
`Long`	`termDurationInSeconds()` The duration of the term, in seconds.
`SavingsPlan.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`upfrontPaymentAmount()` The up-front payment amount.

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
  - offeringId
```
public final String offeringId()
```
    The ID of the offering.
    
    Returns:
    
    The ID of the offering.
  - savingsPlanId
```
public final String savingsPlanId()
```
    The ID of the Savings Plan.
    
    Returns:
    
    The ID of the Savings Plan.
  - savingsPlanArn
```
public final String savingsPlanArn()
```
    The Amazon Resource Name (ARN) of the Savings Plan.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Savings Plan.
  - description
```
public final String description()
```
    The description.
    
    Returns:
    
    The description.
  - start
```
public final String start()
```
    The start time.
    
    Returns:
    
    The start time.
  - end
```
public final String end()
```
    The end time.
    
    Returns:
    
    The end time.
  - state
```
public final SavingsPlanState state()
```
    The state.
    
    If the service returns an enum value that is not available in the current SDK version, state will return SavingsPlanState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state.
    
    See Also:
    
    SavingsPlanState
  - stateAsString
```
public final String stateAsString()
```
    The state.
    
    If the service returns an enum value that is not available in the current SDK version, state will return SavingsPlanState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state.
    
    See Also:
    
    SavingsPlanState
  - region
```
public final String region()
```
    The AWS Region.
    
    Returns:
    
    The AWS Region.
  - ec2InstanceFamily
```
public final String ec2InstanceFamily()
```
    The EC2 instance family.
    
    Returns:
    
    The EC2 instance family.
  - savingsPlanType
```
public final SavingsPlanType savingsPlanType()
```
    The plan type.
    
    If the service returns an enum value that is not available in the current SDK version, savingsPlanType will return SavingsPlanType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from savingsPlanTypeAsString().
    
    Returns:
    
    The plan type.
    
    See Also:
    
    SavingsPlanType
  - savingsPlanTypeAsString
```
public final String savingsPlanTypeAsString()
```
    The plan type.
    
    If the service returns an enum value that is not available in the current SDK version, savingsPlanType will return SavingsPlanType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from savingsPlanTypeAsString().
    
    Returns:
    
    The plan type.
    
    See Also:
    
    SavingsPlanType
  - paymentOption
```
public final SavingsPlanPaymentOption paymentOption()
```
    The payment option.
    
    If the service returns an enum value that is not available in the current SDK version, paymentOption will return SavingsPlanPaymentOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paymentOptionAsString().
    
    Returns:
    
    The payment option.
    
    See Also:
    
    SavingsPlanPaymentOption
  - paymentOptionAsString
```
public final String paymentOptionAsString()
```
    The payment option.
    
    If the service returns an enum value that is not available in the current SDK version, paymentOption will return SavingsPlanPaymentOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paymentOptionAsString().
    
    Returns:
    
    The payment option.
    
    See Also:
    
    SavingsPlanPaymentOption
  - productTypes
```
public final List<SavingsPlanProductType> productTypes()
```
    The product types.
    
    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 hasProductTypes() method.
    
    Returns:
    
    The product types.
  - hasProductTypes
```
public final boolean hasProductTypes()
```
    For responses, this returns true if the service returned a value for the ProductTypes 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.
  - productTypesAsStrings
```
public final List<String> productTypesAsStrings()
```
    The product types.
    
    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 hasProductTypes() method.
    
    Returns:
    
    The product types.
  - currency
```
public final CurrencyCode currency()
```
    The currency.
    
    If the service returns an enum value that is not available in the current SDK version, currency will return CurrencyCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currencyAsString().
    
    Returns:
    
    The currency.
    
    See Also:
    
    CurrencyCode
  - currencyAsString
```
public final String currencyAsString()
```
    The currency.
    
    If the service returns an enum value that is not available in the current SDK version, currency will return CurrencyCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currencyAsString().
    
    Returns:
    
    The currency.
    
    See Also:
    
    CurrencyCode
  - commitment
```
public final String commitment()
```
    The hourly commitment, in USD.
    
    Returns:
    
    The hourly commitment, in USD.
  - upfrontPaymentAmount
```
public final String upfrontPaymentAmount()
```
    The up-front payment amount.
    
    Returns:
    
    The up-front payment amount.
  - recurringPaymentAmount
```
public final String recurringPaymentAmount()
```
    The recurring payment amount.
    
    Returns:
    
    The recurring payment amount.
  - termDurationInSeconds
```
public final Long termDurationInSeconds()
```
    The duration of the term, in seconds.
    
    Returns:
    
    The duration of the term, in seconds.
  - 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 SavingsPlan.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SavingsPlan.Builder,SavingsPlan>
  - builder
```
public static SavingsPlan.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SavingsPlan.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

Class SavingsPlan

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

offeringId

savingsPlanId

savingsPlanArn

description

start

end

state

stateAsString

region

ec2InstanceFamily

savingsPlanType

savingsPlanTypeAsString

paymentOption

paymentOptionAsString

productTypes

hasProductTypes

productTypesAsStrings

currency

currencyAsString

commitment

upfrontPaymentAmount

recurringPaymentAmount

termDurationInSeconds

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields