Package software.amazon.awssdk.services.transfer.model

Interface StartFileTransferRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartFileTransferRequest.Builder,StartFileTransferRequest>, SdkBuilder<StartFileTransferRequest.Builder,StartFileTransferRequest>, SdkPojo, SdkRequest.Builder, TransferRequest.Builder
Enclosing class:
StartFileTransferRequest
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, DOC-EXAMPLE-BUCKET/myfile.txt .

      Replace DOC-EXAMPLE-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, DOC-EXAMPLE-BUCKET/myfile.txt .

      Replace DOC-EXAMPLE-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, DOC-EXAMPLE-BUCKET/myfile.txt .

      Replace DOC-EXAMPLE-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, DOC-EXAMPLE-BUCKET/myfile.txt .

      Replace DOC-EXAMPLE-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.

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