Class DescribeAgreementResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeAgreementResponse.Builder,
DescribeAgreementResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Instant
The date and time the offer was accepted or the agreement was created.final Acceptor
acceptor()
The details of the party accepting the agreement terms.final String
The unique identifier of the agreement.final String
The type of agreement.builder()
final Instant
endTime()
The date and time when the agreement ends.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final EstimatedCharges
The estimated cost of the agreement.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final ProposalSummary
A summary of the proposal received from the proposer.final Proposer
proposer()
The details of the party proposing the agreement terms.static Class
<? extends DescribeAgreementResponse.Builder> final Instant
The date and time when the agreement starts.final AgreementStatus
status()
The current status of the agreement.final String
The current status of the agreement.Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
acceptanceTime
The date and time the offer was accepted or the agreement was created.
AcceptanceTime
andStartTime
can differ for future dated agreements (FDAs).- Returns:
- The date and time the offer was accepted or the agreement was created.
AcceptanceTime
andStartTime
can differ for future dated agreements (FDAs).
-
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
The unique identifier of the agreement.
- Returns:
- The unique identifier of the agreement.
-
agreementType
The type of agreement. Values are
PurchaseAgreement
orVendorInsightsAgreement
.- Returns:
- The type of agreement. Values are
PurchaseAgreement
orVendorInsightsAgreement
.
-
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
The estimated cost of the agreement.
- Returns:
- The estimated cost of the agreement.
-
proposalSummary
A summary of the proposal received from the proposer.
- Returns:
- A summary of the proposal received from the 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
The date and time when the agreement starts.
- Returns:
- The date and time when the agreement starts.
-
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 returnAgreementStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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
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 returnAgreementStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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
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 interfaceToCopyableBuilder<DescribeAgreementResponse.Builder,
DescribeAgreementResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-