Class DescribedAgreement
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DescribedAgreement.Builder,
DescribedAgreement>
Describes the properties of an agreement.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Connectors are used to send files using either the AS2 or SFTP protocol.final String
A unique identifier for the agreement.final String
arn()
The unique Amazon Resource Name (ARN) for the agreement.final String
The landing directory (folder) for files that are transferred by using the AS2 protocol.static DescribedAgreement.Builder
builder()
final String
The name or short description that's used to identify the agreement.final boolean
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) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
A unique identifier for the AS2 local profile.final String
A unique identifier for the partner profile used in the agreement.static Class
<? extends DescribedAgreement.Builder> final String
serverId()
A system-assigned unique identifier for a server instance.final AgreementStatusType
status()
The current status of the agreement, eitherACTIVE
orINACTIVE
.final String
The current status of the agreement, eitherACTIVE
orINACTIVE
.tags()
Key-value pairs that can be used to group and search for agreements.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The unique Amazon Resource Name (ARN) for the agreement.
- Returns:
- The unique Amazon Resource Name (ARN) for the agreement.
-
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
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
The current status of the agreement, either
ACTIVE
orINACTIVE
.If the service returns an enum value that is not available in the current SDK version,
status
will returnAgreementStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the agreement, either
ACTIVE
orINACTIVE
. - See Also:
-
statusAsString
The current status of the agreement, either
ACTIVE
orINACTIVE
.If the service returns an enum value that is not available in the current SDK version,
status
will returnAgreementStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the agreement, either
ACTIVE
orINACTIVE
. - See Also:
-
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
A unique identifier for the AS2 local profile.
- Returns:
- A unique identifier for the AS2 local profile.
-
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
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
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, theAccessRole
needs to provide read and write access to the parent directory of the file location used in theStartFileTransfer
request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send withStartFileTransfer
.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 thekms: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 providessecretsmanager: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, theAccessRole
needs to provide read and write access to the parent directory of the file location used in theStartFileTransfer
request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send withStartFileTransfer
.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 thekms: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 providessecretsmanager: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 theisEmpty()
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
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.
-
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<DescribedAgreement.Builder,
DescribedAgreement> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-