S3Configuration (Camel :: AWS 2.21.4 API)

java.lang.Object
- org.apache.camel.component.aws.s3.S3Configuration

All Implemented Interfaces:: Cloneable

@UriParams
public class S3Configuration
extends Object
implements Cloneable

Constructor Summary

Constructors
Constructor and Description

S3Configuration()

Constructors
Constructor and Description
`S3Configuration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`S3Configuration`	`copy()`
`String`	`getAccessKey()`
`com.amazonaws.services.s3.AmazonS3`	`getAmazonS3Client()`
`String`	`getAwsKMSKeyId()`
`String`	`getBucketName()`
`com.amazonaws.services.s3.model.EncryptionMaterials`	`getEncryptionMaterials()`
`String`	`getFileName()`
`S3Operations`	`getOperation()`
`long`	`getPartSize()`
`String`	`getPolicy()`
`String`	`getPrefix()`
`String`	`getProxyHost()`
`Integer`	`getProxyPort()`
`String`	`getRegion()`
`String`	`getSecretKey()`
`String`	`getServerSideEncryption()`
`String`	`getStorageClass()`
`boolean`	`hasProxyConfiguration()`
`boolean`	`isAccelerateModeEnabled()`
`boolean`	`isAutocloseBody()`
`boolean`	`isChunkedEncodingDisabled()`
`boolean`	`isDeleteAfterRead()`
`boolean`	`isDeleteAfterWrite()`
`boolean`	`isDualstackEnabled()`
`boolean`	`isForceGlobalBucketAccessEnabled()`
`boolean`	`isIncludeBody()`
`boolean`	`isMultiPartUpload()`
`boolean`	`isPathStyleAccess()`
`boolean`	`isPayloadSigningEnabled()`
`boolean`	`isUseAwsKMS()`
`boolean`	`isUseEncryption()`
`Boolean`	`isUseIAMCredentials()`
`void`	`setAccelerateModeEnabled(boolean accelerateModeEnabled)` Define if Accelerate Mode enabled is true or false
`void`	`setAccessKey(String accessKey)` Amazon AWS Access Key
`void`	`setAmazonS3Client(com.amazonaws.services.s3.AmazonS3 amazonS3Client)` Reference to a `com.amazonaws.services.sqs.AmazonS3` in the link:registry.html[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`	`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`	`setChunkedEncodingDisabled(boolean chunkedEncodingDisabled)` Define if disabled Chunked Encoding is true or false
`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`	`setDualstackEnabled(boolean dualstackEnabled)` Define if Dualstack enabled is true or false
`void`	`setEncryptionMaterials(com.amazonaws.services.s3.model.EncryptionMaterials encryptionMaterials)` The encryption materials to use in case of Symmetric/Asymmetric client usage
`void`	`setFileName(String fileName)` To get the object from the bucket with the given file name
`void`	`setForceGlobalBucketAccessEnabled(boolean forceGlobalBucketAccessEnabled)` Define if Force Global Bucket Access enabled is true or false
`void`	`setIncludeBody(boolean includeBody)` If it is true, the exchange body will be set to a stream to the contents of the file.
`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(S3Operations operation)` The operation to do in case the user don't want to do only an upload
`void`	`setPartSize(long partSize)` Setup the partSize which is used in multi part upload, the default size is 25M.
`void`	`setPathStyleAccess(boolean pathStyleAccess)` Whether or not the S3 client should use path style access
`void`	`setPayloadSigningEnabled(boolean payloadSigningEnabled)` Define if Payload Signing enabled is true or false
`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`	`setRegion(String region)` The region in which S3 client needs to work
`void`	`setSecretKey(String secretKey)` Amazon AWS Secret Key
`void`	`setServerSideEncryption(String serverSideEncryption)` Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys.
`void`	`setStorageClass(String storageClass)` The storage class to set in the `com.amazonaws.services.s3.model.PutObjectRequest` request.
`void`	`setUseAwsKMS(boolean useAwsKMS)` Define if KMS must be used or not
`void`	`setUseEncryption(boolean useEncryption)` Define if encryption 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
  - S3Configuration
