Class PreferredCommitment

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

The preferred configuration for Reserved Instances and Savings Plans commitment-based discounts, consisting of a payment option and a commitment duration.

See Also:

  • Method Details

    • term

      public final Term term()

      The preferred length of the commitment period. If the value is null, it will default to ThreeYears (highest savings) where applicable.

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

      Returns:
      The preferred length of the commitment period. If the value is null, it will default to ThreeYears (highest savings) where applicable.
      See Also:

    • termAsString

      public final String termAsString()

      The preferred length of the commitment period. If the value is null, it will default to ThreeYears (highest savings) where applicable.

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

      Returns:
      The preferred length of the commitment period. If the value is null, it will default to ThreeYears (highest savings) where applicable.
      See Also:

    • paymentOption

      public final PaymentOption paymentOption()

      The preferred upfront payment structure for commitments. If the value is null, it will default to AllUpfront (highest savings) where applicable.

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

      Returns:
      The preferred upfront payment structure for commitments. If the value is null, it will default to AllUpfront (highest savings) where applicable.
      See Also:

    • paymentOptionAsString

      public final String paymentOptionAsString()

      The preferred upfront payment structure for commitments. If the value is null, it will default to AllUpfront (highest savings) where applicable.

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

      Returns:
      The preferred upfront payment structure for commitments. If the value is null, it will default to AllUpfront (highest savings) where applicable.
      See Also:

    • toBuilder

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

    • builder

      public static PreferredCommitment.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.