Class AgreementCancellationRequestSummary

java.lang.Object
software.amazon.awssdk.services.marketplaceagreement.model.AgreementCancellationRequestSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AgreementCancellationRequestSummary.Builder,AgreementCancellationRequestSummary>
@Generated("software.amazon.awssdk:codegen") public final class AgreementCancellationRequestSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AgreementCancellationRequestSummary.Builder,AgreementCancellationRequestSummary>

Summary view of an agreement cancellation request.

See Also:

  • Method Details

    • agreementCancellationRequestId

      public final String agreementCancellationRequestId()

      The unique identifier of the cancellation request.

      Returns:
      The unique identifier of the cancellation request.

    • agreementId

      public final String agreementId()

      The unique identifier of the agreement associated with this cancellation request.

      Returns:
      The unique identifier of the agreement associated with this cancellation request.

    • status

      public final AgreementCancellationRequestStatus status()

      The current status of the cancellation request. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED, and VALIDATION_FAILED.

      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. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED, and VALIDATION_FAILED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the cancellation request. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED, and VALIDATION_FAILED.

      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. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED, and VALIDATION_FAILED.
      See Also:

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

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

    • agreementType

      public final String agreementType()

      The type of agreement.

      Returns:
      The type of agreement.

    • catalog

      public final String catalog()

      The catalog in which the agreement was created.

      Returns:
      The catalog in which the agreement was created.

    • createdAt

      public final Instant createdAt()

      The date and time when the cancellation request was created, as a POSIX timestamp (Unix epoch seconds).

      Returns:
      The date and time when the cancellation request was created, as a POSIX timestamp (Unix epoch seconds).

    • updatedAt

      public final Instant updatedAt()

      The date and time when the cancellation request was last updated, as a POSIX timestamp (Unix epoch seconds).

      Returns:
      The date and time when the cancellation request was last updated, as a POSIX timestamp (Unix epoch seconds).

    • toBuilder

      public AgreementCancellationRequestSummary.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<AgreementCancellationRequestSummary.Builder,AgreementCancellationRequestSummary>
      Returns:
      a builder for type T

    • builder

      public static AgreementCancellationRequestSummary.Builder builder()

    • serializableBuilderClass

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