Interface MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
,MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
,MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Enclosing interface:
- MongoDbEndpointBuilderFactory
public static interface MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder
extends MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder, MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
Builder for endpoint for the MongoDB component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()
authSource
(String authSource) The database name associated with the user's credentials.collection
(String collection) Sets the name of the MongoDB collection to bind to this endpoint.collectionIndex
(String collectionIndex) Sets the collection index (JSON FORMAT : { field1 : order1, field2 : order2}).createCollection
(boolean createCollection) Create collection during initialisation if it doesn't exist.createCollection
(String createCollection) Create collection during initialisation if it doesn't exist.Sets the name of the MongoDB database to target.Host address of mongodb server in host:port format.mongoConnection
(com.mongodb.client.MongoClient mongoConnection) Sets the connection bean used as a client for connecting to a database.mongoConnection
(String mongoConnection) Sets the connection bean used as a client for connecting to a database.Sets the operation this endpoint will execute against MongoDB.operation
(org.apache.camel.component.mongodb.MongoDbOperation operation) Sets the operation this endpoint will execute against MongoDB.outputType
(String outputType) Convert the output of the producer to the selected type : DocumentList Document or MongoIterable.outputType
(org.apache.camel.component.mongodb.MongoDbOutputType outputType) Convert the output of the producer to the selected type : DocumentList Document or MongoIterable.User password for mongodb connection.Username for mongodb connection.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
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
consumerType, fullDocument, fullDocument, persistentId, persistentTailTracking, persistentTailTracking, streamFilter, tailTrackCollection, tailTrackDb, tailTrackField, tailTrackIncreasingField
-
Method Details
-
advanced
- Specified by:
advanced
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
advanced
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
-
collection
Sets the name of the MongoDB collection to bind to this endpoint. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
collection
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
collection
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
collection
- the value to set- Returns:
- the dsl builder
-
collectionIndex
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder collectionIndex(String collectionIndex) Sets the collection index (JSON FORMAT : { field1 : order1, field2 : order2}). The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
collectionIndex
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
collectionIndex
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
collectionIndex
- the value to set- Returns:
- the dsl builder
-
createCollection
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder createCollection(boolean createCollection) Create collection during initialisation if it doesn't exist. Default is true. The option is a: <code>boolean</code> type. Default: true Group: common- Specified by:
createCollection
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
createCollection
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
createCollection
- the value to set- Returns:
- the dsl builder
-
createCollection
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder createCollection(String createCollection) Create collection during initialisation if it doesn't exist. Default is true. The option will be converted to a <code>boolean</code> type. Default: true Group: common- Specified by:
createCollection
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
createCollection
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
createCollection
- the value to set- Returns:
- the dsl builder
-
database
Sets the name of the MongoDB database to target. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
database
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
database
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
database
- the value to set- Returns:
- the dsl builder
-
hosts
Host address of mongodb server in host:port format. It's possible also use more than one address, as comma separated list of hosts: host1:port1,host2:port2. If the hosts parameter is specified, the provided connectionBean is ignored. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
hosts
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
hosts
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
hosts
- the value to set- Returns:
- the dsl builder
-
mongoConnection
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder mongoConnection(com.mongodb.client.MongoClient mongoConnection) Sets the connection bean used as a client for connecting to a database. The option is a: <code>com.mongodb.client.MongoClient</code> type. Group: common- Specified by:
mongoConnection
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
mongoConnection
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
mongoConnection
- the value to set- Returns:
- the dsl builder
-
mongoConnection
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder mongoConnection(String mongoConnection) Sets the connection bean used as a client for connecting to a database. The option will be converted to a <code>com.mongodb.client.MongoClient</code> type. Group: common- Specified by:
mongoConnection
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
mongoConnection
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
mongoConnection
- the value to set- Returns:
- the dsl builder
-
operation
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder operation(org.apache.camel.component.mongodb.MongoDbOperation operation) Sets the operation this endpoint will execute against MongoDB. The option is a: <code>org.apache.camel.component.mongodb.MongoDbOperation</code> type. Group: common- Specified by:
operation
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
operation
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
operation
Sets the operation this endpoint will execute against MongoDB. The option will be converted to a <code>org.apache.camel.component.mongodb.MongoDbOperation</code> type. Group: common- Specified by:
operation
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
operation
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
outputType
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder outputType(org.apache.camel.component.mongodb.MongoDbOutputType outputType) Convert the output of the producer to the selected type : DocumentList Document or MongoIterable. DocumentList or MongoIterable applies to findAll and aggregate. Document applies to all other operations. The option is a: <code>org.apache.camel.component.mongodb.MongoDbOutputType</code> type. Group: common- Specified by:
outputType
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
outputType
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
outputType
- the value to set- Returns:
- the dsl builder
-
outputType
Convert the output of the producer to the selected type : DocumentList Document or MongoIterable. DocumentList or MongoIterable applies to findAll and aggregate. Document applies to all other operations. The option will be converted to a <code>org.apache.camel.component.mongodb.MongoDbOutputType</code> type. Group: common- Specified by:
outputType
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
outputType
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
outputType
- the value to set- Returns:
- the dsl builder
-
authSource
The database name associated with the user's credentials. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
authSource
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
authSource
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
authSource
- the value to set- Returns:
- the dsl builder
-
password
User password for mongodb connection. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
password
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
password
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
password
- the value to set- Returns:
- the dsl builder
-
username
Username for mongodb connection. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
username
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
- Specified by:
username
in interfaceMongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
- Parameters:
username
- the value to set- Returns:
- the dsl builder
-