Package software.amazon.awssdk.services.transfer.model

Class ListedAgreement

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

Describes the properties of an agreement.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the specified agreement.

      Returns:
      The Amazon Resource Name (ARN) of the specified agreement.

    • agreementId

      public final String agreementId()

      A unique identifier for the agreement. This identifier is returned when you create an agreement.

      Returns:
      A unique identifier for the agreement. This identifier is returned when you create an agreement.

    • description

      public final String description()

      The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.

      Returns:
      The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.

    • status

      public final AgreementStatusType status()

      The agreement can be either ACTIVE or INACTIVE.

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

      Returns:
      The agreement can be either ACTIVE or INACTIVE.
      See Also:

    • statusAsString

      public final String statusAsString()

      The agreement can be either ACTIVE or INACTIVE.

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

      Returns:
      The agreement can be either ACTIVE or INACTIVE.
      See Also:

    • serverId

      public final String serverId()

      The unique identifier for the agreement.

      Returns:
      The unique identifier for the agreement.

    • localProfileId

      public final String localProfileId()

      A unique identifier for the AS2 local profile.

      Returns:
      A unique identifier for the AS2 local profile.

    • partnerProfileId

      public final String partnerProfileId()

      A unique identifier for the partner profile.

      Returns:
      A unique identifier for the partner profile.

    • toBuilder

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

    • builder

      public static ListedAgreement.Builder builder()

    • serializableBuilderClass

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