Interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder
- All Superinterfaces:
AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
,AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
,org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- AWS2S3EndpointBuilderFactory
public static interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder
extends AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder, AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
Builder for endpoint for the AWS S3 Storage Service component.
-
Method Summary
Modifier and TypeMethodDescriptionAmazon AWS Access Key.advanced()
autoCreateBucket
(boolean autoCreateBucket) Setting the autocreation of the S3 bucket bucketName.autoCreateBucket
(String autoCreateBucket) Setting the autocreation of the S3 bucket bucketName.The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.forcePathStyle
(boolean forcePathStyle) Set whether the S3 client should use path-style URL instead of virtual-hosted-style.forcePathStyle
(String forcePathStyle) Set whether the S3 client should use path-style URL instead of virtual-hosted-style.overrideEndpoint
(boolean overrideEndpoint) Set the need for overidding the endpoint.overrideEndpoint
(String overrideEndpoint) Set the need for overidding the endpoint.pojoRequest
(boolean pojoRequest) If we want to use a POJO request as body or not.pojoRequest
(String pojoRequest) If we want to use a POJO request as body or not.The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.profileCredentialsName
(String profileCredentialsName) If using a profile credentials provider this parameter will set the profile name.To define a proxy host when instantiating the SQS client.Specify a proxy port to be used inside the client definition.Specify a proxy port to be used inside the client definition.proxyProtocol
(String proxyProtocol) To define a proxy protocol when instantiating the S3 client.proxyProtocol
(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the S3 client.The region in which S3 client needs to work.Amazon AWS Secret Key.trustAllCertificates
(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.trustAllCertificates
(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.uriEndpointOverride
(String uriEndpointOverride) Set the overriding uri endpoint.useDefaultCredentialsProvider
(boolean useDefaultCredentialsProvider) Set whether the S3 client should expect to load credentials through a default credentials provider.useDefaultCredentialsProvider
(String useDefaultCredentialsProvider) Set whether the S3 client should expect to load credentials through a default credentials provider.useProfileCredentialsProvider
(boolean useProfileCredentialsProvider) Set whether the S3 client should expect to load credentials through a profile credentials provider.useProfileCredentialsProvider
(String useProfileCredentialsProvider) Set whether the S3 client should expect to load credentials through a profile credentials provider.Methods inherited from interface org.apache.camel.builder.endpoint.dsl.AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, delay, delay, deleteAfterRead, deleteAfterRead, destinationBucket, destinationBucketPrefix, destinationBucketSuffix, doneFileName, fileName, greedy, greedy, ignoreBody, ignoreBody, includeBody, includeBody, includeFolders, includeFolders, initialDelay, initialDelay, maxConnections, maxConnections, maxMessagesPerPoll, maxMessagesPerPoll, moveAfterRead, moveAfterRead, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, startScheduler, startScheduler, timeUnit, timeUnit, useFixedDelay, useFixedDelay
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
batchMessageNumber, batchMessageNumber, batchSize, batchSize, deleteAfterWrite, deleteAfterWrite, keyName, multiPartUpload, multiPartUpload, namingStrategy, namingStrategy, operation, operation, partSize, partSize, restartingPolicy, restartingPolicy, storageClass, streamingUploadMode, streamingUploadMode, streamingUploadTimeout, streamingUploadTimeout
Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
advanced
- Specified by:
advanced
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
advanced
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
-
autoCreateBucket
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder 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: <code>boolean</code> type. Default: false Group: common- Specified by:
autoCreateBucket
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
autoCreateBucket
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
autoCreateBucket
- the value to set- Returns:
- the dsl builder
-
autoCreateBucket
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder 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 a <code>boolean</code> type. Default: false Group: common- Specified by:
autoCreateBucket
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
autoCreateBucket
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
autoCreateBucket
- the value to set- Returns:
- the dsl builder
-
delimiter
The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
delimiter
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
delimiter
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
delimiter
- the value to set- Returns:
- the dsl builder
-
forcePathStyle
Set whether the S3 client should use path-style URL instead of virtual-hosted-style. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
forcePathStyle
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
forcePathStyle
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
forcePathStyle
- the value to set- Returns:
- the dsl builder
-
forcePathStyle
Set whether the S3 client should use path-style URL instead of virtual-hosted-style. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
forcePathStyle
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
forcePathStyle
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
forcePathStyle
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder 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: <code>boolean</code> type. Default: false Group: common- Specified by:
overrideEndpoint
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
overrideEndpoint
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder 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 a <code>boolean</code> type. Default: false Group: common- Specified by:
overrideEndpoint
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
overrideEndpoint
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
pojoRequest
If we want to use a POJO request as body or not. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
pojoRequest
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
pojoRequest
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
pojoRequest
- the value to set- Returns:
- the dsl builder
-
pojoRequest
If we want to use a POJO request as body or not. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
pojoRequest
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
pojoRequest
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
pojoRequest
- the value to set- Returns:
- the dsl builder
-
policy
The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
policy
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
policy
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
policy
- the value to set- Returns:
- the dsl builder
-
prefix
The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
prefix
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
prefix
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
prefix
- the value to set- Returns:
- the dsl builder
-
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: <code>java.lang.String</code> type. Group: common- Specified by:
region
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
region
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
region
- the value to set- Returns:
- the dsl builder
-
uriEndpointOverride
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder uriEndpointOverride(String uriEndpointOverride) Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
uriEndpointOverride
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
uriEndpointOverride
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
uriEndpointOverride
- the value to set- Returns:
- the dsl builder
-
proxyHost
To define a proxy host when instantiating the SQS client. The option is a: <code>java.lang.String</code> type. Group: proxy- Specified by:
proxyHost
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
proxyHost
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
proxyHost
- the value to set- Returns:
- the dsl builder
-
proxyPort
Specify a proxy port to be used inside the client definition. The option is a: <code>java.lang.Integer</code> type. Group: proxy- Specified by:
proxyPort
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
proxyPort
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyPort
Specify a proxy port to be used inside the client definition. The option will be converted to a <code>java.lang.Integer</code> type. Group: proxy- Specified by:
proxyPort
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
proxyPort
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the S3 client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy- Specified by:
proxyProtocol
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
proxyProtocol
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
To define a proxy protocol when instantiating the S3 client. The option will be converted to a <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy- Specified by:
proxyProtocol
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
proxyProtocol
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
accessKey
Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
accessKey
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
accessKey
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
accessKey
- the value to set- Returns:
- the dsl builder
-
profileCredentialsName
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder profileCredentialsName(String profileCredentialsName) If using a profile credentials provider this parameter will set the profile name. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
profileCredentialsName
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
profileCredentialsName
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
profileCredentialsName
- the value to set- Returns:
- the dsl builder
-
secretKey
Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
secretKey
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
secretKey
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
secretKey
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder trustAllCertificates(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint. The option is a: <code>boolean</code> type. Default: false Group: security- Specified by:
trustAllCertificates
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
trustAllCertificates
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder trustAllCertificates(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a <code>boolean</code> type. Default: false Group: security- Specified by:
trustAllCertificates
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
trustAllCertificates
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider) Set whether the S3 client should expect to load credentials through a default credentials provider. The option is a: <code>boolean</code> type. Default: false Group: security- Specified by:
useDefaultCredentialsProvider
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
useDefaultCredentialsProvider
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider) Set whether the S3 client should expect to load credentials through a default credentials provider. The option will be converted to a <code>boolean</code> type. Default: false Group: security- Specified by:
useDefaultCredentialsProvider
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
useDefaultCredentialsProvider
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider) Set whether the S3 client should expect to load credentials through a profile credentials provider. The option is a: <code>boolean</code> type. Default: false Group: security- Specified by:
useProfileCredentialsProvider
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
useProfileCredentialsProvider
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider) Set whether the S3 client should expect to load credentials through a profile credentials provider. The option will be converted to a <code>boolean</code> type. Default: false Group: security- Specified by:
useProfileCredentialsProvider
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- Specified by:
useProfileCredentialsProvider
in interfaceAWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder
- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-