S3EndpointBuilderFactory.S3EndpointConsumerBuilder (Camel

All Superinterfaces:

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

All Known Subinterfaces:

S3EndpointBuilderFactory.S3EndpointBuilder

Enclosing interface:

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

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`advanced()`
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`amazonS3Client(Object amazonS3Client)` Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`amazonS3Client(String amazonS3Client)` Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`autoCreateBucket(boolean autoCreateBucket)` Setting the autocreation of the bucket.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`autoCreateBucket(String autoCreateBucket)` Setting the autocreation of the bucket.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`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.S3EndpointConsumerBuilder`	`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.S3EndpointConsumerBuilder`	`backoffErrorThreshold(int backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`backoffErrorThreshold(String backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`backoffIdleThreshold(int backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`backoffIdleThreshold(String backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`backoffMultiplier(int backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`backoffMultiplier(String backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`delay(long delay)` Milliseconds before the next poll.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`delay(String delay)` Milliseconds before the next poll.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`deleteAfterRead(boolean deleteAfterRead)` Delete objects from S3 after they have been retrieved.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`deleteAfterRead(String deleteAfterRead)` Delete objects from S3 after they have been retrieved.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`endpointConfiguration(Object endpointConfiguration)` Amazon AWS Endpoint Configuration.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`endpointConfiguration(String endpointConfiguration)` Amazon AWS Endpoint Configuration.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`fileName(String fileName)` To get the object from the bucket with the given file name.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`greedy(boolean greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`greedy(String greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`includeBody(boolean includeBody)` If it is true, the exchange body will be set to a stream to the contents of the file.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`includeBody(String includeBody)` If it is true, the exchange body will be set to a stream to the contents of the file.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`initialDelay(long initialDelay)` Milliseconds before the first poll starts.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`initialDelay(String initialDelay)` Milliseconds before the first poll starts.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`maxConnections(int maxConnections)` Set the maxConnections parameter in the S3 client configuration.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`maxConnections(String maxConnections)` Set the maxConnections parameter in the S3 client configuration.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`maxMessagesPerPoll(int maxMessagesPerPoll)` Gets the maximum number of messages as a limit to poll at each polling.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`maxMessagesPerPoll(String maxMessagesPerPoll)` Gets the maximum number of messages as a limit to poll at each polling.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`pathStyleAccess(boolean pathStyleAccess)` Whether or not the S3 client should use path style access.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`pathStyleAccess(String pathStyleAccess)` Whether or not the S3 client should use path style access.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`policy(String policy)` The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the S3 client.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`proxyPort(Integer proxyPort)` Specify a proxy port to be used inside the client definition.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`proxyPort(String proxyPort)` Specify a proxy port to be used inside the client definition.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`proxyProtocol(S3EndpointBuilderFactory.Protocol proxyProtocol)` To define a proxy protocol when instantiating the S3 client.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`proxyProtocol(String proxyProtocol)` To define a proxy protocol when instantiating the S3 client.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`region(String region)` The region in which S3 client needs to work.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`repeatCount(long repeatCount)` Specifies a maximum limit of number of fires.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`repeatCount(String repeatCount)` Specifies a maximum limit of number of fires.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`runLoggingLevel(String runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`scheduledExecutorService(String scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`scheduler(Object scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`scheduler(String scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`schedulerProperties(Map values)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`schedulerProperties(String key, Object value)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`startScheduler(boolean startScheduler)` Whether the scheduler should be auto started.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`startScheduler(String startScheduler)` Whether the scheduler should be auto started.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`timeUnit(String timeUnit)` Time unit for initialDelay and delay options.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`timeUnit(TimeUnit timeUnit)` Time unit for initialDelay and delay options.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`useFixedDelay(boolean useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`useFixedDelay(String useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`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.S3EndpointConsumerBuilder`	`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 S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder advanced()
```
  - amazonS3Client
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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
  - bridgeErrorHandler
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - deleteAfterRead
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3Constants#BUCKET_NAME and S3Constants#KEY headers, or only the S3Constants#KEY header. The option is a: <code>boolean</code> type. Default: true Group: consumer
    
    Parameters:
    
    deleteAfterRead - the value to set
    
    Returns:
    
    the dsl builder
  - deleteAfterRead
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3Constants#BUCKET_NAME and S3Constants#KEY headers, or only the S3Constants#KEY header. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
    
    Parameters:
    
    deleteAfterRead - the value to set
    
    Returns:
    
    the dsl builder
  - delimiter
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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: <code>java.lang.String</code> type. Group: consumer
    
    Parameters:
    
    delimiter - the value to set
    
    Returns:
    
    the dsl builder
  - fileName
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder fileName(String fileName)
```
    To get the object from the bucket with the given file name. The option is a: <code>java.lang.String</code> type. Group: consumer
    
    Parameters:
    
    fileName - the value to set
    
    Returns:
    
    the dsl builder
  - includeBody
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder includeBody(boolean includeBody)
```
    If it is true, the exchange body will be set to a stream to the contents of the file. If false, the headers will be set with the S3 object metadata, but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically. The option is a: <code>boolean</code> type. Default: true Group: consumer
    
    Parameters:
    
    includeBody - the value to set
    
    Returns:
    
    the dsl builder
  - includeBody
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder includeBody(String includeBody)
```
    If it is true, the exchange body will be set to a stream to the contents of the file. If false, the headers will be set with the S3 object metadata, but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
    
    Parameters:
    
    includeBody - the value to set
    
    Returns:
    
    the dsl builder
  - maxConnections
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder maxConnections(int maxConnections)
```
    Set the maxConnections parameter in the S3 client configuration. The option is a: <code>int</code> type. Default: 60 Group: consumer
    
    Parameters:
    
    maxConnections - the value to set
    
    Returns:
    
    the dsl builder
  - maxConnections
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder maxConnections(String maxConnections)
```
    Set the maxConnections parameter in the S3 client configuration. The option will be converted to a <code>int</code> type. Default: 60 Group: consumer
    
    Parameters:
    
    maxConnections - the value to set
    
    Returns:
    
    the dsl builder
  - maxMessagesPerPoll
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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: <code>int</code> type. Default: 10 Group: consumer
    
    Parameters:
    
    maxMessagesPerPoll - the value to set
    
    Returns:
    
    the dsl builder
  - maxMessagesPerPoll
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 <code>int</code> type. Default: 10 Group: consumer
    
    Parameters:
    
    maxMessagesPerPoll - the value to set
    
    Returns:
    
    the dsl builder
  - prefix
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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: <code>java.lang.String</code> type. Group: consumer
    
    Parameters:
    
    prefix - the value to set
    
    Returns:
    
    the dsl builder
  - sendEmptyMessageWhenIdle
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    sendEmptyMessageWhenIdle - the value to set
    
    Returns:
    
    the dsl builder
  - sendEmptyMessageWhenIdle
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    sendEmptyMessageWhenIdle - the value to set
    
    Returns:
    
    the dsl builder
  - backoffErrorThreshold
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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: <code>int</code> type. Group: scheduler
    
    Parameters:
    
    backoffErrorThreshold - the value to set
    
    Returns:
    
    the dsl builder
  - backoffErrorThreshold
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 <code>int</code> type. Group: scheduler
    
    Parameters:
    
    backoffErrorThreshold - the value to set
    
    Returns:
    
    the dsl builder
  - backoffIdleThreshold
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
```
    The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
    
    Parameters:
    
    backoffIdleThreshold - the value to set
    
    Returns:
    
    the dsl builder
  - backoffIdleThreshold
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 <code>int</code> type. Group: scheduler
    
    Parameters:
    
    backoffIdleThreshold - the value to set
    
    Returns:
    
    the dsl builder
  - backoffMultiplier
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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: <code>int</code> type. Group: scheduler
    
    Parameters:
    
    backoffMultiplier - the value to set
    
    Returns:
    
    the dsl builder
  - backoffMultiplier
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 <code>int</code> type. Group: scheduler
    
    Parameters:
    
    backoffMultiplier - the value to set
    
    Returns:
    
    the dsl builder
  - delay
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder delay(long delay)
```
    Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 500 Group: scheduler
    
    Parameters:
    
    delay - the value to set
    
    Returns:
    
    the dsl builder
  - delay
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder delay(String delay)
```
    Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 500 Group: scheduler
    
    Parameters:
    
    delay - the value to set
    
    Returns:
    
    the dsl builder
  - greedy
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: scheduler
    
    Parameters:
    
    greedy - the value to set
    
    Returns:
    
    the dsl builder
  - greedy
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: scheduler
    
    Parameters:
    
    greedy - the value to set
    
    Returns:
    
    the dsl builder
  - initialDelay
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder initialDelay(long initialDelay)
```
    Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler
    
    Parameters:
    
    initialDelay - the value to set
    
    Returns:
    
    the dsl builder
  - initialDelay
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder initialDelay(String initialDelay)
```
    Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler
    
    Parameters:
    
    initialDelay - the value to set
    
    Returns:
    
    the dsl builder
  - repeatCount
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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: <code>long</code> type. Default: 0 Group: scheduler
    
    Parameters:
    
    repeatCount - the value to set
    
    Returns:
    
    the dsl builder
  - repeatCount
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 <code>long</code> type. Default: 0 Group: scheduler
    
    Parameters:
    
    repeatCount - the value to set
    
    Returns:
    
    the dsl builder
  - runLoggingLevel
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
    
    Parameters:
    
    runLoggingLevel - the value to set
    
    Returns:
    
    the dsl builder
  - runLoggingLevel
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
    
    Parameters:
    
    runLoggingLevel - the value to set
    
    Returns:
    
    the dsl builder
  - scheduledExecutorService
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
    
    Parameters:
    
    scheduledExecutorService - the value to set
    
    Returns:
    
    the dsl builder
  - scheduledExecutorService
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
    
    Parameters:
    
    scheduledExecutorService - the value to set
    
    Returns:
    
    the dsl builder
  - scheduler
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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: <code>java.lang.Object</code> type. Default: none Group: scheduler
    
    Parameters:
    
    scheduler - the value to set
    
    Returns:
    
    the dsl builder
  - scheduler
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 <code>java.lang.Object</code> type. Default: none Group: scheduler
    
    Parameters:
    
    scheduler - the value to set
    
    Returns:
    
    the dsl builder
  - schedulerProperties
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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: <code>java.util.Map<java.lang.String, java.lang.Object></code> 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
    
    Parameters:
    
    key - the option key
    
    value - the option value
    
    Returns:
    
    the dsl builder
  - schedulerProperties
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder schedulerProperties(Map values)
```
    To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> 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
    
    Parameters:
    
    values - the values
    
    Returns:
    
    the dsl builder
  - startScheduler
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder startScheduler(boolean startScheduler)
```
    Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler
    
    Parameters:
    
    startScheduler - the value to set
    
    Returns:
    
    the dsl builder
  - startScheduler
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder startScheduler(String startScheduler)
```
    Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
    
    Parameters:
    
    startScheduler - the value to set
    
    Returns:
    
    the dsl builder
  - timeUnit
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
```
    Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
    
    Parameters:
    
    timeUnit - the value to set
    
    Returns:
    
    the dsl builder
  - timeUnit
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder timeUnit(String timeUnit)
```
    Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
    
    Parameters:
    
    timeUnit - the value to set
    
    Returns:
    
    the dsl builder
  - useFixedDelay
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
```
    Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler
    
    Parameters:
    
    useFixedDelay - the value to set
    
    Returns:
    
    the dsl builder
  - useFixedDelay
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 <code>boolean</code> type. Default: true Group: scheduler
    
    Parameters:
    
    useFixedDelay - the value to set
    
    Returns:
    
    the dsl builder
  - accessKey
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder 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.S3EndpointConsumerBuilder

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

endpointConfiguration

endpointConfiguration

pathStyleAccess

pathStyleAccess

policy

proxyHost

proxyPort

proxyPort

proxyProtocol

proxyProtocol

region

useIAMCredentials

useIAMCredentials

bridgeErrorHandler

bridgeErrorHandler

deleteAfterRead

deleteAfterRead

delimiter

fileName

includeBody

includeBody

maxConnections

maxConnections

maxMessagesPerPoll

maxMessagesPerPoll

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