```
public S3Configuration()
```
- 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 com.amazonaws.services.s3.AmazonS3 getAmazonS3Client()
```
  - setAmazonS3Client
```
public void setAmazonS3Client(com.amazonaws.services.s3.AmazonS3 amazonS3Client)
```
    Reference to a `com.amazonaws.services.sqs.AmazonS3` in the link:registry.html[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.
  - 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
  - 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 S3Constants.BUCKET_NAME and S3Constants.KEY headers, or only the S3Constants.KEY header.
  - 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.
  - getServerSideEncryption
```
public String getServerSideEncryption()
```
  - setServerSideEncryption
```
public void setServerSideEncryption(String serverSideEncryption)
```
    Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256.
  - 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.
  - setPathStyleAccess
```
public void setPathStyleAccess(boolean pathStyleAccess)
```
    Whether or not the S3 client should use path style access
  - isPathStyleAccess
```
public boolean isPathStyleAccess()
```
  - getOperation
```
public S3Operations getOperation()
```
  - setOperation
```
public void setOperation(S3Operations 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.
  - getEncryptionMaterials
```
public com.amazonaws.services.s3.model.EncryptionMaterials getEncryptionMaterials()
```
  - setEncryptionMaterials
```
public void setEncryptionMaterials(com.amazonaws.services.s3.model.EncryptionMaterials encryptionMaterials)
```
    The encryption materials to use in case of Symmetric/Asymmetric client usage
  - isUseEncryption
```
public boolean isUseEncryption()
```
  - setUseEncryption
```
public void setUseEncryption(boolean useEncryption)
```
    Define if encryption must be used or not
  - 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
  - isChunkedEncodingDisabled
```
public boolean isChunkedEncodingDisabled()
```
  - setChunkedEncodingDisabled
```
public void setChunkedEncodingDisabled(boolean chunkedEncodingDisabled)
```
    Define if disabled Chunked Encoding is true or false
  - isAccelerateModeEnabled
```
public boolean isAccelerateModeEnabled()
```
  - setAccelerateModeEnabled
```
public void setAccelerateModeEnabled(boolean accelerateModeEnabled)
```
    Define if Accelerate Mode enabled is true or false
  - isDualstackEnabled
```
public boolean isDualstackEnabled()
```
  - setDualstackEnabled
```
public void setDualstackEnabled(boolean dualstackEnabled)
```
    Define if Dualstack enabled is true or false
  - isPayloadSigningEnabled
```
public boolean isPayloadSigningEnabled()
```
  - setPayloadSigningEnabled
```
public void setPayloadSigningEnabled(boolean payloadSigningEnabled)
```
    Define if Payload Signing enabled is true or false
  - isForceGlobalBucketAccessEnabled
```
public boolean isForceGlobalBucketAccessEnabled()
```
  - setForceGlobalBucketAccessEnabled
```
public void setForceGlobalBucketAccessEnabled(boolean forceGlobalBucketAccessEnabled)
```
    Define if Force Global Bucket Access enabled is true or false
  - 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()
```
  - hasProxyConfiguration
```
public boolean hasProxyConfiguration()
```
  - copy
```
public S3Configuration copy()
```

Class S3Configuration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

S3Configuration

Method Detail

getPartSize

setPartSize

isMultiPartUpload

setMultiPartUpload

getAccessKey

setAccessKey

getSecretKey

setSecretKey

getAmazonS3Client

setAmazonS3Client

getPrefix

setPrefix

getBucketName

setBucketName

getFileName

setFileName

getRegion

setRegion

setIncludeBody

isIncludeBody

isDeleteAfterRead

setDeleteAfterRead

isDeleteAfterWrite

setDeleteAfterWrite

getPolicy

setPolicy

getStorageClass

setStorageClass

getServerSideEncryption

setServerSideEncryption

getProxyHost

setProxyHost

getProxyPort

setProxyPort

setPathStyleAccess

isPathStyleAccess

getOperation

setOperation

isAutocloseBody

setAutocloseBody

getEncryptionMaterials

setEncryptionMaterials

isUseEncryption

setUseEncryption

isUseAwsKMS

setUseAwsKMS

getAwsKMSKeyId

setAwsKMSKeyId

isChunkedEncodingDisabled

setChunkedEncodingDisabled

isAccelerateModeEnabled

setAccelerateModeEnabled

isDualstackEnabled

setDualstackEnabled

isPayloadSigningEnabled

setPayloadSigningEnabled

isForceGlobalBucketAccessEnabled

setForceGlobalBucketAccessEnabled

setUseIAMCredentials

isUseIAMCredentials

hasProxyConfiguration

copy