Class SendAgreementCancellationRequestResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SendAgreementCancellationRequestResponse.Builder,SendAgreementCancellationRequestResponse>

@Generated("software.amazon.awssdk:codegen")
public final class SendAgreementCancellationRequestResponse
extends MarketplaceAgreementResponse
implements ToCopyableBuilder<SendAgreementCancellationRequestResponse.Builder,SendAgreementCancellationRequestResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SendAgreementCancellationRequestResponse.Builder

Method Summary

Modifier and Type	Method	Description
final String	agreementCancellationRequestId()	The unique identifier for the created cancellation request.
final String	agreementId()	The unique identifier of the agreement.
static SendAgreementCancellationRequestResponse.Builder	builder()
final Instant	createdAt()	The time when the cancellation request was created.
final String	description()	The detailed description of the cancellation reason, if provided.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)	Used to retrieve the value of a field from any class that extends SdkResponse.
final int	hashCode()
final AgreementCancellationRequestReasonCode	reasonCode()	The reason code provided for the cancellation.
final String	reasonCodeAsString()	The reason code provided for the cancellation.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends SendAgreementCancellationRequestResponse.Builder>	serializableBuilderClass()
final AgreementCancellationRequestStatus	status()	The current status of the cancellation request.
final String	statusAsString()	The current status of the cancellation request.
SendAgreementCancellationRequestResponse.Builder	toBuilder()	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.
final Instant	updatedAt()	The time when the cancellation request was last updated.

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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

agreementId

public final String agreementId()

The unique identifier of the agreement.

Returns:

The unique identifier of the agreement.

agreementCancellationRequestId

public final String agreementCancellationRequestId()

The unique identifier for the created cancellation request.

Returns:

The unique identifier for the created cancellation request.

status

public final AgreementCancellationRequestStatus status()

The current status of the cancellation request. The initial status is PENDING_APPROVAL.

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

Returns:

The current status of the cancellation request. The initial status is PENDING_APPROVAL.

See Also:

• AgreementCancellationRequestStatus

statusAsString

public final String statusAsString()

The current status of the cancellation request. The initial status is PENDING_APPROVAL.

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

Returns:

The current status of the cancellation request. The initial status is PENDING_APPROVAL.

See Also:

• AgreementCancellationRequestStatus

reasonCode

public final AgreementCancellationRequestReasonCode reasonCode()

The reason code provided for the cancellation.

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

Returns:

The reason code provided for the cancellation.

See Also:

• AgreementCancellationRequestReasonCode

reasonCodeAsString

public final String reasonCodeAsString()

The reason code provided for the cancellation.

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

Returns:

The reason code provided for the cancellation.

See Also:

• AgreementCancellationRequestReasonCode

description

public final String description()

The detailed description of the cancellation reason, if provided.

Returns:

The detailed description of the cancellation reason, if provided.

createdAt

public final Instant createdAt()

The time when the cancellation request was created.

Returns:

The time when the cancellation request was created.

updatedAt

public final Instant updatedAt()

The time when the cancellation request was last updated.

Returns:

The time when the cancellation request was last updated.

toBuilder

public SendAgreementCancellationRequestResponse.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<SendAgreementCancellationRequestResponse.Builder,SendAgreementCancellationRequestResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static SendAgreementCancellationRequestResponse.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.