Interface CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
CouchDbEndpointBuilderFactory.CouchDbEndpointBuilder
- Enclosing interface:
- CouchDbEndpointBuilderFactory
public static interface CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the CouchDB component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default CouchDbEndpointBuilderFactory.AdvancedCouchDbEndpointConsumerBuilder
advanced()
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
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 CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
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 CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
createDatabase(boolean createDatabase)
Creates the database if it does not already exist.default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
createDatabase(String createDatabase)
Creates the database if it does not already exist.default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
deletes(boolean deletes)
Document deletes are published as events.default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
deletes(String deletes)
Document deletes are published as events.default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
heartbeat(long heartbeat)
How often to send an empty message to keep socket alive in millis.default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
heartbeat(String heartbeat)
How often to send an empty message to keep socket alive in millis.default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
password(String password)
Password for authenticated databases.default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
resumeStrategy(String resumeStrategy)
Sets a custom resume strategy for tracking changes from CouchDB.default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
resumeStrategy(org.apache.camel.component.couchdb.consumer.CouchDbResumeStrategy resumeStrategy)
Sets a custom resume strategy for tracking changes from CouchDB.default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
style(String style)
Specifies how many revisions are returned in the changes array.default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
updates(boolean updates)
Document inserts/updates are published as events.default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
updates(String updates)
Document inserts/updates are published as events.default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder
username(String username)
Username in case of authenticated databases.
-
-
-
Method Detail
-
advanced
default CouchDbEndpointBuilderFactory.AdvancedCouchDbEndpointConsumerBuilder advanced()
-
createDatabase
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder createDatabase(boolean createDatabase)
Creates the database if it does not already exist. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
createDatabase
- the value to set- Returns:
- the dsl builder
-
createDatabase
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder createDatabase(String createDatabase)
Creates the database if it does not already exist. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
createDatabase
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder 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 CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder 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
-
deletes
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder deletes(boolean deletes)
Document deletes are published as events. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
deletes
- the value to set- Returns:
- the dsl builder
-
deletes
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder deletes(String deletes)
Document deletes are published as events. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
deletes
- the value to set- Returns:
- the dsl builder
-
heartbeat
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder heartbeat(long heartbeat)
How often to send an empty message to keep socket alive in millis. The option is a: <code>long</code> type. Default: 30000 Group: consumer- Parameters:
heartbeat
- the value to set- Returns:
- the dsl builder
-
heartbeat
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder heartbeat(String heartbeat)
How often to send an empty message to keep socket alive in millis. The option will be converted to a <code>long</code> type. Default: 30000 Group: consumer- Parameters:
heartbeat
- the value to set- Returns:
- the dsl builder
-
resumeStrategy
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder resumeStrategy(org.apache.camel.component.couchdb.consumer.CouchDbResumeStrategy resumeStrategy)
Sets a custom resume strategy for tracking changes from CouchDB. It allows tracking from a specific point (i.e.: since the given update sequence, the latest sequence, etc). The option is a: <code>org.apache.camel.component.couchdb.consumer.CouchDbResumeStrategy</code> type. Group: consumer- Parameters:
resumeStrategy
- the value to set- Returns:
- the dsl builder
-
resumeStrategy
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder resumeStrategy(String resumeStrategy)
Sets a custom resume strategy for tracking changes from CouchDB. It allows tracking from a specific point (i.e.: since the given update sequence, the latest sequence, etc). The option will be converted to a <code>org.apache.camel.component.couchdb.consumer.CouchDbResumeStrategy</code> type. Group: consumer- Parameters:
resumeStrategy
- the value to set- Returns:
- the dsl builder
-
style
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder style(String style)
Specifies how many revisions are returned in the changes array. The default, main_only, will only return the current winning revision; all_docs will return all leaf revisions (including conflicts and deleted former conflicts.). The option is a: <code>java.lang.String</code> type. Default: main_only Group: consumer- Parameters:
style
- the value to set- Returns:
- the dsl builder
-
updates
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder updates(boolean updates)
Document inserts/updates are published as events. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
updates
- the value to set- Returns:
- the dsl builder
-
updates
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder updates(String updates)
Document inserts/updates are published as events. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
updates
- the value to set- Returns:
- the dsl builder
-
password
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder password(String password)
Password for authenticated databases. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
password
- the value to set- Returns:
- the dsl builder
-
username
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder username(String username)
Username in case of authenticated databases. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
username
- the value to set- Returns:
- the dsl builder
-
-