org.apache.camel.builder.endpoint.dsl

Interface S3EndpointBuilderFactory.S3EndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, S3EndpointBuilderFactory.S3EndpointConsumerBuilder, S3EndpointBuilderFactory.S3EndpointProducerBuilder

Enclosing interface:

S3EndpointBuilderFactory

public static interface S3EndpointBuilderFactory.S3EndpointBuilder
extends S3EndpointBuilderFactory.S3EndpointConsumerBuilder, S3EndpointBuilderFactory.S3EndpointProducerBuilder

Builder for endpoint for the AWS S3 Storage Service component.

Method Summary

Modifier and Type	Method and Description
default S3EndpointBuilderFactory.S3EndpointBuilder	accessKey(String accessKey) Amazon AWS Access Key.
default S3EndpointBuilderFactory.AdvancedS3EndpointBuilder	advanced()
default S3EndpointBuilderFactory.S3EndpointBuilder	amazonS3Client(Object amazonS3Client) Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.
default S3EndpointBuilderFactory.S3EndpointBuilder	amazonS3Client(String amazonS3Client) Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.
default S3EndpointBuilderFactory.S3EndpointBuilder	autoCreateBucket(boolean autoCreateBucket) Setting the autocreation of the bucket.
default S3EndpointBuilderFactory.S3EndpointBuilder	autoCreateBucket(String autoCreateBucket) Setting the autocreation of the bucket.
default S3EndpointBuilderFactory.S3EndpointBuilder	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.S3EndpointBuilder	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.S3EndpointBuilder	endpointConfiguration(Object endpointConfiguration) Amazon AWS Endpoint Configuration.
default S3EndpointBuilderFactory.S3EndpointBuilder	endpointConfiguration(String endpointConfiguration) Amazon AWS Endpoint Configuration.
default S3EndpointBuilderFactory.S3EndpointBuilder	pathStyleAccess(boolean pathStyleAccess) Whether or not the S3 client should use path style access.
default S3EndpointBuilderFactory.S3EndpointBuilder	pathStyleAccess(String pathStyleAccess) Whether or not the S3 client should use path style access.
default S3EndpointBuilderFactory.S3EndpointBuilder	policy(String policy) The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.
default S3EndpointBuilderFactory.S3EndpointBuilder	proxyHost(String proxyHost) To define a proxy host when instantiating the S3 client.
default S3EndpointBuilderFactory.S3EndpointBuilder	proxyPort(Integer proxyPort) Specify a proxy port to be used inside the client definition.
default S3EndpointBuilderFactory.S3EndpointBuilder	proxyPort(String proxyPort) Specify a proxy port to be used inside the client definition.
default S3EndpointBuilderFactory.S3EndpointBuilder	proxyProtocol(S3EndpointBuilderFactory.Protocol proxyProtocol) To define a proxy protocol when instantiating the S3 client.
default S3EndpointBuilderFactory.S3EndpointBuilder	proxyProtocol(String proxyProtocol) To define a proxy protocol when instantiating the S3 client.
default S3EndpointBuilderFactory.S3EndpointBuilder	region(String region) The region in which S3 client needs to work.
default S3EndpointBuilderFactory.S3EndpointBuilder	secretKey(String secretKey) Amazon AWS Secret Key.
default S3EndpointBuilderFactory.S3EndpointBuilder	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.S3EndpointBuilder	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.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.S3EndpointBuilderFactory.S3EndpointConsumerBuilder

backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, bridgeErrorHandler, bridgeErrorHandler, delay, delay, deleteAfterRead, deleteAfterRead, delimiter, fileName, greedy, greedy, includeBody, includeBody, initialDelay, initialDelay, maxConnections, maxConnections, maxMessagesPerPoll, maxMessagesPerPoll, 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.S3EndpointBuilderFactory.S3EndpointProducerBuilder

deleteAfterWrite, deleteAfterWrite, keyName, lazyStartProducer, lazyStartProducer, multiPartUpload, multiPartUpload, operation, operation, partSize, partSize, serverSideEncryption, 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 S3EndpointBuilderFactory.AdvancedS3EndpointBuilder advanced()

Specified by:

advanced in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

advanced in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

amazonS3Client

default S3EndpointBuilderFactory.S3EndpointBuilder amazonS3Client(Object amazonS3Client)

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

Specified by:

amazonS3Client in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

amazonS3Client in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

amazonS3Client - the value to set

Returns:

the dsl builder

amazonS3Client

default S3EndpointBuilderFactory.S3EndpointBuilder amazonS3Client(String amazonS3Client)

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

Specified by:

amazonS3Client in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

amazonS3Client in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

amazonS3Client - the value to set

Returns:

the dsl builder

autoCreateBucket

default S3EndpointBuilderFactory.S3EndpointBuilder autoCreateBucket(boolean autoCreateBucket)

Setting the autocreation of the bucket. The option is a: <code>boolean</code> type. Default: true Group: common

Specified by:

autoCreateBucket in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

autoCreateBucket in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

autoCreateBucket - the value to set

