Class DescribeAgreementResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.marketplaceagreement.model.MarketplaceAgreementResponse
software.amazon.awssdk.services.marketplaceagreement.model.DescribeAgreementResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeAgreementResponse.Builder,DescribeAgreementResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeAgreementResponse extends MarketplaceAgreementResponse implements ToCopyableBuilder<DescribeAgreementResponse.Builder,DescribeAgreementResponse>

  • Method Details

    • acceptanceTime

      public final Instant acceptanceTime()

      The date and time the offer was accepted or the agreement was created.

      AcceptanceTime and StartTime can differ for future dated agreements (FDAs).

      Returns:
      The date and time the offer was accepted or the agreement was created.

      AcceptanceTime and StartTime can differ for future dated agreements (FDAs).

    • acceptor

      public final Acceptor acceptor()

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

      Returns:
      The 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.

    • estimatedCharges

      public final EstimatedCharges estimatedCharges()

      The estimated cost of the agreement.

      Returns:
      The estimated cost of the agreement.

    • proposalSummary

      public final ProposalSummary proposalSummary()

      A summary of the proposal received from the proposer.

      Returns:
      A summary of the proposal received from the proposer.

    • proposer

      public final Proposer proposer()

      The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.

      Returns:
      The details of the party proposing the agreement terms. This is 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.

      Statuses include:

      • ACTIVE – The terms of the agreement are active.

      • ARCHIVED – The agreement ended without a specified reason.

      • CANCELLED – The acceptor ended the agreement before the defined end date.

      • EXPIRED – The agreement ended on the defined end date.

      • RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).

      • REPLACED – The agreement was replaced using an agreement replacement offer.

      • ROLLED_BACK (Only applicable to inactive agreement revisions) – The agreement revision has been rolled back because of an error. An earlier revision is now active.

      • SUPERCEDED (Only applicable to inactive agreement revisions) – The agreement revision is no longer active and another agreement revision is now active.

      • TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).

      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.

      Statuses include:

      • ACTIVE – The terms of the agreement are active.

      • ARCHIVED – The agreement ended without a specified reason.

      • CANCELLED – The acceptor ended the agreement before the defined end date.

      • EXPIRED – The agreement ended on the defined end date.

      • RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).

      • REPLACED – The agreement was replaced using an agreement replacement offer.

      • ROLLED_BACK (Only applicable to inactive agreement revisions) – The agreement revision has been rolled back because of an error. An earlier revision is now active.

      • SUPERCEDED (Only applicable to inactive agreement revisions) – The agreement revision is no longer active and another agreement revision is now active.

      • TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the agreement.

      Statuses include:

      • ACTIVE – The terms of the agreement are active.

      • ARCHIVED – The agreement ended without a specified reason.

      • CANCELLED – The acceptor ended the agreement before the defined end date.

      • EXPIRED – The agreement ended on the defined end date.

      • RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).

      • REPLACED – The agreement was replaced using an agreement replacement offer.

      • ROLLED_BACK (Only applicable to inactive agreement revisions) – The agreement revision has been rolled back because of an error. An earlier revision is now active.

      • SUPERCEDED (Only applicable to inactive agreement revisions) – The agreement revision is no longer active and another agreement revision is now active.

      • TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).

      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.

      Statuses include:

      • ACTIVE – The terms of the agreement are active.

      • ARCHIVED – The agreement ended without a specified reason.

      • CANCELLED – The acceptor ended the agreement before the defined end date.

      • EXPIRED – The agreement ended on the defined end date.

      • RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).

      • REPLACED – The agreement was replaced using an agreement replacement offer.

      • ROLLED_BACK (Only applicable to inactive agreement revisions) – The agreement revision has been rolled back because of an error. An earlier revision is now active.

      • SUPERCEDED (Only applicable to inactive agreement revisions) – The agreement revision is no longer active and another agreement revision is now active.

      • TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).

      See Also:

    • toBuilder

      public DescribeAgreementResponse.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<DescribeAgreementResponse.Builder,DescribeAgreementResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeAgreementResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeAgreementResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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