AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder (Camel

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 and 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(AWS2S3EndpointBuilderFactory.AWS2S3Operations operation)` The operation to do in case the user don't want to do only an upload.
`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`	`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(AWS2S3EndpointBuilderFactory.Protocol proxyProtocol)` To define a proxy protocol when instantiating the S3 client.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder`	`proxyProtocol(String 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.

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.AdvancedAWS2S3EndpointProducerBuilder advanced()
```
  - amazonS3Client
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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
    
    Parameters:
    
    amazonS3Client - the value to set
    
    Returns:
    
    the dsl builder
  - amazonS3Client
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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
    
    Parameters:
    
    amazonS3Client - the value to set
    
    Returns:
    
    the dsl builder
  - amazonS3Presigner
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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
    
    Parameters:
    
    amazonS3Presigner - the value to set
    
    Returns:
    
    the dsl builder
  - amazonS3Presigner
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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
    
    Parameters:
    
    amazonS3Presigner - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    autoCreateBucket - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    autoCreateBucket - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    overrideEndpoint - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    overrideEndpoint - the value to set
    
    Returns:
    
    the dsl builder
  - pojoRequest
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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
    
    Parameters:
    
    pojoRequest - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    pojoRequest - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    policy - the value to set
    
    Returns:
    
    the dsl builder
  - proxyHost
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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
    
    Parameters:
    
    proxyHost - the value to set
    
    Returns:
    
    the dsl builder
  - proxyPort
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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
    
    Parameters:
    
    proxyPort - the value to set
    
    Returns:
    
    the dsl builder
  - proxyPort
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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
    
    Parameters:
    
    proxyPort - the value to set
    
    Returns:
    
    the dsl builder
  - proxyProtocol
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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
    
    Parameters:
    
    proxyProtocol - the value to set
    
    Returns:
    
    the dsl builder
  - proxyProtocol
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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
    
    Parameters:
    
    proxyProtocol - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    region - the value to set
    
    Returns:
    
    the dsl builder
  - trustAllCertificates
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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
    
    Parameters:
    
    trustAllCertificates - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    trustAllCertificates - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    uriEndpointOverride - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    useDefaultCredentialsProvider - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    useDefaultCredentialsProvider - the value to set
    
    Returns:
    
    the dsl builder
  - deleteAfterWrite
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder deleteAfterWrite(boolean deleteAfterWrite)
```
    Delete file object after the S3 file has been uploaded. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    deleteAfterWrite - the value to set
    
    Returns:
    
    the dsl builder
  - deleteAfterWrite
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder deleteAfterWrite(String deleteAfterWrite)
```
    Delete file object after the S3 file has been uploaded. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    deleteAfterWrite - the value to set
    
    Returns:
    
    the dsl builder
  - keyName
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder keyName(String keyName)
```
    Setting the key name for an element in the bucket through endpoint parameter. The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    keyName - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    multiPartUpload - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    multiPartUpload - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>org.apache.camel.component.aws2.s3.AWS2S3Operations</code> type. Group: producer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>org.apache.camel.component.aws2.s3.AWS2S3Operations</code> type. Group: producer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>long</code> type. Default: 26214400 Group: producer
    
    Parameters:
    
    partSize - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>long</code> type. Default: 26214400 Group: producer
    
    Parameters:
    
    partSize - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    storageClass - the value to set
    
    Returns:
    
    the dsl builder
  - accessKey
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder accessKey(String accessKey)
```
    Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    accessKey - the value to set
    
    Returns:
    
    the dsl builder
  - secretKey
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder secretKey(String secretKey)
```
    Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    secretKey - the value to set
    
    Returns:
    
    the dsl builder

Interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

advanced

amazonS3Client

amazonS3Client

amazonS3Presigner

amazonS3Presigner

autoCreateBucket

autoCreateBucket

overrideEndpoint

overrideEndpoint

pojoRequest

pojoRequest

policy

proxyHost

proxyPort

proxyPort

proxyProtocol

proxyProtocol

region

trustAllCertificates

trustAllCertificates

uriEndpointOverride

useDefaultCredentialsProvider

useDefaultCredentialsProvider

deleteAfterWrite

deleteAfterWrite

keyName

lazyStartProducer

lazyStartProducer

multiPartUpload

multiPartUpload

operation

operation

partSize

partSize

storageClass

accessKey

secretKey