SavingsPlan (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.savingsplans.model.SavingsPlan

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SavingsPlan
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about a Savings Plan.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SavingsPlan()

Constructors
Constructor and Description
`SavingsPlan()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SavingsPlan`	`addTagsEntry(String key, String value)` Add a single Tags entry
`SavingsPlan`	`clearTagsEntries()` Removes all the entries added into Tags.
`SavingsPlan`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCommitment()` The hourly commitment amount in the specified currency.
`String`	`getCurrency()` The currency.
`String`	`getDescription()` The description.
`String`	`getEc2InstanceFamily()` The EC2 instance family.
`String`	`getEnd()` The end time.
`String`	`getOfferingId()` The ID of the offering.
`String`	`getPaymentOption()` The payment option.
`List<String>`	`getProductTypes()` The product types.
`String`	`getRecurringPaymentAmount()` The recurring payment amount.
`String`	`getRegion()` The Amazon Web Services Region.
`String`	`getReturnableUntil()` The time until when a return for the Savings Plan can be requested.
`String`	`getSavingsPlanArn()` The Amazon Resource Name (ARN) of the Savings Plan.
`String`	`getSavingsPlanId()` The ID of the Savings Plan.
`String`	`getSavingsPlanType()` The plan type.
`String`	`getStart()` The start time.
`String`	`getState()` The current state.
`Map<String,String>`	`getTags()` One or more tags.
`Long`	`getTermDurationInSeconds()` The duration of the term, in seconds.
`String`	`getUpfrontPaymentAmount()` The up-front payment amount.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCommitment(String commitment)` The hourly commitment amount in the specified currency.
`void`	`setCurrency(String currency)` The currency.
`void`	`setDescription(String description)` The description.
`void`	`setEc2InstanceFamily(String ec2InstanceFamily)` The EC2 instance family.
`void`	`setEnd(String end)` The end time.
`void`	`setOfferingId(String offeringId)` The ID of the offering.
`void`	`setPaymentOption(String paymentOption)` The payment option.
`void`	`setProductTypes(Collection<String> productTypes)` The product types.
`void`	`setRecurringPaymentAmount(String recurringPaymentAmount)` The recurring payment amount.
`void`	`setRegion(String region)` The Amazon Web Services Region.
`void`	`setReturnableUntil(String returnableUntil)` The time until when a return for the Savings Plan can be requested.
`void`	`setSavingsPlanArn(String savingsPlanArn)` The Amazon Resource Name (ARN) of the Savings Plan.
`void`	`setSavingsPlanId(String savingsPlanId)` The ID of the Savings Plan.
`void`	`setSavingsPlanType(String savingsPlanType)` The plan type.
`void`	`setStart(String start)` The start time.
`void`	`setState(String state)` The current state.
`void`	`setTags(Map<String,String> tags)` One or more tags.
`void`	`setTermDurationInSeconds(Long termDurationInSeconds)` The duration of the term, in seconds.
`void`	`setUpfrontPaymentAmount(String upfrontPaymentAmount)` The up-front payment amount.
`String`	`toString()` Returns a string representation of this object.
`SavingsPlan`	`withCommitment(String commitment)` The hourly commitment amount in the specified currency.
`SavingsPlan`	`withCurrency(CurrencyCode currency)` The currency.
`SavingsPlan`	`withCurrency(String currency)` The currency.
`SavingsPlan`	`withDescription(String description)` The description.
`SavingsPlan`	`withEc2InstanceFamily(String ec2InstanceFamily)` The EC2 instance family.
`SavingsPlan`	`withEnd(String end)` The end time.
`SavingsPlan`	`withOfferingId(String offeringId)` The ID of the offering.
`SavingsPlan`	`withPaymentOption(SavingsPlanPaymentOption paymentOption)` The payment option.
`SavingsPlan`	`withPaymentOption(String paymentOption)` The payment option.
`SavingsPlan`	`withProductTypes(Collection<String> productTypes)` The product types.
`SavingsPlan`	`withProductTypes(SavingsPlanProductType... productTypes)` The product types.
`SavingsPlan`	`withProductTypes(String... productTypes)` The product types.
`SavingsPlan`	`withRecurringPaymentAmount(String recurringPaymentAmount)` The recurring payment amount.
`SavingsPlan`	`withRegion(String region)` The Amazon Web Services Region.
`SavingsPlan`	`withReturnableUntil(String returnableUntil)` The time until when a return for the Savings Plan can be requested.
`SavingsPlan`	`withSavingsPlanArn(String savingsPlanArn)` The Amazon Resource Name (ARN) of the Savings Plan.
`SavingsPlan`	`withSavingsPlanId(String savingsPlanId)` The ID of the Savings Plan.
`SavingsPlan`	`withSavingsPlanType(SavingsPlanType savingsPlanType)` The plan type.
`SavingsPlan`	`withSavingsPlanType(String savingsPlanType)` The plan type.
`SavingsPlan`	`withStart(String start)` The start time.
`SavingsPlan`	`withState(SavingsPlanState state)` The current state.
`SavingsPlan`	`withState(String state)` The current state.
`SavingsPlan`	`withTags(Map<String,String> tags)` One or more tags.
`SavingsPlan`	`withTermDurationInSeconds(Long termDurationInSeconds)` The duration of the term, in seconds.
`SavingsPlan`	`withUpfrontPaymentAmount(String upfrontPaymentAmount)` The up-front payment amount.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SavingsPlan
```
public SavingsPlan()
```
- Method Detail
  - setOfferingId
```
public void setOfferingId(String offeringId)
```
    The ID of the offering.
    
    Parameters:
    
    offeringId - The ID of the offering.
  - getOfferingId
```
public String getOfferingId()
```
    The ID of the offering.
    
    Returns:
    
    The ID of the offering.
  - withOfferingId
```
public SavingsPlan withOfferingId(String offeringId)
```
    The ID of the offering.
    
    Parameters:
    
    offeringId - The ID of the offering.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSavingsPlanId
```
public void setSavingsPlanId(String savingsPlanId)
```
    The ID of the Savings Plan.
    
    Parameters:
    
    savingsPlanId - The ID of the Savings Plan.
  - getSavingsPlanId
```
public String getSavingsPlanId()
```
    The ID of the Savings Plan.
    
    Returns:
    
    The ID of the Savings Plan.
  - withSavingsPlanId
```
public SavingsPlan withSavingsPlanId(String savingsPlanId)
```
    The ID of the Savings Plan.
    
    Parameters:
    
    savingsPlanId - The ID of the Savings Plan.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSavingsPlanArn
```
public void setSavingsPlanArn(String savingsPlanArn)
```
    The Amazon Resource Name (ARN) of the Savings Plan.
    
    Parameters:
    
    savingsPlanArn - The Amazon Resource Name (ARN) of the Savings Plan.
  - getSavingsPlanArn
```
public String getSavingsPlanArn()
```
    The Amazon Resource Name (ARN) of the Savings Plan.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Savings Plan.
  - withSavingsPlanArn
```
public SavingsPlan withSavingsPlanArn(String savingsPlanArn)
```
    The Amazon Resource Name (ARN) of the Savings Plan.
    
    Parameters:
    
    savingsPlanArn - The Amazon Resource Name (ARN) of the Savings Plan.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description.
    
    Parameters:
    
    description - The description.
  - getDescription
```
public String getDescription()
```
    The description.
    
    Returns:
    
    The description.
  - withDescription
```
public SavingsPlan withDescription(String description)
```
    The description.
    
    Parameters:
    
    description - The description.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStart
```
public void setStart(String start)
```
    The start time.
    
    Parameters:
    
    start - The start time.
  - getStart
```
public String getStart()
```
    The start time.
    
    Returns:
    
    The start time.
  - withStart
```
public SavingsPlan withStart(String start)
```
    The start time.
    
    Parameters:
    
    start - The start time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnd
```
public void setEnd(String end)
```
    The end time.
    
    Parameters:
    
    end - The end time.
  - getEnd
```
public String getEnd()
```
    The end time.
    
    Returns:
    
    The end time.
  - withEnd
```
public SavingsPlan withEnd(String end)
```
    The end time.
    
    Parameters:
    
    end - The end time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The current state.
    
    Parameters:
    
    state - The current state.
    
    See Also:
    
    SavingsPlanState
  - getState
```
public String getState()
```
    The current state.
    
    Returns:
    
    The current state.
    
    See Also:
    
    SavingsPlanState
  - withState
```
public SavingsPlan withState(String state)
```
    The current state.
    
    Parameters:
    
    state - The current state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SavingsPlanState
  - withState
```
public SavingsPlan withState(SavingsPlanState state)
```
    The current state.
    
    Parameters:
    
    state - The current state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SavingsPlanState
  - setRegion
```
public void setRegion(String region)
```
    The Amazon Web Services Region.
    
    Parameters:
    
    region - The Amazon Web Services Region.
  - getRegion
```
public String getRegion()
```
    The Amazon Web Services Region.
    
    Returns:
    
    The Amazon Web Services Region.
  - withRegion
```
public SavingsPlan withRegion(String region)
```
    The Amazon Web Services Region.
    
    Parameters:
    
    region - The Amazon Web Services Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEc2InstanceFamily
```
public void setEc2InstanceFamily(String ec2InstanceFamily)
```
    The EC2 instance family.
    
    Parameters:
    
    ec2InstanceFamily - The EC2 instance family.
  - getEc2InstanceFamily
```
public String getEc2InstanceFamily()
```
    The EC2 instance family.
    
    Returns:
    
    The EC2 instance family.
  - withEc2InstanceFamily
```
public SavingsPlan withEc2InstanceFamily(String ec2InstanceFamily)
```
    The EC2 instance family.
    
    Parameters:
    
    ec2InstanceFamily - The EC2 instance family.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSavingsPlanType
```
public void setSavingsPlanType(String savingsPlanType)
```
    The plan type.
    
    Parameters:
    
    savingsPlanType - The plan type.
    
    See Also:
    
    SavingsPlanType
  - getSavingsPlanType
```
public String getSavingsPlanType()
```
    The plan type.
    
    Returns:
    
    The plan type.
    
    See Also:
    
    SavingsPlanType
  - withSavingsPlanType
```
public SavingsPlan withSavingsPlanType(String savingsPlanType)
```
    The plan type.
    
    Parameters:
    
    savingsPlanType - The plan type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SavingsPlanType
  - withSavingsPlanType
```
public SavingsPlan withSavingsPlanType(SavingsPlanType savingsPlanType)
```
    The plan type.
    
    Parameters:
    
    savingsPlanType - The plan type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SavingsPlanType
  - setPaymentOption
```
public void setPaymentOption(String paymentOption)
```
    The payment option.
    
    Parameters:
    
    paymentOption - The payment option.
    
    See Also:
    
    SavingsPlanPaymentOption
  - getPaymentOption
```
public String getPaymentOption()
```
    The payment option.
    
    Returns:
    
    The payment option.
    
    See Also:
    
    SavingsPlanPaymentOption
  - withPaymentOption
```
public SavingsPlan withPaymentOption(String paymentOption)
```
    The payment option.
    
    Parameters:
    
    paymentOption - The payment option.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SavingsPlanPaymentOption
  - withPaymentOption
```
public SavingsPlan withPaymentOption(SavingsPlanPaymentOption paymentOption)
```
    The payment option.
    
    Parameters:
    
    paymentOption - The payment option.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SavingsPlanPaymentOption
  - getProductTypes
```
public List<String> getProductTypes()
```
    The product types.
    
    Returns:
    
    The product types.
    
    See Also:
    
    SavingsPlanProductType
  - setProductTypes
```
public void setProductTypes(Collection<String> productTypes)
```
    The product types.
    
    Parameters:
    
    productTypes - The product types.
    
    See Also:
    
    SavingsPlanProductType
  - withProductTypes
```
public SavingsPlan withProductTypes(String... productTypes)
```
    The product types.
    
    NOTE: This method appends the values to the existing list (if any). Use setProductTypes(java.util.Collection) or withProductTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    productTypes - The product types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SavingsPlanProductType
  - withProductTypes
```
public SavingsPlan withProductTypes(Collection<String> productTypes)
```
    The product types.
    
    Parameters:
    
    productTypes - The product types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SavingsPlanProductType
  - withProductTypes
```
public SavingsPlan withProductTypes(SavingsPlanProductType... productTypes)
```
    The product types.
    
    Parameters:
    
    productTypes - The product types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SavingsPlanProductType
  - setCurrency
```
public void setCurrency(String currency)
```
    The currency.
    
    Parameters:
    
    currency - The currency.
    
    See Also:
    
    CurrencyCode
  - getCurrency
```
public String getCurrency()
```
    The currency.
    
    Returns:
    
    The currency.
    
    See Also:
    
    CurrencyCode
  - withCurrency
```
public SavingsPlan withCurrency(String currency)
```
    The currency.
    
    Parameters:
    
    currency - The currency.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CurrencyCode
  - withCurrency
```
public SavingsPlan withCurrency(CurrencyCode currency)
```
    The currency.
    
    Parameters:
    
    currency - The currency.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CurrencyCode
  - setCommitment
```
public void setCommitment(String commitment)
```
    The hourly commitment amount in the specified currency.
    
    Parameters:
    
    commitment - The hourly commitment amount in the specified currency.
  - getCommitment
```
public String getCommitment()
```
    The hourly commitment amount in the specified currency.
    
    Returns:
    
    The hourly commitment amount in the specified currency.
  - withCommitment
```
public SavingsPlan withCommitment(String commitment)
```
    The hourly commitment amount in the specified currency.
    
    Parameters:
    
    commitment - The hourly commitment amount in the specified currency.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpfrontPaymentAmount
```
public void setUpfrontPaymentAmount(String upfrontPaymentAmount)
```
    The up-front payment amount.
    
    Parameters:
    
    upfrontPaymentAmount - The up-front payment amount.
  - getUpfrontPaymentAmount
```
public String getUpfrontPaymentAmount()
```
    The up-front payment amount.
    
    Returns:
    
    The up-front payment amount.
  - withUpfrontPaymentAmount
```
public SavingsPlan withUpfrontPaymentAmount(String upfrontPaymentAmount)
```
    The up-front payment amount.
    
    Parameters:
    
    upfrontPaymentAmount - The up-front payment amount.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRecurringPaymentAmount
```
public void setRecurringPaymentAmount(String recurringPaymentAmount)
```
    The recurring payment amount.
    
    Parameters:
    
    recurringPaymentAmount - The recurring payment amount.
  - getRecurringPaymentAmount
```
public String getRecurringPaymentAmount()
```
    The recurring payment amount.
    
    Returns:
    
    The recurring payment amount.
  - withRecurringPaymentAmount
```
public SavingsPlan withRecurringPaymentAmount(String recurringPaymentAmount)
```
    The recurring payment amount.
    
    Parameters:
    
    recurringPaymentAmount - The recurring payment amount.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTermDurationInSeconds
```
public void setTermDurationInSeconds(Long termDurationInSeconds)
```
    The duration of the term, in seconds.
    
    Parameters:
    
    termDurationInSeconds - The duration of the term, in seconds.
  - getTermDurationInSeconds
```
public Long getTermDurationInSeconds()
```
    The duration of the term, in seconds.
    
    Returns:
    
    The duration of the term, in seconds.
  - withTermDurationInSeconds
```
public SavingsPlan withTermDurationInSeconds(Long termDurationInSeconds)
```
    The duration of the term, in seconds.
    
    Parameters:
    
    termDurationInSeconds - The duration of the term, in seconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    One or more tags.
    
    Returns:
    
    One or more tags.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    One or more tags.
    
    Parameters:
    
    tags - One or more tags.
  - withTags
```
public SavingsPlan withTags(Map<String,String> tags)
```
    One or more tags.
    
    Parameters:
    
    tags - One or more tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public SavingsPlan addTagsEntry(String key,
                                String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public SavingsPlan clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReturnableUntil
```
public void setReturnableUntil(String returnableUntil)
```
    The time until when a return for the Savings Plan can be requested. If the Savings Plan is not returnable, the field reflects the Savings Plan start time.
    
    Parameters:
    
    returnableUntil - The time until when a return for the Savings Plan can be requested. If the Savings Plan is not returnable, the field reflects the Savings Plan start time.
  - getReturnableUntil
```
public String getReturnableUntil()
```
    The time until when a return for the Savings Plan can be requested. If the Savings Plan is not returnable, the field reflects the Savings Plan start time.
    
    Returns:
    
    The time until when a return for the Savings Plan can be requested. If the Savings Plan is not returnable, the field reflects the Savings Plan start time.
  - withReturnableUntil
```
public SavingsPlan withReturnableUntil(String returnableUntil)
```
    The time until when a return for the Savings Plan can be requested. If the Savings Plan is not returnable, the field reflects the Savings Plan start time.
    
    Parameters:
    
    returnableUntil - The time until when a return for the Savings Plan can be requested. If the Savings Plan is not returnable, the field reflects the Savings Plan start time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SavingsPlan clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class SavingsPlan

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SavingsPlan

Method Detail

setOfferingId

getOfferingId

withOfferingId

setSavingsPlanId

getSavingsPlanId

withSavingsPlanId

setSavingsPlanArn

getSavingsPlanArn

withSavingsPlanArn

setDescription

getDescription

withDescription

setStart

getStart

withStart

setEnd

getEnd

withEnd

setState

getState

withState

withState

setRegion

getRegion

withRegion

setEc2InstanceFamily

getEc2InstanceFamily

withEc2InstanceFamily

setSavingsPlanType

getSavingsPlanType

withSavingsPlanType

withSavingsPlanType

setPaymentOption

getPaymentOption

withPaymentOption

withPaymentOption

getProductTypes

setProductTypes

withProductTypes

withProductTypes

withProductTypes

setCurrency

getCurrency

withCurrency

withCurrency

setCommitment

getCommitment

withCommitment

setUpfrontPaymentAmount

getUpfrontPaymentAmount

withUpfrontPaymentAmount

setRecurringPaymentAmount

getRecurringPaymentAmount

withRecurringPaymentAmount

setTermDurationInSeconds

getTermDurationInSeconds

withTermDurationInSeconds

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setReturnableUntil

getReturnableUntil

withReturnableUntil

toString

equals

hashCode

clone

marshall