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

Interface StartDirectoryListingRequest.Builder

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

  • Method Details

    • connectorId

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

    • remoteDirectoryPath

      StartDirectoryListingRequest.Builder remoteDirectoryPath(String remoteDirectoryPath)

      Specifies the directory on the remote SFTP server for which you want to list its contents.

      Parameters:
      remoteDirectoryPath - Specifies the directory on the remote SFTP server for which you want to list its contents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxItems

      StartDirectoryListingRequest.Builder maxItems(Integer maxItems)

      An optional parameter where you can specify the maximum number of file/directory names to retrieve. The default value is 1,000.

      Parameters:
      maxItems - An optional parameter where you can specify the maximum number of file/directory names to retrieve. The default value is 1,000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputDirectoryPath

      StartDirectoryListingRequest.Builder outputDirectoryPath(String outputDirectoryPath)

      Specifies the path (bucket and prefix) in Amazon S3 storage to store the results of the directory listing.

      Parameters:
      outputDirectoryPath - Specifies the path (bucket and prefix) in Amazon S3 storage to store the results of the directory listing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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