org.apache.camel.builder.endpoint.dsl

Interface S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder

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

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	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: <code>com.amazonaws.services.s3.model.EncryptionMaterials</code> type. Group: common (advanced)

Parameters:

encryptionMaterials - the value to set

Returns:

the dsl builder

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 <code>com.amazonaws.services.s3.model.EncryptionMaterials</code> type. Group: common (advanced)

Parameters:

encryptionMaterials - the value to set

Returns:

the dsl builder

useEncryption

default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder useEncryption(boolean useEncryption)

Define if encryption must be used or not. The option is a: <code>boolean</code> type. Default: false Group: common (advanced)

Parameters:

useEncryption - the value to set

Returns:

the dsl builder

useEncryption

default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder useEncryption(String useEncryption)

Define if encryption must be used or not. The option will be converted to a <code>boolean</code> type. Default: false Group: common (advanced)

Parameters:

useEncryption - the value to set

Returns:

the dsl builder

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: <code>boolean</code> type. Default: true Group: consumer (advanced)

Parameters:

autocloseBody - the value to set

Returns:

the dsl builder

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 <code>boolean</code> type. Default: true Group: consumer (advanced)

Parameters:

autocloseBody - the value to set

Returns:

the dsl builder

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: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

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 <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exchangePattern

default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

exchangePattern

default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder exchangePattern(String exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

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: <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)

Parameters:

pollStrategy - the value to set

Returns:

the dsl builder

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 <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)

Parameters:

pollStrategy - the value to set

Returns:

the dsl builder

accelerateModeEnabled

default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder accelerateModeEnabled(boolean accelerateModeEnabled)

Define if Accelerate Mode enabled is true or false. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

accelerateModeEnabled - the value to set

Returns:

the dsl builder

accelerateModeEnabled

default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder accelerateModeEnabled(String accelerateModeEnabled)

Define if Accelerate Mode enabled is true or false. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

accelerateModeEnabled - the value to set

Returns:

the dsl builder

chunkedEncodingDisabled

default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder chunkedEncodingDisabled(boolean chunkedEncodingDisabled)

Define if disabled Chunked Encoding is true or false. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

chunkedEncodingDisabled - the value to set

Returns:

the dsl builder

chunkedEncodingDisabled

default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder chunkedEncodingDisabled(String chunkedEncodingDisabled)

Define if disabled Chunked Encoding is true or false. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

chunkedEncodingDisabled - the value to set

Returns:

the dsl builder

dualstackEnabled

default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder dualstackEnabled(boolean dualstackEnabled)

Define if Dualstack enabled is true or false. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

dualstackEnabled - the value to set

Returns:

the dsl builder

dualstackEnabled

default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder dualstackEnabled(String dualstackEnabled)

Define if Dualstack enabled is true or false. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

dualstackEnabled - the value to set

Returns:

the dsl builder

forceGlobalBucketAccessEnabled

default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder forceGlobalBucketAccessEnabled(boolean forceGlobalBucketAccessEnabled)

Define if Force Global Bucket Access enabled is true or false. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

forceGlobalBucketAccessEnabled - the value to set

Returns:

the dsl builder

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 <code>boolean</code> type. Default: false Group: advanced

Parameters:

forceGlobalBucketAccessEnabled - the value to set

Returns:

the dsl builder

payloadSigningEnabled

default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder payloadSigningEnabled(boolean payloadSigningEnabled)

Define if Payload Signing enabled is true or false. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

payloadSigningEnabled - the value to set

Returns:

the dsl builder

payloadSigningEnabled

default S3EndpointBuilderFactory.AdvancedS3EndpointConsumerBuilder payloadSigningEnabled(String payloadSigningEnabled)

Define if Payload Signing enabled is true or false. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

payloadSigningEnabled - the value to set

Returns:

the dsl builder

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: <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder

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 <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder