org.finra.herd.model.dto

Class S3FileTransferRequestParamsDto

java.lang.Object

org.finra.herd.model.dto.AwsParamsDto

org.finra.herd.model.dto.S3FileTransferRequestParamsDto

Direct Known Subclasses:

S3FileCopyRequestParamsDto

public class S3FileTransferRequestParamsDto
extends AwsParamsDto

A DTO that holds various parameters for making an S3 file/directory transfer request.

Consider using the builder to make constructing this class easier. For example:

 S3FileTransferRequestParamsDto params = S3FileTransferRequestParamsDto
     .builder().s3BucketName("myBucket").s3KeyPrefix("myS3KeyPrefix").build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	S3FileTransferRequestParamsDto.Builder A builder that makes it easier to construct this DTO.

Constructor Summary

Constructors

Constructor and Description
S3FileTransferRequestParamsDto()

Method Summary

Modifier and Type	Method and Description
static S3FileTransferRequestParamsDto.Builder	builder() Returns a builder that can easily build this DTO.
boolean	equals(Object obj)
List<HerdAWSCredentialsProvider>	getAdditionalAwsCredentialsProviders()
List<File>	getFiles()
String	getKmsKeyId()
String	getLocalPath()
Integer	getMaxThreads()
Boolean	getRecursive()
String	getS3AccessKey()
String	getS3BucketName()
String	getS3Endpoint()
String	getS3KeyPrefix()
String	getS3SecretKey()
Integer	getSocketTimeout()
Boolean	getUseRrs()
int	hashCode()
void	setAdditionalAwsCredentialsProviders(List<HerdAWSCredentialsProvider> additionalAwsCredentialsProviders)
void	setFiles(List<File> files)
void	setKmsKeyId(String kmsKeyId)
void	setLocalPath(String localPath)
void	setMaxThreads(Integer maxThreads)
void	setRecursive(Boolean recursive)
void	setS3AccessKey(String s3AccessKey)
void	setS3BucketName(String s3BucketName)
void	setS3Endpoint(String s3Endpoint)
void	setS3KeyPrefix(String s3KeyPrefix)
void	setS3SecretKey(String s3SecretKey)
void	setSocketTimeout(Integer socketTimeout)
void	setUseRrs(Boolean useRrs)

Methods inherited from class org.finra.herd.model.dto.AwsParamsDto

getAwsAccessKeyId, getAwsSecretKey, getHttpProxyHost, getHttpProxyPort, getSessionToken, setAwsAccessKeyId, setAwsSecretKey, setHttpProxyHost, setHttpProxyPort, setSessionToken

Methods inherited from class java.lang.Object

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

Constructor Detail

S3FileTransferRequestParamsDto

public S3FileTransferRequestParamsDto()

Method Detail

getS3Endpoint

public String getS3Endpoint()

setS3Endpoint

public void setS3Endpoint(String s3Endpoint)

getS3BucketName

public String getS3BucketName()

setS3BucketName

public void setS3BucketName(String s3BucketName)

getS3KeyPrefix

public String getS3KeyPrefix()

setS3KeyPrefix

public void setS3KeyPrefix(String s3KeyPrefix)

getLocalPath

public String getLocalPath()

setLocalPath

public void setLocalPath(String localPath)

getFiles

public List<File> getFiles()

setFiles

public void setFiles(List<File> files)

getRecursive

public Boolean getRecursive()

setRecursive

public void setRecursive(Boolean recursive)

getUseRrs

public Boolean getUseRrs()

setUseRrs

public void setUseRrs(Boolean useRrs)

getS3AccessKey

public String getS3AccessKey()

setS3AccessKey

public void setS3AccessKey(String s3AccessKey)

getS3SecretKey

public String getS3SecretKey()

setS3SecretKey

public void setS3SecretKey(String s3SecretKey)

getMaxThreads

public Integer getMaxThreads()

setMaxThreads

public void setMaxThreads(Integer maxThreads)

getKmsKeyId

public String getKmsKeyId()

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

getSocketTimeout

public Integer getSocketTimeout()

setSocketTimeout

public void setSocketTimeout(Integer socketTimeout)

getAdditionalAwsCredentialsProviders

public List<HerdAWSCredentialsProvider> getAdditionalAwsCredentialsProviders()

setAdditionalAwsCredentialsProviders

public void setAdditionalAwsCredentialsProviders(List<HerdAWSCredentialsProvider> additionalAwsCredentialsProviders)

builder

public static S3FileTransferRequestParamsDto.Builder builder()

Returns a builder that can easily build this DTO.

Returns:

the builder.

hashCode

public int hashCode()

Overrides:

hashCode in class AwsParamsDto

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsParamsDto