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

Class SavingsPlan

java.lang.Object
software.amazon.awssdk.services.savingsplans.model.SavingsPlan
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SavingsPlan.Builder,SavingsPlan>
@Generated("software.amazon.awssdk:codegen") public final class SavingsPlan extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SavingsPlan.Builder,SavingsPlan>

Information about a Savings Plan.

See Also:

  • Method Details

    • 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 current 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 current state.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current 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 current state.
      See Also:

    • region

      public final String region()

      The Amazon Web Services Region.

      Returns:
      The Amazon Web Services 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:

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

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

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

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

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

    • commitment

      public final String commitment()

      The hourly commitment amount in the specified currency.

      Returns:
      The hourly commitment amount in the specified currency.

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

    • returnableUntil

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

      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.

    • toBuilder

      public SavingsPlan.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<SavingsPlan.Builder,SavingsPlan>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.