software.amazon.awssdk.services.transfer.model

Interface CreateAgreementRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateAgreementRequest

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

Method Summary

Modifier and Type	Method and Description
CreateAgreementRequest.Builder	accessRole(String accessRole) With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths.
CreateAgreementRequest.Builder	baseDirectory(String baseDirectory) The landing directory (folder) for files transferred by using the AS2 protocol.
CreateAgreementRequest.Builder	description(String description) A name or short description to identify the agreement.
CreateAgreementRequest.Builder	localProfileId(String localProfileId) A unique identifier for the AS2 local profile.
CreateAgreementRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateAgreementRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateAgreementRequest.Builder	partnerProfileId(String partnerProfileId) A unique identifier for the partner profile used in the agreement.
CreateAgreementRequest.Builder	serverId(String serverId) A system-assigned unique identifier for a server instance.
CreateAgreementRequest.Builder	status(AgreementStatusType status) The status of the agreement.
CreateAgreementRequest.Builder	status(String status) The status of the agreement.
CreateAgreementRequest.Builder	tags(Collection<Tag> tags) Key-value pairs that can be used to group and search for agreements.
CreateAgreementRequest.Builder	tags(Consumer<Tag.Builder>... tags) Key-value pairs that can be used to group and search for agreements.
CreateAgreementRequest.Builder	tags(Tag... tags) Key-value pairs that can be used to group and search for agreements.

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

description

CreateAgreementRequest.Builder description(String description)

A name or short description to identify the agreement.

Parameters:

description - A name or short description to identify the agreement.

Returns:

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

serverId

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

localProfileId

CreateAgreementRequest.Builder localProfileId(String localProfileId)

A unique identifier for the AS2 local profile.

Parameters:

localProfileId - A unique identifier for the AS2 local profile.

Returns:

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

partnerProfileId

CreateAgreementRequest.Builder partnerProfileId(String partnerProfileId)

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

Parameters:

partnerProfileId - A unique identifier for the partner profile used in the agreement.

Returns:

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

baseDirectory

CreateAgreementRequest.Builder baseDirectory(String baseDirectory)

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

A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.

Parameters:

baseDirectory - The landing directory (folder) for files transferred by using the AS2 protocol.

A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.

Returns:

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

accessRole

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

status

CreateAgreementRequest.Builder status(String status)

The status of the agreement. The agreement can be either ACTIVE or INACTIVE.

Parameters:

status - The status of the agreement. The agreement can be either ACTIVE or INACTIVE.

Returns:

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

See Also:

AgreementStatusType, AgreementStatusType

status

CreateAgreementRequest.Builder status(AgreementStatusType status)

The status of the agreement. The agreement can be either ACTIVE or INACTIVE.

Parameters:

status - The status of the agreement. The agreement can be either ACTIVE or INACTIVE.

Returns:

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

See Also:

AgreementStatusType, AgreementStatusType

tags

CreateAgreementRequest.Builder tags(Collection<Tag> tags)

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

Parameters:

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

Returns:

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

tags

CreateAgreementRequest.Builder tags(Tag... tags)

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

Parameters:

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

Returns:

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

tags

CreateAgreementRequest.Builder tags(Consumer<Tag.Builder>... tags)

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

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

overrideConfiguration

CreateAgreementRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder