com.amazonaws.services.transfer.model

Class StartFileTransferRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transfer.model.StartFileTransferRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartFileTransferRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartFileTransferRequest()

Method Summary

Modifier and Type	Method and Description
StartFileTransferRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getConnectorId() The unique identifier for the connector.
String	getLocalDirectoryPath() For an inbound transfer, the LocaDirectoryPath specifies the destination for one or more files that are transferred from the partner's SFTP server.
String	getRemoteDirectoryPath() 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>	getRetrieveFilePaths() One or more source paths for the partner's SFTP server.
List<String>	getSendFilePaths() One or more source paths for the Amazon S3 storage.
int	hashCode()
void	setConnectorId(String connectorId) The unique identifier for the connector.
void	setLocalDirectoryPath(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.
void	setRemoteDirectoryPath(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.
void	setRetrieveFilePaths(Collection<String> retrieveFilePaths) One or more source paths for the partner's SFTP server.
void	setSendFilePaths(Collection<String> sendFilePaths) One or more source paths for the Amazon S3 storage.
String	toString() Returns a string representation of this object.
StartFileTransferRequest	withConnectorId(String connectorId) The unique identifier for the connector.
StartFileTransferRequest	withLocalDirectoryPath(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.
StartFileTransferRequest	withRemoteDirectoryPath(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.
StartFileTransferRequest	withRetrieveFilePaths(Collection<String> retrieveFilePaths) One or more source paths for the partner's SFTP server.
StartFileTransferRequest	withRetrieveFilePaths(String... retrieveFilePaths) One or more source paths for the partner's SFTP server.
StartFileTransferRequest	withSendFilePaths(Collection<String> sendFilePaths) One or more source paths for the Amazon S3 storage.
StartFileTransferRequest	withSendFilePaths(String... sendFilePaths) One or more source paths for the Amazon S3 storage.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartFileTransferRequest

public StartFileTransferRequest()

Method Detail

setConnectorId

public void setConnectorId(String connectorId)

The unique identifier for the connector.

Parameters:

connectorId - The unique identifier for the connector.

getConnectorId

public String getConnectorId()

The unique identifier for the connector.

Returns:

The unique identifier for the connector.

withConnectorId

public StartFileTransferRequest withConnectorId(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.

getSendFilePaths

public List<String> getSendFilePaths()

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:

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.

setSendFilePaths

public void setSendFilePaths(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.

withSendFilePaths

public StartFileTransferRequest withSendFilePaths(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.

NOTE: This method appends the values to the existing list (if any). Use setSendFilePaths(java.util.Collection) or withSendFilePaths(java.util.Collection) if you want to override the existing values.

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.

withSendFilePaths

public StartFileTransferRequest withSendFilePaths(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.

getRetrieveFilePaths

public List<String> getRetrieveFilePaths()

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

Returns:

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

setRetrieveFilePaths

public void setRetrieveFilePaths(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.

withRetrieveFilePaths

public StartFileTransferRequest withRetrieveFilePaths(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.

NOTE: This method appends the values to the existing list (if any). Use setRetrieveFilePaths(java.util.Collection) or withRetrieveFilePaths(java.util.Collection) if you want to override the existing values.

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.

withRetrieveFilePaths

public StartFileTransferRequest withRetrieveFilePaths(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.

setLocalDirectoryPath

public void setLocalDirectoryPath(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.

getLocalDirectoryPath

public String getLocalDirectoryPath()

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.

withLocalDirectoryPath

public StartFileTransferRequest withLocalDirectoryPath(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.

setRemoteDirectoryPath

public void setRemoteDirectoryPath(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.

getRemoteDirectoryPath

public String getRemoteDirectoryPath()

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.

withRemoteDirectoryPath

public StartFileTransferRequest withRemoteDirectoryPath(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartFileTransferRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()