Class RenewalTerm

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

Defines a renewal term that enables automatic agreement renewal.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the term.

      Returns:
      The unique identifier of the term.

    • type

      public final TermType type()

      The category of the term.

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

      Returns:
      The category of the term.
      See Also:

    • typeAsString

      public final String typeAsString()

      The category of the term.

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

      Returns:
      The category of the term.
      See Also:

    • maxRenewals

      public final Integer maxRenewals()

      The maximum number of renewals allowed on this offer. Absent means unlimited renewals.

      Returns:
      The maximum number of renewals allowed on this offer. Absent means unlimited renewals.

    • lockoutPeriod

      public final String lockoutPeriod()

      The duration before the agreement end date when the lockout window begins, in ISO 8601 format (for example, P30D). Absent means no lockout.

      Returns:
      The duration before the agreement end date when the lockout window begins, in ISO 8601 format (for example, P30D). Absent means no lockout.

    • adjustmentDeadline

      public final String adjustmentDeadline()

      The duration before the agreement end date by which the renewal price is finalized, represented in ISO 8601 format (for example, P30D). Only applicable with PercentageRange.

      Returns:
      The duration before the agreement end date by which the renewal price is finalized, represented in ISO 8601 format (for example, P30D). Only applicable with PercentageRange.

    • priceIncrease

      public final PriceIncrease priceIncrease()

      The price increase applied at each renewal cycle. Absent means identical pricing on renewal.

      Returns:
      The price increase applied at each renewal cycle. Absent means identical pricing on renewal.

    • hasTermTemplates

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

    • termTemplates

      public final List<TermTemplate> termTemplates()

      Structural templates defining how specific terms are reshaped on each renewal cycle. Absent for upfront-only offers.

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

      Returns:
      Structural templates defining how specific terms are reshaped on each renewal cycle. Absent for upfront-only offers.

    • toBuilder

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

    • builder

      public static RenewalTerm.Builder builder()

    • serializableBuilderClass

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