S3EndpointBuilderFactory.S3EndpointProducerBuilder (Camel

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

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.AdvancedS3EndpointProducerBuilder advanced()
```
  - amazonS3Client
```
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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
    
    Parameters:
    
    amazonS3Client - the value to set
    
    Returns:
    
    the dsl builder
  - amazonS3Client
```
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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
    
    Parameters:
    
    amazonS3Client - the value to set
    
    Returns:
    
    the dsl builder
  - autoCreateBucket
```
default S3EndpointBuilderFactory.S3EndpointProducerBuilder autoCreateBucket(boolean autoCreateBucket)
```
    Setting the autocreation of the bucket. The option is a: <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    autoCreateBucket - the value to set
    
    Returns:
    
    the dsl builder
  - autoCreateBucket
```
default S3EndpointBuilderFactory.S3EndpointProducerBuilder autoCreateBucket(String autoCreateBucket)
```
    Setting the autocreation of the bucket. 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
  - 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: <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    autoDiscoverClient - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    autoDiscoverClient - the value to set
    
    Returns:
    
    the dsl builder
  - endpointConfiguration
```
default S3EndpointBuilderFactory.S3EndpointProducerBuilder endpointConfiguration(Object endpointConfiguration)
```
    Amazon AWS Endpoint Configuration. The option is a: <code>com.amazonaws.client.builder.AwsClientBuilder$EndpointConfiguration</code> type. Group: common
    
    Parameters:
    
    endpointConfiguration - the value to set
    
    Returns:
    
    the dsl builder
  - endpointConfiguration
```
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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
    
    Parameters:
    
    endpointConfiguration - the value to set
    
    Returns:
    
    the dsl builder
  - pathStyleAccess
```
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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
    
    Parameters:
    
    pathStyleAccess - the value to set
    
    Returns:
    
    the dsl builder
  - pathStyleAccess
```
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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
    
    Parameters:
    
    pathStyleAccess - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    policy - the value to set
    
    Returns:
    
    the dsl builder
  - proxyHost
```
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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
    
    Parameters:
    
    proxyHost - the value to set
    
    Returns:
    
    the dsl builder
  - proxyPort
```
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder 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
    
    Parameters:
    
    proxyProtocol - the value to set
    
    Returns:
    
    the dsl builder
  - proxyProtocol
```
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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
    
    Parameters:
    
    proxyProtocol - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    region - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    useIAMCredentials - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    useIAMCredentials - the value to set
    
    Returns:
    
    the dsl builder
  - deleteAfterWrite
```
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 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: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    multiPartUpload - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    multiPartUpload - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>org.apache.camel.component.aws.s3.S3Operations</code> type. Group: producer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>org.apache.camel.component.aws.s3.S3Operations</code> type. Group: producer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>long</code> type. Default: 26214400 Group: producer
    
    Parameters:
    
    partSize - the value to set
    
    Returns:
    
    the dsl builder
  - 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 a <code>long</code> type. Default: 26214400 Group: producer
    
    Parameters:
    
    partSize - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    serverSideEncryption - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    storageClass - the value to set
    
    Returns:
    
    the dsl builder
  - accessKey
```
default S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder 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 S3EndpointBuilderFactory.S3EndpointProducerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

advanced

amazonS3Client

amazonS3Client

autoCreateBucket

autoCreateBucket

autoDiscoverClient

autoDiscoverClient

endpointConfiguration

endpointConfiguration

pathStyleAccess

pathStyleAccess

policy

proxyHost

proxyPort

proxyPort

proxyProtocol

proxyProtocol

region

useIAMCredentials

useIAMCredentials

deleteAfterWrite

deleteAfterWrite

keyName

lazyStartProducer

lazyStartProducer

multiPartUpload

multiPartUpload

operation

operation

partSize

partSize

serverSideEncryption

storageClass

accessKey

secretKey