Class AgreementViewSummary

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

A summary of the agreement, including top-level attributes (for example, the agreement ID, proposer, and acceptor).

See Also:

  • Method Details

    • agreementId

      public final String agreementId()

      The unique identifier of the agreement.

      Returns:
      The unique identifier of the agreement.

    • acceptanceTime

      public final Instant acceptanceTime()

      The date and time that the agreement was accepted.

      Returns:
      The date and time that the agreement was accepted.

    • startTime

      public final Instant startTime()

      The date and time when the agreement starts.

      Returns:
      The date and time when the agreement starts.

    • endTime

      public final Instant endTime()

      The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.

      Returns:
      The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.

    • lastUpdateTime

      public final Instant lastUpdateTime()

      The date and time when the agreement was last updated. An agreement is updated when any of its attributes or accepted terms change. Amendments, renewals, and a party changing whether the agreement renews are all examples.

      Use the BeforeLastUpdateTime and AfterLastUpdateTime filters to search on this value, and LastUpdateTime as the SortBy value to sort by it. Sorting by LastUpdateTime is supported only when PartyType is Proposer.

      Returns:
      The date and time when the agreement was last updated. An agreement is updated when any of its attributes or accepted terms change. Amendments, renewals, and a party changing whether the agreement renews are all examples.

      Use the BeforeLastUpdateTime and AfterLastUpdateTime filters to search on this value, and LastUpdateTime as the SortBy value to sort by it. Sorting by LastUpdateTime is supported only when PartyType is Proposer.

    • agreementType

      public final String agreementType()

      The type of agreement.

      Returns:
      The type of agreement.

    • acceptor

      public final Acceptor acceptor()

      Details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

      Returns:
      Details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

    • proposer

      public final Proposer proposer()

      Details of the party proposing the agreement terms, most commonly the seller for PurchaseAgreement.

      Returns:
      Details of the party proposing the agreement terms, most commonly the seller for PurchaseAgreement.

    • proposalSummary

      public final ProposalSummary proposalSummary()

      A summary of the proposal

      Returns:
      A summary of the proposal

    • status

      public final AgreementStatus status()

      The current status of the agreement.

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

      Returns:
      The current status of the agreement.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the agreement.

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

      Returns:
      The current status of the agreement.
      See Also:

    • hasEntitlements

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

    • entitlements

      public final List<Entitlement> entitlements()

      A list of entitlements associated with the agreement.

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

      Returns:
      A list of entitlements associated with the agreement.

    • initialAgreementId

      public final String initialAgreementId()

      The unique identifier of the very first agreement in a chain of related agreements, such as renewals or replacements. It stays the same across all agreements in that chain, which lets you trace an agreement back to the original. You can also use it as the InitialAgreementId filter value to return every agreement in the same chain.

      Returns:
      The unique identifier of the very first agreement in a chain of related agreements, such as renewals or replacements. It stays the same across all agreements in that chain, which lets you trace an agreement back to the original. You can also use it as the InitialAgreementId filter value to return every agreement in the same chain.

    • endTimeBehaviorType

      public final EndTimeBehaviorType endTimeBehaviorType()

      The behavior of the agreement when it reaches its end date. The field is null for agreements that have no end date, because those agreements never reach an end time.

      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, endTimeBehaviorType will return EndTimeBehaviorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endTimeBehaviorTypeAsString().

      Returns:
      The behavior of the agreement when it reaches its end date. The field is null for agreements that have no end date, because those agreements never reach an end time.

      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:

    • endTimeBehaviorTypeAsString

      public final String endTimeBehaviorTypeAsString()

      The behavior of the agreement when it reaches its end date. The field is null for agreements that have no end date, because those agreements never reach an end time.

      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, endTimeBehaviorType will return EndTimeBehaviorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endTimeBehaviorTypeAsString().

      Returns:
      The behavior of the agreement when it reaches its end date. The field is null for agreements that have no end date, because those agreements never reach an end time.

      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:

    • endTimeBehaviorReasonCode

      public final EndTimeBehaviorReasonCode endTimeBehaviorReasonCode()

      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, endTimeBehaviorReasonCode will return EndTimeBehaviorReasonCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endTimeBehaviorReasonCodeAsString().

      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:

    • endTimeBehaviorReasonCodeAsString

      public final String endTimeBehaviorReasonCodeAsString()

      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, endTimeBehaviorReasonCode will return EndTimeBehaviorReasonCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endTimeBehaviorReasonCodeAsString().

      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:

    • toBuilder

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

    • builder

      public static AgreementViewSummary.Builder builder()

    • serializableBuilderClass

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