StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder (Camel

All Superinterfaces:

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

All Known Subinterfaces:

StreamEndpointBuilderFactory.StreamEndpointBuilder

Enclosing interface:

StreamEndpointBuilderFactory
```
public static interface StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the Stream component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default StreamEndpointBuilderFactory.AdvancedStreamEndpointConsumerBuilder`	`advanced()`
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`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 StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`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 StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`encoding(String encoding)` You can configure the encoding (is a charset name) to use text-based streams (for example, message body is a String object).
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`fileName(String fileName)` When using the stream:file URI format, this option specifies the filename to stream to/from.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`fileWatcher(boolean fileWatcher)` To use JVM file watcher to listen for file change events to support re-loading files that may be overwritten, somewhat like tail --retry.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`fileWatcher(String fileWatcher)` To use JVM file watcher to listen for file change events to support re-loading files that may be overwritten, somewhat like tail --retry.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`groupLines(int groupLines)` To group X number of lines in the consumer.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`groupLines(String groupLines)` To group X number of lines in the consumer.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`groupStrategy(Object groupStrategy)` Allows to use a custom GroupStrategy to control how to group lines.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`groupStrategy(String groupStrategy)` Allows to use a custom GroupStrategy to control how to group lines.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`initialPromptDelay(long initialPromptDelay)` Initial delay in milliseconds before showing the message prompt.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`initialPromptDelay(String initialPromptDelay)` Initial delay in milliseconds before showing the message prompt.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`promptDelay(long promptDelay)` Optional delay in milliseconds before showing the message prompt.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`promptDelay(String promptDelay)` Optional delay in milliseconds before showing the message prompt.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`promptMessage(String promptMessage)` Message prompt to use when reading from stream:in; for example, you could set this to Enter a command:.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`retry(boolean retry)` Will retry opening the stream if it's overwritten, somewhat like tail --retry If reading from files then you should also enable the fileWatcher option, to make it work reliable.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`retry(String retry)` Will retry opening the stream if it's overwritten, somewhat like tail --retry If reading from files then you should also enable the fileWatcher option, to make it work reliable.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`scanStream(boolean scanStream)` To be used for continuously reading a stream such as the unix tail command.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`scanStream(String scanStream)` To be used for continuously reading a stream such as the unix tail command.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`scanStreamDelay(long scanStreamDelay)` Delay in milliseconds between read attempts when using scanStream.
`default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder`	`scanStreamDelay(String scanStreamDelay)` Delay in milliseconds between read attempts when using scanStream.

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 StreamEndpointBuilderFactory.AdvancedStreamEndpointConsumerBuilder advanced()
```
  - encoding
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder encoding(String encoding)
```
    You can configure the encoding (is a charset name) to use text-based streams (for example, message body is a String object). If not provided, Camel uses the JVM default Charset. The option is a: java.lang.String type. Group: common
  - fileName
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder fileName(String fileName)
```
    When using the stream:file URI format, this option specifies the filename to stream to/from. The option is a: java.lang.String type. Group: common
  - bridgeErrorHandler
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder 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 StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder 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
  - fileWatcher
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder fileWatcher(boolean fileWatcher)
```
    To use JVM file watcher to listen for file change events to support re-loading files that may be overwritten, somewhat like tail --retry. The option is a: boolean type. Default: false Group: consumer
  - fileWatcher
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder fileWatcher(String fileWatcher)
```
    To use JVM file watcher to listen for file change events to support re-loading files that may be overwritten, somewhat like tail --retry. The option will be converted to a boolean type. Default: false Group: consumer
  - groupLines
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder groupLines(int groupLines)
```
    To group X number of lines in the consumer. For example to group 10 lines and therefore only spit out an Exchange with 10 lines, instead of 1 Exchange per line. The option is a: int type. Group: consumer
  - groupLines
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder groupLines(String groupLines)
```
    To group X number of lines in the consumer. For example to group 10 lines and therefore only spit out an Exchange with 10 lines, instead of 1 Exchange per line. The option will be converted to a int type. Group: consumer
  - groupStrategy
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder groupStrategy(Object groupStrategy)
```
    Allows to use a custom GroupStrategy to control how to group lines. The option is a: org.apache.camel.component.stream.GroupStrategy type. Group: consumer
  - groupStrategy
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder groupStrategy(String groupStrategy)
```
    Allows to use a custom GroupStrategy to control how to group lines. The option will be converted to a org.apache.camel.component.stream.GroupStrategy type. Group: consumer
  - initialPromptDelay
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder initialPromptDelay(long initialPromptDelay)
```
    Initial delay in milliseconds before showing the message prompt. This delay occurs only once. Can be used during system startup to avoid message prompts being written while other logging is done to the system out. The option is a: long type. Default: 2000 Group: consumer
  - initialPromptDelay
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder initialPromptDelay(String initialPromptDelay)
```
    Initial delay in milliseconds before showing the message prompt. This delay occurs only once. Can be used during system startup to avoid message prompts being written while other logging is done to the system out. The option will be converted to a long type. Default: 2000 Group: consumer
  - promptDelay
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder promptDelay(long promptDelay)
```
    Optional delay in milliseconds before showing the message prompt. The option is a: long type. Group: consumer
  - promptDelay
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder promptDelay(String promptDelay)
```
    Optional delay in milliseconds before showing the message prompt. The option will be converted to a long type. Group: consumer
  - promptMessage
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder promptMessage(String promptMessage)
```
    Message prompt to use when reading from stream:in; for example, you could set this to Enter a command:. The option is a: java.lang.String type. Group: consumer
  - retry
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder retry(boolean retry)
```
    Will retry opening the stream if it's overwritten, somewhat like tail --retry If reading from files then you should also enable the fileWatcher option, to make it work reliable. The option is a: boolean type. Default: false Group: consumer
  - retry
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder retry(String retry)
```
    Will retry opening the stream if it's overwritten, somewhat like tail --retry If reading from files then you should also enable the fileWatcher option, to make it work reliable. The option will be converted to a boolean type. Default: false Group: consumer
  - scanStream
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder scanStream(boolean scanStream)
```
    To be used for continuously reading a stream such as the unix tail command. The option is a: boolean type. Default: false Group: consumer
  - scanStream
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder scanStream(String scanStream)
```
    To be used for continuously reading a stream such as the unix tail command. The option will be converted to a boolean type. Default: false Group: consumer
  - scanStreamDelay
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder scanStreamDelay(long scanStreamDelay)
```
    Delay in milliseconds between read attempts when using scanStream. The option is a: long type. Group: consumer
  - scanStreamDelay
```
default StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder scanStreamDelay(String scanStreamDelay)
```
    Delay in milliseconds between read attempts when using scanStream. The option will be converted to a long type. Group: consumer

Interface StreamEndpointBuilderFactory.StreamEndpointConsumerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

encoding

fileName

bridgeErrorHandler

bridgeErrorHandler

fileWatcher

fileWatcher

groupLines

groupLines

groupStrategy

groupStrategy

initialPromptDelay

initialPromptDelay

promptDelay

promptDelay

promptMessage

retry

retry

scanStream

scanStream

scanStreamDelay

scanStreamDelay