Package org.apache.camel.builder.endpoint.dsl

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

Modifier and Type	Method	Description
default CouchDbEndpointBuilderFactory.AdvancedCouchDbEndpointConsumerBuilder	advanced()
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	maxMessagesPerPoll(int maxMessagesPerPoll)	Gets the maximum number of messages as a limit to poll at each polling.
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder	maxMessagesPerPoll(String maxMessagesPerPoll)	Gets the maximum number of messages as a limit to poll at each polling.
default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder	password(String password)	Password for authenticated databases.
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.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Details

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: boolean 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 boolean type. Default: false Group: common

Parameters:

createDatabase - 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: boolean 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 boolean 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: long 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 long type. Default: 30000 Group: consumer

Parameters:

heartbeat - the value to set

Returns:

the dsl builder

maxMessagesPerPoll

default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder 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: int type. Default: 10 Group: consumer

Parameters:

maxMessagesPerPoll - the value to set

Returns:

the dsl builder

maxMessagesPerPoll

default CouchDbEndpointBuilderFactory.CouchDbEndpointConsumerBuilder 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 int type. Default: 10 Group: consumer

Parameters:

maxMessagesPerPoll - 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: java.lang.String 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: boolean 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 boolean 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: java.lang.String 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: java.lang.String type. Group: security

Parameters:

username - the value to set

Returns:

the dsl builder