Interface CreateProfileRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateProfileRequest.Builder,CreateProfileRequest>, SdkBuilder<CreateProfileRequest.Builder,CreateProfileRequest>, SdkPojo, SdkRequest.Builder, TransferRequest.Builder
Enclosing class:
CreateProfileRequest
@Mutable @NotThreadSafe public static interface CreateProfileRequest.Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder<CreateProfileRequest.Builder,CreateProfileRequest>

  • Method Details

    • as2Id

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

    • profileType

      CreateProfileRequest.Builder profileType(String profileType)

      Determines the type of profile to create:

      • Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.

      • Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.

      Parameters:
      profileType - Determines the type of profile to create:

      • Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.

      • Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.

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

    • profileType

      CreateProfileRequest.Builder profileType(ProfileType profileType)

      Determines the type of profile to create:

      • Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.

      • Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.

      Parameters:
      profileType - Determines the type of profile to create:

      • Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.

      • Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.

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

    • certificateIds

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

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

      CreateProfileRequest.Builder tags(Collection<Tag> tags)

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

      Parameters:
      tags - Key-value pairs that can be used to group and search for AS2 profiles.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateProfileRequest.Builder tags(Tag... tags)

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

      Parameters:
      tags - Key-value pairs that can be used to group and search for AS2 profiles.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      Key-value pairs that can be used to group and search for AS2 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<Tag>).

      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:

    • overrideConfiguration

      CreateProfileRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateProfileRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.