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, version, proposer, and acceptor).

See Also:

  • Method Details

    • acceptanceTime

      public final Instant acceptanceTime()

      The date and time that the agreement was accepted.

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

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

    • agreementId

      public final String agreementId()

      The unique identifier of the agreement.

      Returns:
      The unique identifier of the agreement.

    • agreementType

      public final String agreementType()

      The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.

      Returns:
      The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.

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

    • proposalSummary

      public final ProposalSummary proposalSummary()

      A summary of the proposal

      Returns:
      A summary of the proposal

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

    • startTime

      public final Instant startTime()

      The date and time when the agreement starts.

      Returns:
      The date and time when the agreement starts.

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

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