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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeAgreementResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Instant`	`acceptanceTime()`	The date and time the offer was accepted or the agreement was created.
`Acceptor`	`acceptor()`	The details of the party accepting the agreement terms.
`String`	`agreementId()`	The unique identifier of the agreement.
`String`	`agreementType()`	The type of agreement.
`static DescribeAgreementResponse.Builder`	`builder()`
`Instant`	`endTime()`	The date and time when the agreement ends.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`EstimatedCharges`	`estimatedCharges()`	The estimated cost of the agreement.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`ProposalSummary`	`proposalSummary()`	A summary of the proposal received from the proposer.
`Proposer`	`proposer()`	The details of the party proposing the agreement terms.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeAgreementResponse.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()`	The date and time when the agreement starts.
`AgreementStatus`	`status()`	The current status of the agreement.
`String`	`statusAsString()`	The current status of the agreement.
`DescribeAgreementResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.marketplaceagreement.model.MarketplaceAgreementResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    AgreementStatus
  - 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:
    
    AgreementStatus
  - toBuilder
```
public DescribeAgreementResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeAgreementResponse.Builder,DescribeAgreementResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeAgreementResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.marketplaceagreement.model.MarketplaceAgreementResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

acceptanceTime

acceptor

agreementId

agreementType

endTime

estimatedCharges

proposalSummary

proposer

startTime

status

statusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields