software.amazon.awssdk.services.transfer.model

Class StartFileTransferRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartFileTransferRequest.Builder,StartFileTransferRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartFileTransferRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartFileTransferRequest.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()
boolean	hasRetrieveFilePaths() For responses, this returns true if the service returned a value for the RetrieveFilePaths property.
boolean	hasSendFilePaths() For responses, this returns true if the service returned a value for the SendFilePaths property.
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.
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.
List<String>	retrieveFilePaths() One or more source paths for the partner's SFTP server.
List<SdkField<?>>	sdkFields()
List<String>	sendFilePaths() One or more source paths for the Amazon S3 storage.
static Class<? extends StartFileTransferRequest.Builder>	serializableBuilderClass()
StartFileTransferRequest.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.

hasSendFilePaths

public final boolean hasSendFilePaths()

For responses, this returns true if the service returned a value for the SendFilePaths property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sendFilePaths

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSendFilePaths() method.

Returns:

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.

hasRetrieveFilePaths

public final boolean hasRetrieveFilePaths()

For responses, this returns true if the service returned a value for the RetrieveFilePaths property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

retrieveFilePaths

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRetrieveFilePaths() method.

Returns:

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

localDirectoryPath

public final 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.

Returns:

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

remoteDirectoryPath

public final 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.

Returns:

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.

toBuilder

public StartFileTransferRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartFileTransferRequest.Builder,StartFileTransferRequest>

Specified by:

toBuilder in class TransferRequest

builder

public static StartFileTransferRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartFileTransferRequest.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