AWS2S3Configuration (Camel :: AWS2 S3 3.4.0 API)

java.lang.Object
- org.apache.camel.component.aws2.s3.AWS2S3Configuration

All Implemented Interfaces:: Cloneable

@UriParams
public class AWS2S3Configuration
extends Object
implements Cloneable

Constructor Summary

Constructors
Constructor and Description

AWS2S3Configuration()

Constructors
Constructor and Description
`AWS2S3Configuration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AWS2S3Configuration`	`copy()`
`String`	`getAccessKey()`
`software.amazon.awssdk.services.s3.S3Client`	`getAmazonS3Client()`
`String`	`getAwsKMSKeyId()`
`String`	`getBucketName()`
`String`	`getCustomerAlgorithm()`
`String`	`getCustomerKeyId()`
`String`	`getCustomerKeyMD5()`
`String`	`getDelimiter()`
`String`	`getDestinationBucket()`
`String`	`getFileName()`
`String`	`getKeyName()`
`AWS2S3Operations`	`getOperation()`
`long`	`getPartSize()`
`String`	`getPolicy()`
`String`	`getPrefix()`
`String`	`getProxyHost()`
`Integer`	`getProxyPort()`
`software.amazon.awssdk.core.Protocol`	`getProxyProtocol()`
`String`	`getRegion()`
`String`	`getSecretKey()`
`String`	`getStorageClass()`
`String`	`getUriEndpointOverride()`
`boolean`	`isAutocloseBody()`
`boolean`	`isAutoCreateBucket()`
`boolean`	`isDeleteAfterRead()`
`boolean`	`isDeleteAfterWrite()`
`boolean`	`isIncludeBody()`
`boolean`	`isIncludeFolders()`
`boolean`	`isMoveAfterRead()`
`boolean`	`isMultiPartUpload()`
`boolean`	`isOverrideEndpoint()`
`boolean`	`isPojoRequest()`
`boolean`	`isUseAwsKMS()`
`boolean`	`isUseCustomerKey()`
`Boolean`	`isUseIAMCredentials()`
`void`	`setAccessKey(String accessKey)` Amazon AWS Access Key
`void`	`setAmazonS3Client(software.amazon.awssdk.services.s3.S3Client amazonS3Client)` Reference to a `com.amazonaws.services.s3.AmazonS3` in the registry.
`void`	`setAutocloseBody(boolean autocloseBody)` If this option is true and includeBody is true, then the S3Object.close() method will be called on exchange completion.
`void`	`setAutoCreateBucket(boolean autoCreateBucket)` Setting the autocreation of the bucket
`void`	`setAwsKMSKeyId(String awsKMSKeyId)` Define the id of KMS key to use in case KMS is enabled
`void`	`setBucketName(String bucketName)` Name of the bucket.
`void`	`setCustomerAlgorithm(String customerAlgorithm)` Define the customer algorithm to use in case CustomerKey is enabled
`void`	`setCustomerKeyId(String customerKeyId)` Define the id of Customer key to use in case CustomerKey is enabled
`void`	`setCustomerKeyMD5(String customerKeyMD5)` Define the MD5 of Customer key to use in case CustomerKey is enabled
`void`	`setDeleteAfterRead(boolean deleteAfterRead)` Delete objects from S3 after they have been retrieved.
`void`	`setDeleteAfterWrite(boolean deleteAfterWrite)` Delete file object after the S3 file has been uploaded
`void`	`setDelimiter(String delimiter)` The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.
`void`	`setDestinationBucket(String destinationBucket)` Define the destination bucket where an object must be moved when moveAfterRead is set to true.
`void`	`setFileName(String fileName)` To get the object from the bucket with the given file name
`void`	`setIncludeBody(boolean includeBody)` If it is true, the exchange body will be set to a stream to the contents of the file.
`void`	`setIncludeFolders(boolean includeFolders)` If it is true, the folders/directories will be consumed.
`void`	`setKeyName(String keyName)` Setting the key name for an element in the bucket through endpoint parameter
`void`	`setMoveAfterRead(boolean moveAfterRead)` Move objects from S3 bucket to a different bucket after they have been retrieved.
`void`	`setMultiPartUpload(boolean multiPartUpload)` If it is true, camel will upload the file with multi part format, the part size is decided by the option of `partSize`
`void`	`setOperation(AWS2S3Operations operation)` The operation to do in case the user don't want to do only an upload
`void`	`setOverrideEndpoint(boolean overrideEndpoint)` Set the need for overidding the endpoint.
`void`	`setPartSize(long partSize)` Setup the partSize which is used in multi part upload, the default size is 25M.
`void`	`setPojoRequest(boolean pojoRequest)` If we want to use a POJO request as body or not
`void`	`setPolicy(String policy)` The policy for this queue to set in the `com.amazonaws.services.s3.AmazonS3#setBucketPolicy()` method.
`void`	`setPrefix(String prefix)` The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.
`void`	`setProxyHost(String proxyHost)` To define a proxy host when instantiating the SQS client
`void`	`setProxyPort(Integer proxyPort)` Specify a proxy port to be used inside the client definition.
`void`	`setProxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)` To define a proxy protocol when instantiating the S3 client
`void`	`setRegion(String region)` The region in which S3 client needs to work.
`void`	`setSecretKey(String secretKey)` Amazon AWS Secret Key
`void`	`setStorageClass(String storageClass)` The storage class to set in the `com.amazonaws.services.s3.model.PutObjectRequest` request.
`void`	`setUriEndpointOverride(String uriEndpointOverride)` Set the overriding uri endpoint.
`void`	`setUseAwsKMS(boolean useAwsKMS)` Define if KMS must be used or not
`void`	`setUseCustomerKey(boolean useCustomerKey)` Define if Customer Key must be used or not
`void`	`setUseIAMCredentials(Boolean useIAMCredentials)` Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AWS2S3Configuration
```
public AWS2S3Configuration()
```
- Method Detail
  - getPartSize
