Interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder
- Enclosing interface:
- AWS2S3EndpointBuilderFactory
public static interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the AWS 2 S3 Storage Service component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
accessKey(String accessKey)
Amazon AWS Access Key.default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointProducerBuilder
advanced()
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
amazonS3Client(Object amazonS3Client)
Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
amazonS3Client(String amazonS3Client)
Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
amazonS3Presigner(Object amazonS3Presigner)
An S3 Presigner for Request, used mainly in createDownloadLink operation.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
amazonS3Presigner(String amazonS3Presigner)
An S3 Presigner for Request, used mainly in createDownloadLink operation.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
autoCreateBucket(boolean autoCreateBucket)
Setting the autocreation of the S3 bucket bucketName.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
autoCreateBucket(String autoCreateBucket)
Setting the autocreation of the S3 bucket bucketName.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
deleteAfterWrite(boolean deleteAfterWrite)
Delete file object after the S3 file has been uploaded.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
deleteAfterWrite(String deleteAfterWrite)
Delete file object after the S3 file has been uploaded.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
keyName(String keyName)
Setting the key name for an element in the bucket through endpoint parameter.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message).default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
multiPartUpload(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.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
multiPartUpload(String multiPartUpload)
If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
operation(String operation)
The operation to do in case the user don't want to do only an upload.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
operation(AWS2S3EndpointBuilderFactory.AWS2S3Operations operation)
The operation to do in case the user don't want to do only an upload.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
overrideEndpoint(boolean overrideEndpoint)
Set the need for overidding the endpoint.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
overrideEndpoint(String overrideEndpoint)
Set the need for overidding the endpoint.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
partSize(long partSize)
Setup the partSize which is used in multi part upload, the default size is 25M.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
partSize(String partSize)
Setup the partSize which is used in multi part upload, the default size is 25M.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
pojoRequest(boolean pojoRequest)
If we want to use a POJO request as body or not.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
pojoRequest(String pojoRequest)
If we want to use a POJO request as body or not.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
policy(String policy)
The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
proxyHost(String proxyHost)
To define a proxy host when instantiating the SQS client.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
proxyPort(Integer proxyPort)
Specify a proxy port to be used inside the client definition.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
proxyPort(String proxyPort)
Specify a proxy port to be used inside the client definition.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
proxyProtocol(String proxyProtocol)
To define a proxy protocol when instantiating the S3 client.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
proxyProtocol(AWS2S3EndpointBuilderFactory.Protocol proxyProtocol)
To define a proxy protocol when instantiating the S3 client.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
region(String region)
The region in which S3 client needs to work.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
secretKey(String secretKey)
Amazon AWS Secret Key.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
storageClass(String storageClass)
The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
trustAllCertificates(boolean trustAllCertificates)
If we want to trust all certificates in case of overriding the endpoint.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
trustAllCertificates(String trustAllCertificates)
If we want to trust all certificates in case of overriding the endpoint.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
uriEndpointOverride(String uriEndpointOverride)
Set the overriding uri endpoint.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
useDefaultCredentialsProvider(String useDefaultCredentialsProvider)
Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.
-
-
-
Method Detail
-
advanced
default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointProducerBuilder advanced()
-
amazonS3Client
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder amazonS3Client(Object amazonS3Client)
Reference to a com.amazonaws.services.s3.AmazonS3 in the registry. The option is a:software.amazon.awssdk.services.s3.S3Client
type. Group: common
-
amazonS3Client
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder amazonS3Client(String amazonS3Client)
Reference to a com.amazonaws.services.s3.AmazonS3 in the registry. The option will be converted to asoftware.amazon.awssdk.services.s3.S3Client
type. Group: common
-
amazonS3Presigner
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder amazonS3Presigner(Object amazonS3Presigner)
An S3 Presigner for Request, used mainly in createDownloadLink operation. The option is a:software.amazon.awssdk.services.s3.presigner.S3Presigner
type. Group: common
-
amazonS3Presigner
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder amazonS3Presigner(String amazonS3Presigner)
An S3 Presigner for Request, used mainly in createDownloadLink operation. The option will be converted to asoftware.amazon.awssdk.services.s3.presigner.S3Presigner
type. Group: common
-
autoCreateBucket
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder autoCreateBucket(boolean autoCreateBucket)
Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled and it will create the destinationBucket if it doesn't exist already. The option is a:boolean
type. Default: true Group: common
-
autoCreateBucket
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder autoCreateBucket(String autoCreateBucket)
Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled and it will create the destinationBucket if it doesn't exist already. The option will be converted to aboolean
type. Default: true Group: common
-
overrideEndpoint
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder overrideEndpoint(boolean overrideEndpoint)
Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a:boolean
type. Default: false Group: common
-
overrideEndpoint
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder overrideEndpoint(String overrideEndpoint)
Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option will be converted to aboolean
type. Default: false Group: common
-
pojoRequest
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder pojoRequest(boolean pojoRequest)
If we want to use a POJO request as body or not. The option is a:boolean
type. Default: false Group: common
-
pojoRequest
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder pojoRequest(String pojoRequest)
If we want to use a POJO request as body or not. The option will be converted to aboolean
type. Default: false Group: common
-
policy
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder policy(String policy)
The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method. The option is a:java.lang.String
type. Group: common
-
proxyHost
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder proxyHost(String proxyHost)
To define a proxy host when instantiating the SQS client. The option is a:java.lang.String
type. Group: common
-
proxyPort
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder proxyPort(Integer proxyPort)
Specify a proxy port to be used inside the client definition. The option is a:java.lang.Integer
type. Group: common
-
proxyPort
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder proxyPort(String proxyPort)
Specify a proxy port to be used inside the client definition. The option will be converted to ajava.lang.Integer
type. Group: common
-
proxyProtocol
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder proxyProtocol(AWS2S3EndpointBuilderFactory.Protocol proxyProtocol)
To define a proxy protocol when instantiating the S3 client. The option is a:software.amazon.awssdk.core.Protocol
type. Default: HTTPS Group: common
-
proxyProtocol
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder proxyProtocol(String proxyProtocol)
To define a proxy protocol when instantiating the S3 client. The option will be converted to asoftware.amazon.awssdk.core.Protocol
type. Default: HTTPS Group: common
-
region
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder region(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(). The option is a:java.lang.String
type. Group: common
-
trustAllCertificates
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder trustAllCertificates(boolean trustAllCertificates)
If we want to trust all certificates in case of overriding the endpoint. The option is a:boolean
type. Default: false Group: common
-
trustAllCertificates
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder trustAllCertificates(String trustAllCertificates)
If we want to trust all certificates in case of overriding the endpoint. The option will be converted to aboolean
type. Default: false Group: common
-
uriEndpointOverride
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder uriEndpointOverride(String uriEndpointOverride)
Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a:java.lang.String
type. Group: common
-
useDefaultCredentialsProvider
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option is a:boolean
type. Default: false Group: common
-
useDefaultCredentialsProvider
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider)
Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option will be converted to aboolean
type. Default: false Group: common
-
deleteAfterWrite
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder deleteAfterWrite(boolean deleteAfterWrite)
Delete file object after the S3 file has been uploaded. The option is a:boolean
type. Default: false Group: producer
-
deleteAfterWrite
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder deleteAfterWrite(String deleteAfterWrite)
Delete file object after the S3 file has been uploaded. The option will be converted to aboolean
type. Default: false Group: producer
-
keyName
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder keyName(String keyName)
Setting the key name for an element in the bucket through endpoint parameter. The option is a:java.lang.String
type. Group: producer
-
lazyStartProducer
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a:boolean
type. Default: false Group: producer
-
lazyStartProducer
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to aboolean
type. Default: false Group: producer
-
multiPartUpload
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder multiPartUpload(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. The option is a:boolean
type. Default: false Group: producer
-
multiPartUpload
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder multiPartUpload(String multiPartUpload)
If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize. The option will be converted to aboolean
type. Default: false Group: producer
-
operation
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder operation(AWS2S3EndpointBuilderFactory.AWS2S3Operations operation)
The operation to do in case the user don't want to do only an upload. The option is a:org.apache.camel.component.aws2.s3.AWS2S3Operations
type. Group: producer
-
operation
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder operation(String operation)
The operation to do in case the user don't want to do only an upload. The option will be converted to aorg.apache.camel.component.aws2.s3.AWS2S3Operations
type. Group: producer
-
partSize
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder partSize(long partSize)
Setup the partSize which is used in multi part upload, the default size is 25M. The option is a:long
type. Default: 26214400 Group: producer
-
partSize
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder partSize(String partSize)
Setup the partSize which is used in multi part upload, the default size is 25M. The option will be converted to along
type. Default: 26214400 Group: producer
-
storageClass
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder storageClass(String storageClass)
The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request. The option is a:java.lang.String
type. Group: producer
-
accessKey
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder accessKey(String accessKey)
Amazon AWS Access Key. The option is a:java.lang.String
type. Group: security
-
secretKey
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder secretKey(String secretKey)
Amazon AWS Secret Key. The option is a:java.lang.String
type. Group: security
-
-