AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder

Enclosing interface:

AWS2S3EndpointBuilderFactory
```
public static interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the AWS 2 S3 Storage Service component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointConsumerBuilder`	`advanced()`
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`amazonS3Client(Object amazonS3Client)` Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`amazonS3Client(String amazonS3Client)` Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`autoCreateBucket(boolean autoCreateBucket)` Setting the autocreation of the S3 bucket bucketName.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`autoCreateBucket(String autoCreateBucket)` Setting the autocreation of the S3 bucket bucketName.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`backoffErrorThreshold(int backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`backoffErrorThreshold(String backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`backoffIdleThreshold(int backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`backoffIdleThreshold(String backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`backoffMultiplier(int backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`backoffMultiplier(String backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`bridgeErrorHandler(String bridgeErrorHandler)` Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`delay(long delay)` Milliseconds before the next poll.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`delay(String delay)` Milliseconds before the next poll.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`deleteAfterRead(boolean deleteAfterRead)` Delete objects from S3 after they have been retrieved.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`deleteAfterRead(String deleteAfterRead)` Delete objects from S3 after they have been retrieved.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`delimiter(String delimiter)` The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`destinationBucket(String destinationBucket)` Define the destination bucket where an object must be moved when moveAfterRead is set to true.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`destinationBucketPrefix(String destinationBucketPrefix)` Define the destination bucket prefix to use when an object must be moved and moveAfterRead is set to true.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`destinationBucketSuffix(String destinationBucketSuffix)` Define the destination bucket suffix to use when an object must be moved and moveAfterRead is set to true.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`fileName(String fileName)` To get the object from the bucket with the given file name.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`greedy(boolean greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`greedy(String greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`includeBody(boolean includeBody)` If it is true, the S3Object exchange will be consumed and put into the body and closed.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`includeBody(String includeBody)` If it is true, the S3Object exchange will be consumed and put into the body and closed.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`includeFolders(boolean includeFolders)` If it is true, the folders/directories will be consumed.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`includeFolders(String includeFolders)` If it is true, the folders/directories will be consumed.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`initialDelay(long initialDelay)` Milliseconds before the first poll starts.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`initialDelay(String initialDelay)` Milliseconds before the first poll starts.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`maxConnections(int maxConnections)` Set the maxConnections parameter in the S3 client configuration.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`maxConnections(String maxConnections)` Set the maxConnections parameter in the S3 client configuration.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`maxMessagesPerPoll(int maxMessagesPerPoll)` Gets the maximum number of messages as a limit to poll at each polling.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`maxMessagesPerPoll(String maxMessagesPerPoll)` Gets the maximum number of messages as a limit to poll at each polling.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`moveAfterRead(boolean moveAfterRead)` Move objects from S3 bucket to a different bucket after they have been retrieved.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`moveAfterRead(String moveAfterRead)` Move objects from S3 bucket to a different bucket after they have been retrieved.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`overrideEndpoint(boolean overrideEndpoint)` Set the need for overidding the endpoint.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`overrideEndpoint(String overrideEndpoint)` Set the need for overidding the endpoint.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`pojoRequest(boolean pojoRequest)` If we want to use a POJO request as body or not.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`pojoRequest(String pojoRequest)` If we want to use a POJO request as body or not.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`policy(String policy)` The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`prefix(String prefix)` The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the SQS client.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`proxyPort(Integer proxyPort)` Specify a proxy port to be used inside the client definition.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`proxyPort(String proxyPort)` Specify a proxy port to be used inside the client definition.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`proxyProtocol(AWS2S3EndpointBuilderFactory.Protocol proxyProtocol)` To define a proxy protocol when instantiating the S3 client.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`proxyProtocol(String proxyProtocol)` To define a proxy protocol when instantiating the S3 client.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`region(String region)` The region in which S3 client needs to work.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`repeatCount(long repeatCount)` Specifies a maximum limit of number of fires.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`repeatCount(String repeatCount)` Specifies a maximum limit of number of fires.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`runLoggingLevel(String runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`scheduledExecutorService(String scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`scheduler(Object scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`scheduler(String scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`schedulerProperties(Map values)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`schedulerProperties(String key, Object value)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)` If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)` If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`startScheduler(boolean startScheduler)` Whether the scheduler should be auto started.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`startScheduler(String startScheduler)` Whether the scheduler should be auto started.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`timeUnit(String timeUnit)` Time unit for initialDelay and delay options.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`timeUnit(TimeUnit timeUnit)` Time unit for initialDelay and delay options.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`trustAllCertificates(boolean trustAllCertificates)` If we want to trust all certificates in case of overriding the endpoint.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`trustAllCertificates(String trustAllCertificates)` If we want to trust all certificates in case of overriding the endpoint.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`uriEndpointOverride(String uriEndpointOverride)` Set the overriding uri endpoint.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`useFixedDelay(boolean useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`useFixedDelay(String useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder`	`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.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- Method Detail
  - advanced
```
default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointConsumerBuilder advanced()
```
  - amazonS3Client
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder amazonS3Client(Object amazonS3Client)
```
    Reference to a com.amazonaws.services.s3.AmazonS3 in the registry. The option is a: software.amazon.awssdk.services.s3.S3Client type. Group: common
  - amazonS3Client
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder amazonS3Client(String amazonS3Client)
```
    Reference to a com.amazonaws.services.s3.AmazonS3 in the registry. The option will be converted to a software.amazon.awssdk.services.s3.S3Client type. Group: common
  - autoCreateBucket
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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: boolean type. Default: true Group: common
  - autoCreateBucket
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 boolean type. Default: true Group: common
  - autoDiscoverClient
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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: boolean type. Default: true Group: common
  - autoDiscoverClient
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 boolean type. Default: true Group: common
  - overrideEndpoint
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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: boolean type. Default: false Group: common
  - overrideEndpoint
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 boolean type. Default: false Group: common
  - pojoRequest
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder pojoRequest(boolean pojoRequest)
```
    If we want to use a POJO request as body or not. The option is a: boolean type. Default: false Group: common
  - pojoRequest
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder pojoRequest(String pojoRequest)
```
    If we want to use a POJO request as body or not. The option will be converted to a boolean type. Default: false Group: common
  - policy
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder policy(String policy)
```
    The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method. The option is a: java.lang.String type. Group: common
  - proxyHost
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder proxyHost(String proxyHost)
```
    To define a proxy host when instantiating the SQS client. The option is a: java.lang.String type. Group: common
  - proxyPort
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder proxyPort(Integer proxyPort)
```
    Specify a proxy port to be used inside the client definition. The option is a: java.lang.Integer type. Group: common
  - proxyPort
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder proxyPort(String proxyPort)
```
    Specify a proxy port to be used inside the client definition. The option will be converted to a java.lang.Integer type. Group: common
  - proxyProtocol
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder proxyProtocol(AWS2S3EndpointBuilderFactory.Protocol proxyProtocol)
```
    To define a proxy protocol when instantiating the S3 client. The option is a: software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: common
  - proxyProtocol
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder proxyProtocol(String proxyProtocol)
```
    To define a proxy protocol when instantiating the S3 client. The option will be converted to a software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: common
  - region
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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: java.lang.String type. Group: common
  - trustAllCertificates
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder trustAllCertificates(boolean trustAllCertificates)
```
    If we want to trust all certificates in case of overriding the endpoint. The option is a: boolean type. Default: false Group: common
  - trustAllCertificates
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder trustAllCertificates(String trustAllCertificates)
```
    If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a boolean type. Default: false Group: common
  - uriEndpointOverride
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder uriEndpointOverride(String uriEndpointOverride)
```
    Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: java.lang.String type. Group: common
  - useIAMCredentials
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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: boolean type. Default: false Group: common
  - useIAMCredentials
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 boolean type. Default: false Group: common
  - bridgeErrorHandler
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer
  - bridgeErrorHandler
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
```
    Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a boolean type. Default: false Group: consumer
  - deleteAfterRead
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder deleteAfterRead(boolean deleteAfterRead)
```
    Delete objects from S3 after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the AWS2S3Constants#BUCKET_NAME and AWS2S3Constants#KEY headers, or only the AWS2S3Constants#KEY header. The option is a: boolean type. Default: true Group: consumer
  - deleteAfterRead
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder deleteAfterRead(String deleteAfterRead)
```
    Delete objects from S3 after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the AWS2S3Constants#BUCKET_NAME and AWS2S3Constants#KEY headers, or only the AWS2S3Constants#KEY header. The option will be converted to a boolean type. Default: true Group: consumer
  - delimiter
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder delimiter(String 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: java.lang.String type. Group: consumer
  - destinationBucket
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder destinationBucket(String destinationBucket)
```
    Define the destination bucket where an object must be moved when moveAfterRead is set to true. The option is a: java.lang.String type. Group: consumer
  - destinationBucketPrefix
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder destinationBucketPrefix(String destinationBucketPrefix)
```
    Define the destination bucket prefix to use when an object must be moved and moveAfterRead is set to true. The option is a: java.lang.String type. Group: consumer
  - destinationBucketSuffix
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder destinationBucketSuffix(String destinationBucketSuffix)
```
    Define the destination bucket suffix to use when an object must be moved and moveAfterRead is set to true. The option is a: java.lang.String type. Group: consumer
  - fileName
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder fileName(String fileName)
```
    To get the object from the bucket with the given file name. The option is a: java.lang.String type. Group: consumer
  - includeBody
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder includeBody(boolean includeBody)
```
    If it is true, the S3Object exchange will be consumed and put into the body and closed. If false the S3Object stream will be put raw into the body and the headers will be set with the S3 object metadata. This option is strongly related to autocloseBody option. In case of setting includeBody to true because the S3Object stream will be consumed then it will also be closed in case of includeBody false then it will be up to the caller to close the S3Object stream. However setting autocloseBody to true when includeBody is false it will schedule to close the S3Object stream automatically on exchange completion. The option is a: boolean type. Default: true Group: consumer
  - includeBody
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder includeBody(String includeBody)
```
    If it is true, the S3Object exchange will be consumed and put into the body and closed. If false the S3Object stream will be put raw into the body and the headers will be set with the S3 object metadata. This option is strongly related to autocloseBody option. In case of setting includeBody to true because the S3Object stream will be consumed then it will also be closed in case of includeBody false then it will be up to the caller to close the S3Object stream. However setting autocloseBody to true when includeBody is false it will schedule to close the S3Object stream automatically on exchange completion. The option will be converted to a boolean type. Default: true Group: consumer
  - includeFolders
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder includeFolders(boolean includeFolders)
```
    If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those. The option is a: boolean type. Default: true Group: consumer
  - includeFolders
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder includeFolders(String includeFolders)
```
    If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those. The option will be converted to a boolean type. Default: true Group: consumer
  - maxConnections
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder maxConnections(int maxConnections)
```
    Set the maxConnections parameter in the S3 client configuration. The option is a: int type. Default: 60 Group: consumer
  - maxConnections
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder maxConnections(String maxConnections)
```
    Set the maxConnections parameter in the S3 client configuration. The option will be converted to a int type. Default: 60 Group: consumer
  - maxMessagesPerPoll
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder maxMessagesPerPoll(int maxMessagesPerPoll)
```
    Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited. The option is a: int type. Default: 10 Group: consumer
  - maxMessagesPerPoll
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder maxMessagesPerPoll(String maxMessagesPerPoll)
```
    Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited. The option will be converted to a int type. Default: 10 Group: consumer
  - moveAfterRead
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder moveAfterRead(boolean moveAfterRead)
```
    Move objects from S3 bucket to a different bucket after they have been retrieved. To accomplish the operation the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved. The option is a: boolean type. Default: false Group: consumer
  - moveAfterRead
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder moveAfterRead(String moveAfterRead)
```
    Move objects from S3 bucket to a different bucket after they have been retrieved. To accomplish the operation the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved. The option will be converted to a boolean type. Default: false Group: consumer
  - prefix
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder prefix(String 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: java.lang.String type. Group: consumer
  - sendEmptyMessageWhenIdle
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
```
    If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: boolean type. Default: false Group: consumer
  - sendEmptyMessageWhenIdle
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
```
    If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a boolean type. Default: false Group: consumer
  - backoffErrorThreshold
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold)
```
    The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
  - backoffErrorThreshold
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold)
```
    The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a int type. Group: scheduler
  - backoffIdleThreshold
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
```
    The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
  - backoffIdleThreshold
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold)
```
    The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a int type. Group: scheduler
  - backoffMultiplier
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder backoffMultiplier(int backoffMultiplier)
```
    To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: int type. Group: scheduler
  - backoffMultiplier
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder backoffMultiplier(String backoffMultiplier)
```
    To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a int type. Group: scheduler
  - delay
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder delay(long delay)
```
    Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler
  - delay
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder delay(String delay)
```
    Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler
  - greedy
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder greedy(boolean greedy)
```
    If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: boolean type. Default: false Group: scheduler
  - greedy
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder greedy(String greedy)
```
    If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a boolean type. Default: false Group: scheduler
  - initialDelay
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder initialDelay(long initialDelay)
```
    Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler
  - initialDelay
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder initialDelay(String initialDelay)
```
    Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler
  - repeatCount
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder repeatCount(long repeatCount)
```
    Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: long type. Default: 0 Group: scheduler
  - repeatCount
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder repeatCount(String repeatCount)
```
    Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a long type. Default: 0 Group: scheduler
  - runLoggingLevel
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
```
    The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
  - runLoggingLevel
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder runLoggingLevel(String runLoggingLevel)
```
    The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
  - scheduledExecutorService
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
```
    Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: java.util.concurrent.ScheduledExecutorService type. Group: scheduler
  - scheduledExecutorService
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService)
```
    Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a java.util.concurrent.ScheduledExecutorService type. Group: scheduler
  - scheduler
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder scheduler(Object scheduler)
```
    To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: java.lang.Object type. Default: none Group: scheduler
  - scheduler
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder scheduler(String scheduler)
```
    To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a java.lang.Object type. Default: none Group: scheduler
  - schedulerProperties
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder schedulerProperties(String key,
                                                                                       Object value)
```
    To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
  - schedulerProperties
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder schedulerProperties(Map values)
```
    To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
  - startScheduler
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder startScheduler(boolean startScheduler)
```
    Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler
  - startScheduler
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder startScheduler(String startScheduler)
```
    Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler
  - timeUnit
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
```
    Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
  - timeUnit
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder timeUnit(String timeUnit)
```
    Time unit for initialDelay and delay options. The option will be converted to a java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
  - useFixedDelay
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
```
    Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: boolean type. Default: true Group: scheduler
  - useFixedDelay
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder useFixedDelay(String useFixedDelay)
```
    Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a boolean type. Default: true Group: scheduler
  - accessKey
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder accessKey(String accessKey)
```
    Amazon AWS Access Key. The option is a: java.lang.String type. Group: security
  - secretKey
```
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder secretKey(String secretKey)
```
    Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security

Interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

amazonS3Client

amazonS3Client

autoCreateBucket

autoCreateBucket

autoDiscoverClient

autoDiscoverClient

overrideEndpoint

overrideEndpoint

pojoRequest

pojoRequest

policy

proxyHost

proxyPort

proxyPort

proxyProtocol

proxyProtocol

region

trustAllCertificates

trustAllCertificates

uriEndpointOverride

useIAMCredentials

useIAMCredentials

bridgeErrorHandler

bridgeErrorHandler

deleteAfterRead

deleteAfterRead

delimiter

destinationBucket

destinationBucketPrefix

destinationBucketSuffix

fileName

includeBody

includeBody

includeFolders

includeFolders

maxConnections

maxConnections

maxMessagesPerPoll

maxMessagesPerPoll

moveAfterRead

moveAfterRead

prefix

sendEmptyMessageWhenIdle

sendEmptyMessageWhenIdle

backoffErrorThreshold

backoffErrorThreshold

backoffIdleThreshold

backoffIdleThreshold

backoffMultiplier

backoffMultiplier

delay

delay

greedy

greedy

initialDelay

initialDelay

repeatCount

repeatCount

runLoggingLevel

runLoggingLevel

scheduledExecutorService

scheduledExecutorService

scheduler

scheduler

schedulerProperties

schedulerProperties

startScheduler

startScheduler

timeUnit

timeUnit

useFixedDelay

useFixedDelay

accessKey

secretKey