```
public long getPartSize()
```
  - setPartSize
```
public void setPartSize(long partSize)
```
    Setup the partSize which is used in multi part upload, the default size is 25M.
  - isMultiPartUpload
```
public boolean isMultiPartUpload()
```
  - setMultiPartUpload
```
public void setMultiPartUpload(boolean multiPartUpload)
```
    If it is true, camel will upload the file with multi part format, the part size is decided by the option of `partSize`
  - getAccessKey
```
public String getAccessKey()
```
  - setAccessKey
```
public void setAccessKey(String accessKey)
```
    Amazon AWS Access Key
  - getSecretKey
```
public String getSecretKey()
```
  - setSecretKey
```
public void setSecretKey(String secretKey)
```
    Amazon AWS Secret Key
  - getAmazonS3Client
```
public software.amazon.awssdk.services.s3.S3Client getAmazonS3Client()
```
  - setAmazonS3Client
```
public void setAmazonS3Client(software.amazon.awssdk.services.s3.S3Client amazonS3Client)
```
    Reference to a `com.amazonaws.services.s3.AmazonS3` in the registry.
  - getPrefix
```
public String getPrefix()
```
  - setPrefix
```
public void setPrefix(String prefix)
```
    The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.
  - getDelimiter
```
public String getDelimiter()
```
  - setDelimiter
```
public void setDelimiter(String delimiter)
```
    The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.
  - setIncludeFolders
```
public void setIncludeFolders(boolean includeFolders)
```
    If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those
  - isIncludeFolders
```
public boolean isIncludeFolders()
```
  - getBucketName
```
public String getBucketName()
```
  - setBucketName
```
public void setBucketName(String bucketName)
```
    Name of the bucket. The bucket will be created if it doesn't already exists.
  - getFileName
```
public String getFileName()
```
  - setFileName
```
public void setFileName(String fileName)
```
    To get the object from the bucket with the given file name
  - getRegion
```
public String getRegion()
```
  - setRegion
```
public void setRegion(String region)
```
    The region in which S3 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()
  - setIncludeBody
```
public void setIncludeBody(boolean includeBody)
```
    If it is true, the exchange body will be set to a stream to the contents of the file. If false, the headers will be set with the S3 object metadata, but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically.
  - isIncludeBody
```
public boolean isIncludeBody()
```
  - isDeleteAfterRead
```
public boolean isDeleteAfterRead()
```
  - setDeleteAfterRead
```
public void setDeleteAfterRead(boolean deleteAfterRead)
```
    Delete objects from S3 after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted.
    If this option is false, then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the AWS2S3Constants.BUCKET_NAME and AWS2S3Constants.KEY headers, or only the AWS2S3Constants.KEY header.
  - isMoveAfterRead
```
public boolean isMoveAfterRead()
```
  - setMoveAfterRead
```
public void setMoveAfterRead(boolean moveAfterRead)
```
    Move objects from S3 bucket to a different bucket after they have been retrieved. To accomplish the operation the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved.
  - getDestinationBucket
```
public String getDestinationBucket()
```
  - setDestinationBucket
```
public void setDestinationBucket(String destinationBucket)
```
    Define the destination bucket where an object must be moved when moveAfterRead is set to true.
  - isDeleteAfterWrite
```
public boolean isDeleteAfterWrite()
```
  - setDeleteAfterWrite
```
public void setDeleteAfterWrite(boolean deleteAfterWrite)
```
    Delete file object after the S3 file has been uploaded
  - getPolicy
```
public String getPolicy()
```
  - setPolicy
```
public void setPolicy(String policy)
```
    The policy for this queue to set in the `com.amazonaws.services.s3.AmazonS3#setBucketPolicy()` method.
  - getStorageClass
```
public String getStorageClass()
```
  - setStorageClass
```
public void setStorageClass(String storageClass)
```
    The storage class to set in the `com.amazonaws.services.s3.model.PutObjectRequest` request.
  - getProxyProtocol
```
public software.amazon.awssdk.core.Protocol getProxyProtocol()
```
  - setProxyProtocol
```
public void setProxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
```
    To define a proxy protocol when instantiating the S3 client
  - getProxyHost
