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

Class StartDirectoryListingRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transfer.model.TransferRequest

software.amazon.awssdk.services.transfer.model.StartDirectoryListingRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartDirectoryListingRequest.Builder,StartDirectoryListingRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartDirectoryListingRequest
extends TransferRequest
implements ToCopyableBuilder<StartDirectoryListingRequest.Builder,StartDirectoryListingRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartDirectoryListingRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartDirectoryListingRequest.Builder	builder()
String	connectorId()	The unique identifier for the connector.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxItems()	An optional parameter where you can specify the maximum number of file/directory names to retrieve.
String	outputDirectoryPath()	Specifies the path (bucket and prefix) in Amazon S3 storage to store the results of the directory listing.
String	remoteDirectoryPath()	Specifies the directory on the remote SFTP server for which you want to list its contents.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartDirectoryListingRequest.Builder>	serializableBuilderClass()
StartDirectoryListingRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

connectorId

public final String connectorId()

The unique identifier for the connector.

Returns:

The unique identifier for the connector.

remoteDirectoryPath

public final String remoteDirectoryPath()

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

Returns:

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

maxItems

public final Integer maxItems()

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

Returns:

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

outputDirectoryPath

public final String outputDirectoryPath()

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

Returns:

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

toBuilder

public StartDirectoryListingRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartDirectoryListingRequest.Builder,StartDirectoryListingRequest>

Specified by:

toBuilder in class TransferRequest

builder

public static StartDirectoryListingRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartDirectoryListingRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo