Interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder
- Enclosing interface:
- MongoDbEndpointBuilderFactory
public static interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the MongoDB component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder
advanced()
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
authSource(String authSource)
The database name associated with the user's credentials.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
collection(String collection)
Sets the name of the MongoDB collection to bind to this endpoint.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
collectionIndex(String collectionIndex)
Sets the collection index (JSON FORMAT : { field1 : order1, field2 : order2}).default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
consumerType(String consumerType)
Consumer type.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
createCollection(boolean createCollection)
Create collection during initialisation if it doesn't exist.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
createCollection(String createCollection)
Create collection during initialisation if it doesn't exist.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
database(String database)
Sets the name of the MongoDB database to target.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
fullDocument(String fullDocument)
Specifies whether changeStream consumer include a copy of the full document when modified by update operations.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
hosts(String hosts)
Host address of mongodb server in host:port format.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
mongoConnection(com.mongodb.client.MongoClient mongoConnection)
Sets the connection bean used as a client for connecting to a database.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
mongoConnection(String mongoConnection)
Sets the connection bean used as a client for connecting to a database.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
operation(String operation)
Sets the operation this endpoint will execute against MongoDB.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
operation(org.apache.camel.component.mongodb.MongoDbOperation operation)
Sets the operation this endpoint will execute against MongoDB.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
outputType(String outputType)
Convert the output of the producer to the selected type : DocumentList Document or MongoIterable.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
outputType(org.apache.camel.component.mongodb.MongoDbOutputType outputType)
Convert the output of the producer to the selected type : DocumentList Document or MongoIterable.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
password(String password)
User password for mongodb connection.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
persistentId(String persistentId)
One tail tracking collection can host many trackers for several tailable consumers.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
persistentTailTracking(boolean persistentTailTracking)
Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
persistentTailTracking(String persistentTailTracking)
Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
streamFilter(String streamFilter)
Filter condition for change streams consumer.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
tailTrackCollection(String tailTrackCollection)
Collection where tail tracking information will be persisted.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
tailTrackDb(String tailTrackDb)
Indicates what database the tail tracking mechanism will persist to.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
tailTrackField(String tailTrackField)
Field where the last tracked value will be placed.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
tailTrackIncreasingField(String tailTrackIncreasingField)
Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated.default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder
username(String username)
Username for mongodb connection.
-
-
-
Method Detail
-
advanced
default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder advanced()
-
collection
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder collection(String 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- Parameters:
collection
- the value to set- Returns:
- the dsl builder
-
collectionIndex
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder 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- Parameters:
collectionIndex
- the value to set- Returns:
- the dsl builder
-
createCollection
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder 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- Parameters:
createCollection
- the value to set- Returns:
- the dsl builder
-
createCollection
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder 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- Parameters:
createCollection
- the value to set- Returns:
- the dsl builder
-
database
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder database(String database)
Sets the name of the MongoDB database to target. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
database
- the value to set- Returns:
- the dsl builder
-
hosts
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder hosts(String 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- Parameters:
hosts
- the value to set- Returns:
- the dsl builder
-
mongoConnection
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder 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- Parameters:
mongoConnection
- the value to set- Returns:
- the dsl builder
-
mongoConnection
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder 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- Parameters:
mongoConnection
- the value to set- Returns:
- the dsl builder
-
operation
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder 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- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
operation
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder operation(String 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- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
outputType
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder 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- Parameters:
outputType
- the value to set- Returns:
- the dsl builder
-
outputType
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder outputType(String 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- Parameters:
outputType
- the value to set- Returns:
- the dsl builder
-
consumerType
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder consumerType(String consumerType)
Consumer type. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
consumerType
- the value to set- Returns:
- the dsl builder
-
fullDocument
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder fullDocument(String fullDocument)
Specifies whether changeStream consumer include a copy of the full document when modified by update operations. Possible values are default and updateLookup. The option is a: <code>java.lang.String</code> type. Default: default Group: changeStream- Parameters:
fullDocument
- the value to set- Returns:
- the dsl builder
-
streamFilter
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder streamFilter(String streamFilter)
Filter condition for change streams consumer. The option is a: <code>java.lang.String</code> type. Group: changeStream- Parameters:
streamFilter
- the value to set- Returns:
- the dsl builder
-
authSource
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder authSource(String authSource)
The database name associated with the user's credentials. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
authSource
- the value to set- Returns:
- the dsl builder
-
password
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder password(String password)
User password for mongodb connection. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
password
- the value to set- Returns:
- the dsl builder
-
username
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder username(String username)
Username for mongodb connection. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
username
- the value to set- Returns:
- the dsl builder
-
persistentId
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder persistentId(String persistentId)
One tail tracking collection can host many trackers for several tailable consumers. To keep them separate, each tracker should have its own unique persistentId. The option is a: <code>java.lang.String</code> type. Group: tail- Parameters:
persistentId
- the value to set- Returns:
- the dsl builder
-
persistentTailTracking
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder persistentTailTracking(boolean persistentTailTracking)
Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up, the endpoint will recover the cursor from the point where it last stopped slurping records. The option is a: <code>boolean</code> type. Default: false Group: tail- Parameters:
persistentTailTracking
- the value to set- Returns:
- the dsl builder
-
persistentTailTracking
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder persistentTailTracking(String persistentTailTracking)
Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up, the endpoint will recover the cursor from the point where it last stopped slurping records. The option will be converted to a <code>boolean</code> type. Default: false Group: tail- Parameters:
persistentTailTracking
- the value to set- Returns:
- the dsl builder
-
tailTrackCollection
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder tailTrackCollection(String tailTrackCollection)
Collection where tail tracking information will be persisted. If not specified, MongoDbTailTrackingConfig#DEFAULT_COLLECTION will be used by default. The option is a: <code>java.lang.String</code> type. Group: tail- Parameters:
tailTrackCollection
- the value to set- Returns:
- the dsl builder
-
tailTrackDb
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder tailTrackDb(String tailTrackDb)
Indicates what database the tail tracking mechanism will persist to. If not specified, the current database will be picked by default. Dynamicity will not be taken into account even if enabled, i.e. the tail tracking database will not vary past endpoint initialisation. The option is a: <code>java.lang.String</code> type. Group: tail- Parameters:
tailTrackDb
- the value to set- Returns:
- the dsl builder
-
tailTrackField
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder tailTrackField(String tailTrackField)
Field where the last tracked value will be placed. If not specified, MongoDbTailTrackingConfig#DEFAULT_FIELD will be used by default. The option is a: <code>java.lang.String</code> type. Group: tail- Parameters:
tailTrackField
- the value to set- Returns:
- the dsl builder
-
tailTrackIncreasingField
default MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder tailTrackIncreasingField(String tailTrackIncreasingField)
Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField greater than lastValue (possibly recovered from persistent tail tracking). Can be of type Integer, Date, String, etc. NOTE: No support for dot notation at the current time, so the field should be at the top level of the document. The option is a: <code>java.lang.String</code> type. Group: tail- Parameters:
tailTrackIncreasingField
- the value to set- Returns:
- the dsl builder
-
-