```
public String getProxyHost()
```
  - setProxyHost
```
public void setProxyHost(String proxyHost)
```
    To define a proxy host when instantiating the SQS client
  - getProxyPort
```
public Integer getProxyPort()
```
  - setProxyPort
```
public void setProxyPort(Integer proxyPort)
```
    Specify a proxy port to be used inside the client definition.
  - getOperation
```
public AWS2S3Operations getOperation()
```
  - setOperation
```
public void setOperation(AWS2S3Operations operation)
```
    The operation to do in case the user don't want to do only an upload
  - isAutocloseBody
```
public boolean isAutocloseBody()
```
  - setAutocloseBody
```
public void setAutocloseBody(boolean autocloseBody)
```
    If this option is true and includeBody is true, then the S3Object.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically.
  - isUseAwsKMS
```
public boolean isUseAwsKMS()
```
  - setUseAwsKMS
```
public void setUseAwsKMS(boolean useAwsKMS)
```
    Define if KMS must be used or not
  - getAwsKMSKeyId
```
public String getAwsKMSKeyId()
```
  - setAwsKMSKeyId
```
public void setAwsKMSKeyId(String awsKMSKeyId)
```
    Define the id of KMS key to use in case KMS is enabled
  - isUseCustomerKey
```
public boolean isUseCustomerKey()
```
  - setUseCustomerKey
```
public void setUseCustomerKey(boolean useCustomerKey)
```
    Define if Customer Key must be used or not
  - getCustomerKeyId
```
public String getCustomerKeyId()
```
  - setCustomerKeyId
```
public void setCustomerKeyId(String customerKeyId)
```
    Define the id of Customer key to use in case CustomerKey is enabled
  - getCustomerKeyMD5
```
public String getCustomerKeyMD5()
```
  - setCustomerKeyMD5
```
public void setCustomerKeyMD5(String customerKeyMD5)
```
    Define the MD5 of Customer key to use in case CustomerKey is enabled
  - getCustomerAlgorithm
```
public String getCustomerAlgorithm()
```
  - setCustomerAlgorithm
```
public void setCustomerAlgorithm(String customerAlgorithm)
```
    Define the customer algorithm to use in case CustomerKey is enabled
  - setUseIAMCredentials
```
public void setUseIAMCredentials(Boolean useIAMCredentials)
```
    Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in.
  - isUseIAMCredentials
```
public Boolean isUseIAMCredentials()
```
  - isAutoCreateBucket
```
public boolean isAutoCreateBucket()
```
  - setAutoCreateBucket
```
public void setAutoCreateBucket(boolean autoCreateBucket)
```
    Setting the autocreation of the bucket
  - getKeyName
```
public String getKeyName()
```
  - setKeyName
```
public void setKeyName(String keyName)
```
    Setting the key name for an element in the bucket through endpoint parameter
  - isOverrideEndpoint
```
public boolean isOverrideEndpoint()
```
  - setOverrideEndpoint
```
public void setOverrideEndpoint(boolean overrideEndpoint)
```
    Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option
  - getUriEndpointOverride
```
public String getUriEndpointOverride()
```
  - setUriEndpointOverride
```
public void setUriEndpointOverride(String uriEndpointOverride)
```
    Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option
  - isPojoRequest
```
public boolean isPojoRequest()
```
  - setPojoRequest
```
public void setPojoRequest(boolean pojoRequest)
```
    If we want to use a POJO request as body or not
  - copy
```
public AWS2S3Configuration copy()
```

Class AWS2S3Configuration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AWS2S3Configuration

Method Detail

getPartSize

setPartSize

isMultiPartUpload

setMultiPartUpload

getAccessKey

setAccessKey

getSecretKey

setSecretKey

getAmazonS3Client

setAmazonS3Client

getPrefix

setPrefix

getDelimiter

setDelimiter

setIncludeFolders

isIncludeFolders

getBucketName

setBucketName

getFileName

setFileName

getRegion

setRegion

setIncludeBody

isIncludeBody

isDeleteAfterRead

setDeleteAfterRead

isMoveAfterRead

setMoveAfterRead

getDestinationBucket

setDestinationBucket

isDeleteAfterWrite

setDeleteAfterWrite

getPolicy

setPolicy

getStorageClass

setStorageClass

getProxyProtocol

setProxyProtocol

getProxyHost

setProxyHost

getProxyPort

setProxyPort

getOperation

setOperation

isAutocloseBody

setAutocloseBody

isUseAwsKMS

setUseAwsKMS

getAwsKMSKeyId

setAwsKMSKeyId

isUseCustomerKey

setUseCustomerKey

getCustomerKeyId

setCustomerKeyId

getCustomerKeyMD5

setCustomerKeyMD5

getCustomerAlgorithm

setCustomerAlgorithm

setUseIAMCredentials

isUseIAMCredentials

isAutoCreateBucket

setAutoCreateBucket

getKeyName

setKeyName

isOverrideEndpoint

setOverrideEndpoint

getUriEndpointOverride

setUriEndpointOverride

isPojoRequest

setPojoRequest

copy