S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder (Camel

All Superinterfaces:

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

All Known Subinterfaces:

S3EndpointBuilderFactory.AdvancedS3EndpointBuilder

Enclosing interface:

S3EndpointBuilderFactory
```
public static interface S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Advanced 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.AdvancedS3EndpointConsumerBuilder`	`accelerateModeEnabled(boolean accelerateModeEnabled)` Define if Accelerate Mode enabled is true or false.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`accelerateModeEnabled(String accelerateModeEnabled)` Define if Accelerate Mode enabled is true or false.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`autocloseBody(boolean autocloseBody)` If this option is true and includeBody is true, then the S3Object.close() method will be called on exchange completion.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`autocloseBody(String autocloseBody)` If this option is true and includeBody is true, then the S3Object.close() method will be called on exchange completion.
`default S3EndpointBuilderFactory.S3EndpointConsumerBuilder`	`basic()`
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`basicPropertyBinding(String basicPropertyBinding)` Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`chunkedEncodingDisabled(boolean chunkedEncodingDisabled)` Define if disabled Chunked Encoding is true or false.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`chunkedEncodingDisabled(String chunkedEncodingDisabled)` Define if disabled Chunked Encoding is true or false.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`dualstackEnabled(boolean dualstackEnabled)` Define if Dualstack enabled is true or false.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`dualstackEnabled(String dualstackEnabled)` Define if Dualstack enabled is true or false.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`encryptionMaterials(Object encryptionMaterials)` The encryption materials to use in case of Symmetric/Asymmetric client usage.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`encryptionMaterials(String encryptionMaterials)` The encryption materials to use in case of Symmetric/Asymmetric client usage.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)` To let the consumer use a custom ExceptionHandler.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`exceptionHandler(String exceptionHandler)` To let the consumer use a custom ExceptionHandler.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`exchangePattern(org.apache.camel.ExchangePattern exchangePattern)` Sets the exchange pattern when the consumer creates an exchange.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`exchangePattern(String exchangePattern)` Sets the exchange pattern when the consumer creates an exchange.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`forceGlobalBucketAccessEnabled(boolean forceGlobalBucketAccessEnabled)` Define if Force Global Bucket Access enabled is true or false.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`forceGlobalBucketAccessEnabled(String forceGlobalBucketAccessEnabled)` Define if Force Global Bucket Access enabled is true or false.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`payloadSigningEnabled(boolean payloadSigningEnabled)` Define if Payload Signing enabled is true or false.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`payloadSigningEnabled(String payloadSigningEnabled)` Define if Payload Signing enabled is true or false.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`pollStrategy(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy)` A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`pollStrategy(String pollStrategy)` A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`synchronous(boolean synchronous)` Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`synchronous(String synchronous)` Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`useEncryption(boolean useEncryption)` Define if encryption must be used or not.
`default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder`	`useEncryption(String useEncryption)` Define if encryption must be used or not.

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
  - basic
```
default S3EndpointBuilderFactory.S3EndpointConsumerBuilder basic()
```
  - encryptionMaterials
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder encryptionMaterials(Object encryptionMaterials)
```
    The encryption materials to use in case of Symmetric/Asymmetric client usage. The option is a: com.amazonaws.services.s3.model.EncryptionMaterials type. Group: common (advanced)
  - encryptionMaterials
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder encryptionMaterials(String encryptionMaterials)
```
    The encryption materials to use in case of Symmetric/Asymmetric client usage. The option will be converted to a com.amazonaws.services.s3.model.EncryptionMaterials type. Group: common (advanced)
  - useEncryption
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder useEncryption(boolean useEncryption)
```
    Define if encryption must be used or not. The option is a: boolean type. Default: false Group: common (advanced)
  - useEncryption
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder useEncryption(String useEncryption)
```
    Define if encryption must be used or not. The option will be converted to a boolean type. Default: false Group: common (advanced)
  - autocloseBody
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder autocloseBody(boolean autocloseBody)
```
    If this option is true and includeBody is true, then the S3Object.close() method will be called on exchange completion. This option is strongly related to includeBody 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: boolean type. Default: true Group: consumer (advanced)
  - autocloseBody
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder autocloseBody(String autocloseBody)
```
    If this option is true and includeBody is true, then the S3Object.close() method will be called on exchange completion. This option is strongly related to includeBody 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 boolean type. Default: true Group: consumer (advanced)
  - exceptionHandler
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)
```
    To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
  - exceptionHandler
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder exceptionHandler(String exceptionHandler)
```
    To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
  - exchangePattern
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
```
    Sets the exchange pattern when the consumer creates an exchange. The option is a: org.apache.camel.ExchangePattern type. Group: consumer (advanced)
  - exchangePattern
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder exchangePattern(String exchangePattern)
```
    Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a org.apache.camel.ExchangePattern type. Group: consumer (advanced)
  - pollStrategy
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder pollStrategy(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy)
```
    A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option is a: org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
  - pollStrategy
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder pollStrategy(String pollStrategy)
```
    A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option will be converted to a org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
  - accelerateModeEnabled
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder accelerateModeEnabled(boolean accelerateModeEnabled)
```
    Define if Accelerate Mode enabled is true or false. The option is a: boolean type. Default: false Group: advanced
  - accelerateModeEnabled
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder accelerateModeEnabled(String accelerateModeEnabled)
```
    Define if Accelerate Mode enabled is true or false. The option will be converted to a boolean type. Default: false Group: advanced
  - chunkedEncodingDisabled
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder chunkedEncodingDisabled(boolean chunkedEncodingDisabled)
```
    Define if disabled Chunked Encoding is true or false. The option is a: boolean type. Default: false Group: advanced
  - chunkedEncodingDisabled
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder chunkedEncodingDisabled(String chunkedEncodingDisabled)
```
    Define if disabled Chunked Encoding is true or false. The option will be converted to a boolean type. Default: false Group: advanced
  - dualstackEnabled
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder dualstackEnabled(boolean dualstackEnabled)
```
    Define if Dualstack enabled is true or false. The option is a: boolean type. Default: false Group: advanced
  - dualstackEnabled
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder dualstackEnabled(String dualstackEnabled)
```
    Define if Dualstack enabled is true or false. The option will be converted to a boolean type. Default: false Group: advanced
  - forceGlobalBucketAccessEnabled
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder forceGlobalBucketAccessEnabled(boolean forceGlobalBucketAccessEnabled)
```
    Define if Force Global Bucket Access enabled is true or false. The option is a: boolean type. Default: false Group: advanced
  - forceGlobalBucketAccessEnabled
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder forceGlobalBucketAccessEnabled(String forceGlobalBucketAccessEnabled)
```
    Define if Force Global Bucket Access enabled is true or false. The option will be converted to a boolean type. Default: false Group: advanced
  - payloadSigningEnabled
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder payloadSigningEnabled(boolean payloadSigningEnabled)
```
    Define if Payload Signing enabled is true or false. The option is a: boolean type. Default: false Group: advanced
  - payloadSigningEnabled
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder payloadSigningEnabled(String payloadSigningEnabled)
```
    Define if Payload Signing enabled is true or false. The option will be converted to a boolean type. Default: false Group: advanced
  - basicPropertyBinding
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - basicPropertyBinding
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder basicPropertyBinding(String basicPropertyBinding)
```
    Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option will be converted to a boolean type. Default: false Group: advanced
  - synchronous
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder synchronous(boolean synchronous)
```
    Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option is a: boolean type. Default: false Group: advanced
  - synchronous
```
default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder synchronous(String synchronous)
```
    Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option will be converted to a boolean type. Default: false Group: advanced

Interface S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

basic

encryptionMaterials

encryptionMaterials

useEncryption

useEncryption

autocloseBody

autocloseBody

exceptionHandler

exceptionHandler

exchangePattern

exchangePattern

pollStrategy

pollStrategy

accelerateModeEnabled

accelerateModeEnabled

chunkedEncodingDisabled

chunkedEncodingDisabled

dualstackEnabled

dualstackEnabled

forceGlobalBucketAccessEnabled

forceGlobalBucketAccessEnabled

payloadSigningEnabled

payloadSigningEnabled

basicPropertyBinding

basicPropertyBinding

synchronous

synchronous