Class UpdateAgreementRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateAgreementRequest.Builder,
UpdateAgreementRequest>
-
Nested Class Summary
Nested Classes -
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
To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example,/DOC-EXAMPLE-BUCKET/home/mydirectory
.builder()
final String
To replace the existing description, provide a short description for 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) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
A unique identifier for the AS2 local profile.final String
A unique identifier for the partner profile.static Class
<? extends UpdateAgreementRequest.Builder> final String
serverId()
A system-assigned unique identifier for a server instance.final AgreementStatusType
status()
You can update the status for the agreement, either activating an inactive agreement or the reverse.final String
You can update the status for the agreement, either activating an inactive agreement or the reverse.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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
-
serverId
A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
- Returns:
- A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
-
description
To replace the existing description, provide a short description for the agreement.
- Returns:
- To replace the existing description, provide a short description for the agreement.
-
status
You can update the status for the agreement, either activating an inactive agreement or the reverse.
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:
- You can update the status for the agreement, either activating an inactive agreement or the reverse.
- See Also:
-
statusAsString
You can update the status for the agreement, either activating an inactive agreement or the reverse.
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:
- You can update the status for the agreement, either activating an inactive agreement or the reverse.
- See Also:
-
localProfileId
A unique identifier for the AS2 local profile.
To change the local profile identifier, provide a new value here.
- Returns:
- A unique identifier for the AS2 local profile.
To change the local profile identifier, provide a new value here.
-
partnerProfileId
A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.
- Returns:
- A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.
-
baseDirectory
To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example,
/DOC-EXAMPLE-BUCKET/home/mydirectory
.- Returns:
- To change the landing directory (folder) for files that are transferred, provide the bucket folder that
you want to use; for example,
/DOC-EXAMPLE-BUCKET/home/mydirectory
.
-
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.
-
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<UpdateAgreementRequest.Builder,
UpdateAgreementRequest> - Specified by:
toBuilder
in classTransferRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-