Returns:

the dsl builder

autoCreateBucket

default S3EndpointBuilderFactory.S3EndpointBuilder autoCreateBucket(String autoCreateBucket)

Setting the autocreation of the bucket. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Specified by:

autoCreateBucket in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

autoCreateBucket in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

autoCreateBucket - the value to set

Returns:

the dsl builder

autoDiscoverClient

default S3EndpointBuilderFactory.S3EndpointBuilder 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: <code>boolean</code> type. Default: true Group: common

Specified by:

autoDiscoverClient in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

autoDiscoverClient in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

autoDiscoverClient - the value to set

Returns:

the dsl builder

autoDiscoverClient

default S3EndpointBuilderFactory.S3EndpointBuilder 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 a <code>boolean</code> type. Default: true Group: common

Specified by:

autoDiscoverClient in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

autoDiscoverClient in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

autoDiscoverClient - the value to set

Returns:

the dsl builder

endpointConfiguration

default S3EndpointBuilderFactory.S3EndpointBuilder endpointConfiguration(Object endpointConfiguration)

Amazon AWS Endpoint Configuration. The option is a: <code>com.amazonaws.client.builder.AwsClientBuilder$EndpointConfiguration</code> type. Group: common

Specified by:

endpointConfiguration in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

endpointConfiguration in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

endpointConfiguration - the value to set

Returns:

the dsl builder

endpointConfiguration

default S3EndpointBuilderFactory.S3EndpointBuilder endpointConfiguration(String endpointConfiguration)

Amazon AWS Endpoint Configuration. The option will be converted to a <code>com.amazonaws.client.builder.AwsClientBuilder$EndpointConfiguration</code> type. Group: common

Specified by:

endpointConfiguration in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

endpointConfiguration in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

endpointConfiguration - the value to set

Returns:

the dsl builder

pathStyleAccess

default S3EndpointBuilderFactory.S3EndpointBuilder pathStyleAccess(boolean pathStyleAccess)

Whether or not the S3 client should use path style access. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

pathStyleAccess in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

pathStyleAccess in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

pathStyleAccess - the value to set

Returns:

the dsl builder

pathStyleAccess

default S3EndpointBuilderFactory.S3EndpointBuilder pathStyleAccess(String pathStyleAccess)

Whether or not the S3 client should use path style access. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

pathStyleAccess in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

pathStyleAccess in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

pathStyleAccess - the value to set

Returns:

the dsl builder

policy

default S3EndpointBuilderFactory.S3EndpointBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

policy in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

policy - the value to set

Returns:

the dsl builder

proxyHost

default S3EndpointBuilderFactory.S3EndpointBuilder proxyHost(String proxyHost)

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

Specified by:

proxyHost in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

proxyHost in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

proxyHost - the value to set

Returns:

the dsl builder

proxyPort

default S3EndpointBuilderFactory.S3EndpointBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

proxyPort in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

proxyPort - the value to set

Returns:

the dsl builder

proxyPort

default S3EndpointBuilderFactory.S3EndpointBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

proxyPort in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

proxyPort - the value to set

Returns:

the dsl builder

proxyProtocol

default S3EndpointBuilderFactory.S3EndpointBuilder proxyProtocol(S3EndpointBuilderFactory.Protocol proxyProtocol)

To define a proxy protocol when instantiating the S3 client. The option is a: <code>com.amazonaws.Protocol</code> type. Default: HTTPS Group: common

Specified by:

proxyProtocol in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

proxyProtocol in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

proxyProtocol

default S3EndpointBuilderFactory.S3EndpointBuilder proxyProtocol(String proxyProtocol)

To define a proxy protocol when instantiating the S3 client. The option will be converted to a <code>com.amazonaws.Protocol</code> type. Default: HTTPS Group: common

Specified by:

proxyProtocol in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

proxyProtocol in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

region

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

Specified by:

region in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

region in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

region - the value to set

Returns:

the dsl builder

useIAMCredentials

default S3EndpointBuilderFactory.S3EndpointBuilder 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: <code>boolean</code> type. Default: false Group: common

Specified by:

useIAMCredentials in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

useIAMCredentials in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

useIAMCredentials - the value to set

Returns:

the dsl builder

useIAMCredentials

default S3EndpointBuilderFactory.S3EndpointBuilder 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 a <code>boolean</code> type. Default: false Group: common

Specified by:

useIAMCredentials in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

useIAMCredentials in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

useIAMCredentials - the value to set

Returns:

the dsl builder

accessKey

default S3EndpointBuilderFactory.S3EndpointBuilder accessKey(String accessKey)

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

Specified by:

accessKey in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

accessKey in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

accessKey - the value to set

Returns:

the dsl builder

secretKey

default S3EndpointBuilderFactory.S3EndpointBuilder secretKey(String secretKey)

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

Specified by:

secretKey in interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

Specified by:

secretKey in interface S3EndpointBuilderFactory.S3EndpointProducerBuilder

Parameters:

secretKey - the value to set

Returns:

the dsl builder