software.amazon.awssdk.services.transfer.model

Interface DescribedProfile.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DescribedProfile.Builder,DescribedProfile>, SdkBuilder<DescribedProfile.Builder,DescribedProfile>, SdkPojo

Enclosing class:

DescribedProfile

public static interface DescribedProfile.Builder
extends SdkPojo, CopyableBuilder<DescribedProfile.Builder,DescribedProfile>

Method Summary

Modifier and Type	Method and Description
DescribedProfile.Builder	arn(String arn) The unique Amazon Resource Name (ARN) for the profile.
DescribedProfile.Builder	as2Id(String as2Id) The As2Id is the AS2-name, as defined in the RFC 4130.
DescribedProfile.Builder	certificateIds(Collection<String> certificateIds) An array of identifiers for the imported certificates.
DescribedProfile.Builder	certificateIds(String... certificateIds) An array of identifiers for the imported certificates.
DescribedProfile.Builder	profileId(String profileId) A unique identifier for the local or partner AS2 profile.
DescribedProfile.Builder	profileType(ProfileType profileType) Indicates whether to list only LOCAL type profiles or only PARTNER type profiles.
DescribedProfile.Builder	profileType(String profileType) Indicates whether to list only LOCAL type profiles or only PARTNER type profiles.
DescribedProfile.Builder	tags(Collection<Tag> tags) Key-value pairs that can be used to group and search for profiles.
DescribedProfile.Builder	tags(Consumer<Tag.Builder>... tags) Key-value pairs that can be used to group and search for profiles.
DescribedProfile.Builder	tags(Tag... tags) Key-value pairs that can be used to group and search for profiles.

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

arn

DescribedProfile.Builder arn(String arn)

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

Parameters:

arn - The unique Amazon Resource Name (ARN) for the profile.

Returns:

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

profileId

DescribedProfile.Builder profileId(String profileId)

A unique identifier for the local or partner AS2 profile.

Parameters:

profileId - A unique identifier for the local or partner AS2 profile.

Returns:

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

profileType

DescribedProfile.Builder profileType(String profileType)

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Parameters:

profileType - Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Returns:

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

See Also:

ProfileType, ProfileType

profileType

DescribedProfile.Builder profileType(ProfileType profileType)

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Parameters:

profileType - Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Returns:

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

See Also:

ProfileType, ProfileType

as2Id

DescribedProfile.Builder as2Id(String as2Id)

The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

Parameters:

as2Id - The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

Returns:

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

certificateIds

DescribedProfile.Builder certificateIds(Collection<String> certificateIds)

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

Parameters:

certificateIds - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

Returns:

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

certificateIds

DescribedProfile.Builder certificateIds(String... certificateIds)

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

Parameters:

certificateIds - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

Returns:

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

tags

DescribedProfile.Builder tags(Collection<Tag> tags)

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

Parameters:

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

Returns:

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

tags

DescribedProfile.Builder tags(Tag... tags)

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

Parameters:

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

Returns:

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

tags

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

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

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)