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

Class SavingsPlanOffering

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

Information about a Savings Plan offering.

See Also:

  • Method Details

    • offeringId

      public final String offeringId()

      The ID of the offering.

      Returns:
      The ID of the offering.

    • productTypes

      public final List<SavingsPlanProductType> productTypes()

      The product type.

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

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

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

    • planType

      public final SavingsPlanType planType()

      The plan type.

      If the service returns an enum value that is not available in the current SDK version, planType will return SavingsPlanType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from planTypeAsString().

      Returns:
      The plan type.
      See Also:

    • planTypeAsString

      public final String planTypeAsString()

      The plan type.

      If the service returns an enum value that is not available in the current SDK version, planType will return SavingsPlanType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from planTypeAsString().

      Returns:
      The plan type.
      See Also:

    • description

      public final String description()

      The description.

      Returns:
      The description.

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

    • durationSeconds

      public final Long durationSeconds()

      The duration, in seconds.

      Returns:
      The duration, in seconds.

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

    • serviceCode

      public final String serviceCode()

      The service.

      Returns:
      The service.

    • usageType

      public final String usageType()

      The usage details of the line item in the billing report.

      Returns:
      The usage details of the line item in the billing report.

    • operation

      public final String operation()

      The specific Amazon Web Services operation for the line item in the billing report.

      Returns:
      The specific Amazon Web Services operation for the line item in the billing report.

    • hasProperties

      public final boolean hasProperties()
      For responses, this returns true if the service returned a value for the Properties 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.

    • properties

      public final List<SavingsPlanOfferingProperty> properties()

      The properties.

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

      Returns:
      The properties.

    • toBuilder

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

    • builder

      public static SavingsPlanOffering.Builder builder()

    • serializableBuilderClass

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