software.amazon.awssdk.services.transfer.model

Interface UpdateAgreementRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateAgreementRequest.Builder,UpdateAgreementRequest>, SdkBuilder<UpdateAgreementRequest.Builder,UpdateAgreementRequest>, SdkPojo, SdkRequest.Builder, TransferRequest.Builder

Enclosing class:

UpdateAgreementRequest

public static interface UpdateAgreementRequest.Builder
extends TransferRequest.Builder, SdkPojo, CopyableBuilder<UpdateAgreementRequest.Builder,UpdateAgreementRequest>

Method Summary

Modifier and Type	Method and Description
UpdateAgreementRequest.Builder	accessRole(String accessRole) With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths.
UpdateAgreementRequest.Builder	agreementId(String agreementId) A unique identifier for the agreement.
UpdateAgreementRequest.Builder	baseDirectory(String 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 .
UpdateAgreementRequest.Builder	description(String description) To replace the existing description, provide a short description for the agreement.
UpdateAgreementRequest.Builder	localProfileId(String localProfileId) A unique identifier for the AS2 local profile.
UpdateAgreementRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateAgreementRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateAgreementRequest.Builder	partnerProfileId(String partnerProfileId) A unique identifier for the partner profile.
UpdateAgreementRequest.Builder	serverId(String serverId) A system-assigned unique identifier for a server instance.
UpdateAgreementRequest.Builder	status(AgreementStatusType status) You can update the status for the agreement, either activating an inactive agreement or the reverse.
UpdateAgreementRequest.Builder	status(String status) You can update the status for the agreement, either activating an inactive agreement or the reverse.

Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

agreementId

UpdateAgreementRequest.Builder agreementId(String agreementId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

serverId

UpdateAgreementRequest.Builder serverId(String serverId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

description

UpdateAgreementRequest.Builder description(String description)

To replace the existing description, provide a short description for the agreement.

Parameters:

description - To replace the existing description, provide a short description for the agreement.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

UpdateAgreementRequest.Builder status(String status)

You can update the status for the agreement, either activating an inactive agreement or the reverse.

Parameters:

status - You can update the status for the agreement, either activating an inactive agreement or the reverse.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AgreementStatusType, AgreementStatusType

status

UpdateAgreementRequest.Builder status(AgreementStatusType status)

You can update the status for the agreement, either activating an inactive agreement or the reverse.

Parameters:

status - You can update the status for the agreement, either activating an inactive agreement or the reverse.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AgreementStatusType, AgreementStatusType

localProfileId

UpdateAgreementRequest.Builder localProfileId(String localProfileId)

A unique identifier for the AS2 local profile.

To change the local profile identifier, provide a new value here.

Parameters:

localProfileId - A unique identifier for the AS2 local profile.

To change the local profile identifier, provide a new value here.

Returns:

Returns a reference to this object so that method calls can be chained together.

partnerProfileId

UpdateAgreementRequest.Builder partnerProfileId(String partnerProfileId)

A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

Parameters:

partnerProfileId - A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

Returns:

Returns a reference to this object so that method calls can be chained together.

baseDirectory

UpdateAgreementRequest.Builder baseDirectory(String 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 .

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

accessRole

UpdateAgreementRequest.Builder accessRole(String accessRole)

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.

Parameters:

accessRole - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

UpdateAgreementRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateAgreementRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder