org.apache.camel.builder.endpoint.dsl

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 2 S3 Storage Service component.

Method Summary

Modifier and Type	Method and Description
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	accessKey(String accessKey) Amazon AWS Access Key.
default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointBuilder	advanced()
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	amazonS3Client(Object amazonS3Client) Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	amazonS3Client(String amazonS3Client) Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	amazonS3Presigner(Object amazonS3Presigner) An S3 Presigner for Request, used mainly in createDownloadLink operation.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	amazonS3Presigner(String amazonS3Presigner) An S3 Presigner for Request, used mainly in createDownloadLink operation.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	autoCreateBucket(boolean autoCreateBucket) Setting the autocreation of the S3 bucket bucketName.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	autoCreateBucket(String autoCreateBucket) Setting the autocreation of the S3 bucket bucketName.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	overrideEndpoint(boolean overrideEndpoint) Set the need for overidding the endpoint.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	overrideEndpoint(String overrideEndpoint) Set the need for overidding the endpoint.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	pojoRequest(boolean pojoRequest) If we want to use a POJO request as body or not.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	pojoRequest(String pojoRequest) If we want to use a POJO request as body or not.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	policy(String policy) The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	proxyHost(String proxyHost) To define a proxy host when instantiating the SQS client.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	proxyPort(Integer proxyPort) Specify a proxy port to be used inside the client definition.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	proxyPort(String proxyPort) Specify a proxy port to be used inside the client definition.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	proxyProtocol(AWS2S3EndpointBuilderFactory.Protocol proxyProtocol) To define a proxy protocol when instantiating the S3 client.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	proxyProtocol(String proxyProtocol) To define a proxy protocol when instantiating the S3 client.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	region(String region) The region in which S3 client needs to work.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	secretKey(String secretKey) Amazon AWS Secret Key.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	trustAllCertificates(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	trustAllCertificates(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	uriEndpointOverride(String uriEndpointOverride) Set the overriding uri endpoint.
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder	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.AWS2S3EndpointBuilder	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.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, bridgeErrorHandler, bridgeErrorHandler, delay, delay, deleteAfterRead, deleteAfterRead, delimiter, destinationBucket, destinationBucketPrefix, destinationBucketSuffix, fileName, greedy, greedy, includeBody, includeBody, includeFolders, includeFolders, initialDelay, initialDelay, maxConnections, maxConnections, maxMessagesPerPoll, maxMessagesPerPoll, moveAfterRead, moveAfterRead, prefix, 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.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

deleteAfterWrite, deleteAfterWrite, keyName, lazyStartProducer, lazyStartProducer, multiPartUpload, multiPartUpload, operation, operation, partSize, partSize, storageClass

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointBuilder advanced()

Specified by:

advanced in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

advanced in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

amazonS3Client

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder amazonS3Client(Object amazonS3Client)

Reference to a com.amazonaws.services.s3.AmazonS3 in the registry. The option is a: <code>software.amazon.awssdk.services.s3.S3Client</code> type. Group: common

Specified by:

amazonS3Client in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

amazonS3Client in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

amazonS3Client - the value to set

Returns:

the dsl builder

amazonS3Client

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder amazonS3Client(String amazonS3Client)

Reference to a com.amazonaws.services.s3.AmazonS3 in the registry. The option will be converted to a <code>software.amazon.awssdk.services.s3.S3Client</code> type. Group: common

Specified by:

amazonS3Client in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

amazonS3Client in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

amazonS3Client - the value to set

Returns:

the dsl builder

amazonS3Presigner

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder amazonS3Presigner(Object amazonS3Presigner)

An S3 Presigner for Request, used mainly in createDownloadLink operation. The option is a: <code>software.amazon.awssdk.services.s3.presigner.S3Presigner</code> type. Group: common

Specified by:

amazonS3Presigner in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

amazonS3Presigner in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

amazonS3Presigner - the value to set

Returns:

the dsl builder

amazonS3Presigner

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder amazonS3Presigner(String amazonS3Presigner)

An S3 Presigner for Request, used mainly in createDownloadLink operation. The option will be converted to a <code>software.amazon.awssdk.services.s3.presigner.S3Presigner</code> type. Group: common

Specified by:

amazonS3Presigner in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

amazonS3Presigner in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

amazonS3Presigner - the value to set

Returns:

the dsl builder

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: true Group: common

Specified by:

autoCreateBucket in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

autoCreateBucket in interface AWS2S3EndpointBuilderFactory.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: true Group: common

Specified by:

autoCreateBucket in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

autoCreateBucket in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

autoCreateBucket - 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 interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

overrideEndpoint in interface AWS2S3EndpointBuilderFactory.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 interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

overrideEndpoint in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

overrideEndpoint - the value to set

Returns:

the dsl builder

pojoRequest

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder pojoRequest(boolean 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 interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

pojoRequest in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

pojoRequest - the value to set

Returns:

the dsl builder

pojoRequest

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder pojoRequest(String 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 interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

pojoRequest in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

pojoRequest - the value to set

Returns:

the dsl builder

policy

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder policy(String 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 interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

policy in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

policy - the value to set

Returns:

the dsl builder

proxyHost

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder proxyHost(String proxyHost)

To define a proxy host when instantiating the SQS client. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

proxyHost in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

proxyHost in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

proxyHost - the value to set

Returns:

the dsl builder

proxyPort

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder proxyPort(Integer proxyPort)

Specify a proxy port to be used inside the client definition. The option is a: <code>java.lang.Integer</code> type. Group: common

Specified by:

proxyPort in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

proxyPort in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

proxyPort - the value to set

Returns:

the dsl builder

proxyPort

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder proxyPort(String 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: common

Specified by:

proxyPort in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

proxyPort in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

proxyPort - the value to set

Returns:

the dsl builder

proxyProtocol

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder proxyProtocol(AWS2S3EndpointBuilderFactory.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: common

Specified by:

proxyProtocol in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

proxyProtocol in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

proxyProtocol

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder proxyProtocol(String 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: common

Specified by:

proxyProtocol in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

proxyProtocol in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

region

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder 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: <code>java.lang.String</code> type. Group: common

Specified by:

region in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

region in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

region - 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: common

Specified by:

trustAllCertificates in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

trustAllCertificates in interface AWS2S3EndpointBuilderFactory.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: common

Specified by:

trustAllCertificates in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

trustAllCertificates in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

trustAllCertificates - 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 interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

uriEndpointOverride in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

uriEndpointOverride - 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 or to expect static credentials to be passed in. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

useDefaultCredentialsProvider in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

useDefaultCredentialsProvider in interface AWS2S3EndpointBuilderFactory.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 or to expect static credentials to be passed in. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

useDefaultCredentialsProvider in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

useDefaultCredentialsProvider in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

useDefaultCredentialsProvider - the value to set

Returns:

the dsl builder

accessKey

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder accessKey(String accessKey)

Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

accessKey in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

accessKey in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

accessKey - the value to set

Returns:

the dsl builder

secretKey

default AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder secretKey(String secretKey)

Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

secretKey in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Specified by:

secretKey in interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Parameters:

secretKey - the value to set

Returns:

the dsl builder