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

Interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder
    Enclosing interface:
    MongoDbEndpointBuilderFactory
    public static interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the MongoDB component.

    • Method Detail

      • collectionIndex

        default MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder 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.MongoDbEndpointProducerBuilder 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.MongoDbEndpointProducerBuilder 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

      • hosts

        default MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder 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 hosts parameter is specified, 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.MongoDbEndpointProducerBuilder mongoConnection​(Object 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.MongoDbEndpointProducerBuilder 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.MongoDbEndpointProducerBuilder 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.MongoDbEndpointProducerBuilder 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

      • lazyStartProducer

        default MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder lazyStartProducer​(boolean lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder lazyStartProducer​(String lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder