Interface S3EndpointBuilderFactory.S3EndpointProducerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
S3EndpointBuilderFactory.S3EndpointBuilder
- Enclosing interface:
- S3EndpointBuilderFactory
public static interface S3EndpointBuilderFactory.S3EndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the AWS S3 Storage Service component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default S3EndpointBuilderFactory.S3EndpointProducerBuilder
accessKey(String accessKey)
Amazon AWS Access Key.default S3EndpointBuilderFactory.AdvancedS3EndpointProducerBuilder
advanced()
default S3EndpointBuilderFactory.S3EndpointProducerBuilder
amazonS3Client(Object amazonS3Client)
Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
amazonS3Client(String amazonS3Client)
Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
autoCreateBucket(boolean autoCreateBucket)
Setting the autocreation of the bucket.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
autoCreateBucket(String autoCreateBucket)
Setting the autocreation of the bucket.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
autoDiscoverClient(boolean autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
autoDiscoverClient(String autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
deleteAfterWrite(boolean deleteAfterWrite)
Delete file object after the S3 file has been uploaded.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
deleteAfterWrite(String deleteAfterWrite)
Delete file object after the S3 file has been uploaded.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
endpointConfiguration(Object endpointConfiguration)
Amazon AWS Endpoint Configuration.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
endpointConfiguration(String endpointConfiguration)
Amazon AWS Endpoint Configuration.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
keyName(String keyName)
Setting the key name for an element in the bucket through endpoint parameter.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default S3EndpointBuilderFactory.S3EndpointProducerBuilder
lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message).default S3EndpointBuilderFactory.S3EndpointProducerBuilder
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 S3EndpointBuilderFactory.S3EndpointProducerBuilder
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 S3EndpointBuilderFactory.S3EndpointProducerBuilder
operation(String operation)
The operation to do in case the user don't want to do only an upload.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
operation(S3EndpointBuilderFactory.S3Operations operation)
The operation to do in case the user don't want to do only an upload.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
partSize(long partSize)
Setup the partSize which is used in multi part upload, the default size is 25M.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
partSize(String partSize)
Setup the partSize which is used in multi part upload, the default size is 25M.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
pathStyleAccess(boolean pathStyleAccess)
Whether or not the S3 client should use path style access.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
pathStyleAccess(String pathStyleAccess)
Whether or not the S3 client should use path style access.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
policy(String policy)
The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
proxyHost(String proxyHost)
To define a proxy host when instantiating the S3 client.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
proxyPort(Integer proxyPort)
Specify a proxy port to be used inside the client definition.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
proxyPort(String proxyPort)
Specify a proxy port to be used inside the client definition.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
proxyProtocol(String proxyProtocol)
To define a proxy protocol when instantiating the S3 client.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
proxyProtocol(S3EndpointBuilderFactory.Protocol proxyProtocol)
To define a proxy protocol when instantiating the S3 client.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
region(String region)
The region in which S3 client needs to work.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
secretKey(String secretKey)
Amazon AWS Secret Key.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
serverSideEncryption(String serverSideEncryption)
Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
storageClass(String storageClass)
The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
useIAMCredentials(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.default S3EndpointBuilderFactory.S3EndpointProducerBuilder
useIAMCredentials(String useIAMCredentials)
Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in.
-
-
-
Method Detail
-
advanced
default S3EndpointBuilderFactory.AdvancedS3EndpointProducerBuilder advanced()
-
amazonS3Client
default S3EndpointBuilderFactory.S3EndpointProducerBuilder amazonS3Client(Object amazonS3Client)
Reference to a com.amazonaws.services.s3.AmazonS3 in the registry. The option is a:com.amazonaws.services.s3.AmazonS3
type. Group: common
-
amazonS3Client
default S3EndpointBuilderFactory.S3EndpointProducerBuilder amazonS3Client(String amazonS3Client)
Reference to a com.amazonaws.services.s3.AmazonS3 in the registry. The option will be converted to acom.amazonaws.services.s3.AmazonS3
type. Group: common
-
autoCreateBucket
default S3EndpointBuilderFactory.S3EndpointProducerBuilder autoCreateBucket(boolean autoCreateBucket)
Setting the autocreation of the bucket. The option is a:boolean
type. Default: true Group: common
-
autoCreateBucket
default S3EndpointBuilderFactory.S3EndpointProducerBuilder autoCreateBucket(String autoCreateBucket)
Setting the autocreation of the bucket. The option will be converted to aboolean
type. Default: true Group: common
-
autoDiscoverClient
default S3EndpointBuilderFactory.S3EndpointProducerBuilder autoDiscoverClient(boolean autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option is a:boolean
type. Default: true Group: common
-
autoDiscoverClient
default S3EndpointBuilderFactory.S3EndpointProducerBuilder autoDiscoverClient(String autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option will be converted to aboolean
type. Default: true Group: common
-
endpointConfiguration
default S3EndpointBuilderFactory.S3EndpointProducerBuilder endpointConfiguration(Object endpointConfiguration)
Amazon AWS Endpoint Configuration. The option is a:com.amazonaws.client.builder.AwsClientBuilder$EndpointConfiguration
type. Group: common
-
endpointConfiguration
default S3EndpointBuilderFactory.S3EndpointProducerBuilder endpointConfiguration(String endpointConfiguration)
Amazon AWS Endpoint Configuration. The option will be converted to acom.amazonaws.client.builder.AwsClientBuilder$EndpointConfiguration
type. Group: common
-
pathStyleAccess
default S3EndpointBuilderFactory.S3EndpointProducerBuilder pathStyleAccess(boolean pathStyleAccess)
Whether or not the S3 client should use path style access. The option is a:boolean
type. Default: false Group: common
-
pathStyleAccess
default S3EndpointBuilderFactory.S3EndpointProducerBuilder pathStyleAccess(String pathStyleAccess)
Whether or not the S3 client should use path style access. The option will be converted to aboolean
type. Default: false Group: common
-
policy
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder proxyHost(String proxyHost)
To define a proxy host when instantiating the S3 client. The option is a:java.lang.String
type. Group: common
-
proxyPort
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder proxyProtocol(S3EndpointBuilderFactory.Protocol proxyProtocol)
To define a proxy protocol when instantiating the S3 client. The option is a:com.amazonaws.Protocol
type. Default: HTTPS Group: common
-
proxyProtocol
default S3EndpointBuilderFactory.S3EndpointProducerBuilder proxyProtocol(String proxyProtocol)
To define a proxy protocol when instantiating the S3 client. The option will be converted to acom.amazonaws.Protocol
type. Default: HTTPS Group: common
-
region
default S3EndpointBuilderFactory.S3EndpointProducerBuilder region(String region)
The region in which S3 client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name(). The option is a:java.lang.String
type. Group: common
-
useIAMCredentials
default S3EndpointBuilderFactory.S3EndpointProducerBuilder useIAMCredentials(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. The option is a:boolean
type. Default: false Group: common
-
useIAMCredentials
default S3EndpointBuilderFactory.S3EndpointProducerBuilder useIAMCredentials(String useIAMCredentials)
Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in. The option will be converted to aboolean
type. Default: false Group: common
-
deleteAfterWrite
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder operation(S3EndpointBuilderFactory.S3Operations 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.aws.s3.S3Operations
type. Group: producer
-
operation
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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.aws.s3.S3Operations
type. Group: producer
-
partSize
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder 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
-
serverSideEncryption
default S3EndpointBuilderFactory.S3EndpointProducerBuilder serverSideEncryption(String serverSideEncryption)
Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256. The option is a:java.lang.String
type. Group: producer
-
storageClass
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder accessKey(String accessKey)
Amazon AWS Access Key. The option is a:java.lang.String
type. Group: security
-
secretKey
default S3EndpointBuilderFactory.S3EndpointProducerBuilder secretKey(String secretKey)
Amazon AWS Secret Key. The option is a:java.lang.String
type. Group: security
-
-