Class DescribedAgreement

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

Describes the properties of an agreement.

See Also:

  • Method Details

    • arn

      public final String arn()

      The unique Amazon Resource Name (ARN) for the agreement.

      Returns:
      The unique Amazon Resource Name (ARN) for the 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 name or short description that's used to identify the agreement.

      Returns:
      The name or short description that's used to identify the agreement.

    • status

      public final AgreementStatusType status()

      The current status of the agreement, 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 current status of the agreement, either ACTIVE or INACTIVE.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the agreement, 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 current status of the agreement, either ACTIVE or INACTIVE.
      See Also:

    • serverId

      public final String serverId()

      A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

      Returns:
      A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

    • 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 used in the agreement.

      Returns:
      A unique identifier for the partner profile used in the agreement.

    • baseDirectory

      public final String baseDirectory()

      The landing directory (folder) for files that are transferred by using the AS2 protocol.

      Returns:
      The landing directory (folder) for files that are transferred by using the AS2 protocol.

    • accessRole

      public final String accessRole()

      Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

      For AS2 connectors

      With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

      If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

      For SFTP connectors

      Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

      Returns:
      Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

      For AS2 connectors

      With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

      If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

      For SFTP connectors

      Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Key-value pairs that can be used to group and search for agreements.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Key-value pairs that can be used to group and search for agreements.

    • preserveFilename

      public final PreserveFilenameType preserveFilename()

      Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

      • ENABLED: the filename provided by your trading parter is preserved when the file is saved.

      • DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

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

      Returns:
      Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

      • ENABLED: the filename provided by your trading parter is preserved when the file is saved.

      • DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

      See Also:

    • preserveFilenameAsString

      public final String preserveFilenameAsString()

      Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

      • ENABLED: the filename provided by your trading parter is preserved when the file is saved.

      • DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

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

      Returns:
      Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

      • ENABLED: the filename provided by your trading parter is preserved when the file is saved.

      • DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

      See Also:

    • enforceMessageSigning

      public final EnforceMessageSigningType enforceMessageSigning()

      Determines whether or not unsigned messages from your trading partners will be accepted.

      • ENABLED: Transfer Family rejects unsigned messages from your trading partner.

      • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

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

      Returns:
      Determines whether or not unsigned messages from your trading partners will be accepted.

      • ENABLED: Transfer Family rejects unsigned messages from your trading partner.

      • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

      See Also:

    • enforceMessageSigningAsString

      public final String enforceMessageSigningAsString()

      Determines whether or not unsigned messages from your trading partners will be accepted.

      • ENABLED: Transfer Family rejects unsigned messages from your trading partner.

      • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

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

      Returns:
      Determines whether or not unsigned messages from your trading partners will be accepted.

      • ENABLED: Transfer Family rejects unsigned messages from your trading partner.

      • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

      See Also:

    • customDirectories

      public final CustomDirectoriesType customDirectories()

      A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

      • Failed files

      • MDN files

      • Payload files

      • Status files

      • Temporary files

      Returns:
      A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

      • Failed files

      • MDN files

      • Payload files

      • Status files

      • Temporary files

    • toBuilder

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

    • builder

      public static DescribedAgreement.Builder builder()

    • serializableBuilderClass

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