Interface StartFileTransferRequest.Builder

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

  • Method Details

    • connectorId

      StartFileTransferRequest.Builder connectorId(String connectorId)

      The unique identifier for the connector.

      Parameters:
      connectorId - The unique identifier for the connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sendFilePaths

      StartFileTransferRequest.Builder sendFilePaths(Collection<String> sendFilePaths)

      One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, amzn-s3-demo-bucket/myfile.txt .

      Replace amzn-s3-demo-bucket with one of your actual buckets.

      Parameters:
      sendFilePaths - One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, amzn-s3-demo-bucket/myfile.txt .

      Replace amzn-s3-demo-bucket with one of your actual buckets.

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

    • sendFilePaths

      StartFileTransferRequest.Builder sendFilePaths(String... sendFilePaths)

      One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, amzn-s3-demo-bucket/myfile.txt .

      Replace amzn-s3-demo-bucket with one of your actual buckets.

      Parameters:
      sendFilePaths - One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, amzn-s3-demo-bucket/myfile.txt .

      Replace amzn-s3-demo-bucket with one of your actual buckets.

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

    • retrieveFilePaths

      StartFileTransferRequest.Builder retrieveFilePaths(Collection<String> retrieveFilePaths)

      One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.

      Parameters:
      retrieveFilePaths - One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retrieveFilePaths

      StartFileTransferRequest.Builder retrieveFilePaths(String... retrieveFilePaths)

      One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.

      Parameters:
      retrieveFilePaths - One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • localDirectoryPath

      StartFileTransferRequest.Builder localDirectoryPath(String localDirectoryPath)

      For an inbound transfer, the LocaDirectoryPath specifies the destination for one or more files that are transferred from the partner's SFTP server.

      Parameters:
      localDirectoryPath - For an inbound transfer, the LocaDirectoryPath specifies the destination for one or more files that are transferred from the partner's SFTP server.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • remoteDirectoryPath

      StartFileTransferRequest.Builder remoteDirectoryPath(String remoteDirectoryPath)

      For an outbound transfer, the RemoteDirectoryPath specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a RemoteDirectoryPath, the destination for transferred files is the SFTP user's home directory.

      Parameters:
      remoteDirectoryPath - For an outbound transfer, the RemoteDirectoryPath specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a RemoteDirectoryPath, the destination for transferred files is the SFTP user's home directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customHttpHeaders

      StartFileTransferRequest.Builder customHttpHeaders(Collection<CustomHttpHeader> customHttpHeaders)

      An array of key-value pairs that represent custom HTTP headers to include in AS2 messages. These headers are added to the AS2 message when sending files to your trading partner.

      Parameters:
      customHttpHeaders - An array of key-value pairs that represent custom HTTP headers to include in AS2 messages. These headers are added to the AS2 message when sending files to your trading partner.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customHttpHeaders

      StartFileTransferRequest.Builder customHttpHeaders(CustomHttpHeader... customHttpHeaders)

      An array of key-value pairs that represent custom HTTP headers to include in AS2 messages. These headers are added to the AS2 message when sending files to your trading partner.

      Parameters:
      customHttpHeaders - An array of key-value pairs that represent custom HTTP headers to include in AS2 messages. These headers are added to the AS2 message when sending files to your trading partner.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customHttpHeaders

      StartFileTransferRequest.Builder customHttpHeaders(Consumer<CustomHttpHeader.Builder>... customHttpHeaders)

      An array of key-value pairs that represent custom HTTP headers to include in AS2 messages. These headers are added to the AS2 message when sending files to your trading partner.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customHttpHeaders(List<CustomHttpHeader>).

      Parameters:
      customHttpHeaders - a consumer that will call methods on CustomHttpHeader.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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