Class EndTimeBehavior

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

The behavior of an agreement when it reaches its end date. For example, whether the agreement renews, and if it doesn't, the reason why.

See Also:

  • Method Details

    • type

      public final EndTimeBehaviorType type()

      The behavior of the agreement when it reaches its end date.

      Types include:

      • RENEW – A new agreement is created from the accepted terms of this agreement.

      • REPLACE – A new agreement is created from a different offer than the one this agreement was created from. This happens, for example, when a private offer reaches its end date and the acceptor transitions to the public offer for the product.

      • EXPIRE – The agreement ends and isn't renewed or replaced.

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

      Returns:
      The behavior of the agreement when it reaches its end date.

      Types include:

      • RENEW – A new agreement is created from the accepted terms of this agreement.

      • REPLACE – A new agreement is created from a different offer than the one this agreement was created from. This happens, for example, when a private offer reaches its end date and the acceptor transitions to the public offer for the product.

      • EXPIRE – The agreement ends and isn't renewed or replaced.

      See Also:

    • typeAsString

      public final String typeAsString()

      The behavior of the agreement when it reaches its end date.

      Types include:

      • RENEW – A new agreement is created from the accepted terms of this agreement.

      • REPLACE – A new agreement is created from a different offer than the one this agreement was created from. This happens, for example, when a private offer reaches its end date and the acceptor transitions to the public offer for the product.

      • EXPIRE – The agreement ends and isn't renewed or replaced.

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

      Returns:
      The behavior of the agreement when it reaches its end date.

      Types include:

      • RENEW – A new agreement is created from the accepted terms of this agreement.

      • REPLACE – A new agreement is created from a different offer than the one this agreement was created from. This happens, for example, when a private offer reaches its end date and the acceptor transitions to the public offer for the product.

      • EXPIRE – The agreement ends and isn't renewed or replaced.

      See Also:

    • reasonCode

      public final EndTimeBehaviorReasonCode reasonCode()

      The reason why the agreement doesn't renew at its end date. The field is null when the agreement renews.

      More than one reason can apply to the same agreement. When that happens, the operation returns only one reason code, and PROPOSER_RENEW_OPTED_OUT takes precedence over all others.

      The EnableAutoRenew field reflects only the acceptor's preference, and doesn't reflect the other reasons an agreement might not renew.

      Reason codes include:

      • PROPOSER_RENEW_OPTED_OUT – The proposer opted out of renewing the agreement.

      • ACCEPTOR_RENEW_OPTED_OUT – The acceptor opted out of renewing the agreement.

      • NO_RENEWAL_TERM – The accepted terms of the agreement don't include a renewal term, which is required for an agreement to renew.

      • RENEWAL_LIMIT_EXHAUSTED – The agreement reached the maximum number of renewals allowed by its renewal term.

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

      Returns:
      The reason why the agreement doesn't renew at its end date. The field is null when the agreement renews.

      More than one reason can apply to the same agreement. When that happens, the operation returns only one reason code, and PROPOSER_RENEW_OPTED_OUT takes precedence over all others.

      The EnableAutoRenew field reflects only the acceptor's preference, and doesn't reflect the other reasons an agreement might not renew.

      Reason codes include:

      • PROPOSER_RENEW_OPTED_OUT – The proposer opted out of renewing the agreement.

      • ACCEPTOR_RENEW_OPTED_OUT – The acceptor opted out of renewing the agreement.

      • NO_RENEWAL_TERM – The accepted terms of the agreement don't include a renewal term, which is required for an agreement to renew.

      • RENEWAL_LIMIT_EXHAUSTED – The agreement reached the maximum number of renewals allowed by its renewal term.

      See Also:

    • reasonCodeAsString

      public final String reasonCodeAsString()

      The reason why the agreement doesn't renew at its end date. The field is null when the agreement renews.

      More than one reason can apply to the same agreement. When that happens, the operation returns only one reason code, and PROPOSER_RENEW_OPTED_OUT takes precedence over all others.

      The EnableAutoRenew field reflects only the acceptor's preference, and doesn't reflect the other reasons an agreement might not renew.

      Reason codes include:

      • PROPOSER_RENEW_OPTED_OUT – The proposer opted out of renewing the agreement.

      • ACCEPTOR_RENEW_OPTED_OUT – The acceptor opted out of renewing the agreement.

      • NO_RENEWAL_TERM – The accepted terms of the agreement don't include a renewal term, which is required for an agreement to renew.

      • RENEWAL_LIMIT_EXHAUSTED – The agreement reached the maximum number of renewals allowed by its renewal term.

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

      Returns:
      The reason why the agreement doesn't renew at its end date. The field is null when the agreement renews.

      More than one reason can apply to the same agreement. When that happens, the operation returns only one reason code, and PROPOSER_RENEW_OPTED_OUT takes precedence over all others.

      The EnableAutoRenew field reflects only the acceptor's preference, and doesn't reflect the other reasons an agreement might not renew.

      Reason codes include:

      • PROPOSER_RENEW_OPTED_OUT – The proposer opted out of renewing the agreement.

      • ACCEPTOR_RENEW_OPTED_OUT – The acceptor opted out of renewing the agreement.

      • NO_RENEWAL_TERM – The accepted terms of the agreement don't include a renewal term, which is required for an agreement to renew.

      • RENEWAL_LIMIT_EXHAUSTED – The agreement reached the maximum number of renewals allowed by its renewal term.

      See Also:

    • renewalSummary

      public final RenewalSummary renewalSummary()

      The details of the renewal that applies at the end date of the agreement. This field is present when Type is RENEW. It is also present when ReasonCode is PROPOSER_RENEW_OPTED_OUT or ACCEPTOR_RENEW_OPTED_OUT. In those cases, it identifies the offer that the agreement would otherwise have renewed from. The field is null in all other cases.

      Returns:
      The details of the renewal that applies at the end date of the agreement. This field is present when Type is RENEW. It is also present when ReasonCode is PROPOSER_RENEW_OPTED_OUT or ACCEPTOR_RENEW_OPTED_OUT. In those cases, it identifies the offer that the agreement would otherwise have renewed from. The field is null in all other cases.

    • toBuilder

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

    • builder

      public static EndTimeBehavior.Builder builder()

    • serializableBuilderClass

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