Interface StartDirectoryListingRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<StartDirectoryListingRequest.Builder,
,StartDirectoryListingRequest> SdkBuilder<StartDirectoryListingRequest.Builder,
,StartDirectoryListingRequest> SdkPojo
,SdkRequest.Builder
,TransferRequest.Builder
- Enclosing class:
StartDirectoryListingRequest
@Mutable
@NotThreadSafe
public static interface StartDirectoryListingRequest.Builder
extends TransferRequest.Builder, SdkPojo, CopyableBuilder<StartDirectoryListingRequest.Builder,StartDirectoryListingRequest>
-
Method Summary
Modifier and TypeMethodDescriptionconnectorId
(String connectorId) The unique identifier for the connector.An optional parameter where you can specify the maximum number of file/directory names to retrieve.outputDirectoryPath
(String outputDirectoryPath) Specifies the path (bucket and prefix) in Amazon S3 storage to store the results of the directory listing.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.remoteDirectoryPath
(String remoteDirectoryPath) Specifies the directory on the remote SFTP server for which you want to list its contents.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferRequest.Builder
build
-
Method Details
-
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
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
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-