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

Interface ArangoDbEndpointBuilderFactory.ArangoDbEndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    Enclosing interface:
    ArangoDbEndpointBuilderFactory
    public static interface ArangoDbEndpointBuilderFactory.ArangoDbEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint for the ArangoDb component.

    • Method Detail

      • documentCollection

        default ArangoDbEndpointBuilderFactory.ArangoDbEndpointBuilder documentCollection​(String documentCollection)
        Collection name, when using ArangoDb as a Document Database. Set the documentCollection name when using the CRUD operation on the document database collections (SAVE_DOCUMENT , FIND_DOCUMENT_BY_KEY, UPDATE_DOCUMENT, DELETE_DOCUMENT). The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        documentCollection - the value to set
        Returns:
        the dsl builder

      • edgeCollection

        default ArangoDbEndpointBuilderFactory.ArangoDbEndpointBuilder edgeCollection​(String edgeCollection)
        Collection name of vertices, when using ArangoDb as a Graph Database. Set the edgeCollection name to perform CRUD operation on edges using these operations : SAVE_VERTEX, FIND_VERTEX_BY_KEY, UPDATE_VERTEX, DELETE_VERTEX. The graph attribute is mandatory. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        edgeCollection - the value to set
        Returns:
        the dsl builder

      • graph

        default ArangoDbEndpointBuilderFactory.ArangoDbEndpointBuilder graph​(String graph)
        Graph name, when using ArangoDb as a Graph Database. Combine this attribute with one of the two attributes vertexCollection and edgeCollection. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        graph - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default ArangoDbEndpointBuilderFactory.ArangoDbEndpointBuilder 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 ArangoDbEndpointBuilderFactory.ArangoDbEndpointBuilder 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

      • operation

        default ArangoDbEndpointBuilderFactory.ArangoDbEndpointBuilder operation​(String operation)
        Operations to perform on ArangoDb. For the operation AQL_QUERY, no need to specify a collection or graph. The option will be converted to a <code>org.apache.camel.component.arangodb.ArangoDbOperation</code> type. Group: producer
        Parameters:
        operation - the value to set
        Returns:
        the dsl builder

      • port

        default ArangoDbEndpointBuilderFactory.ArangoDbEndpointBuilder port​(int port)
        ArangoDB exposed port. If host and port are default, this field is Optional. The option is a: <code>int</code> type. Group: producer
        Parameters:
        port - the value to set
        Returns:
        the dsl builder

      • port

        default ArangoDbEndpointBuilderFactory.ArangoDbEndpointBuilder port​(String port)
        ArangoDB exposed port. If host and port are default, this field is Optional. The option will be converted to a <code>int</code> type. Group: producer
        Parameters:
        port - the value to set
        Returns:
        the dsl builder

      • vertexCollection

        default ArangoDbEndpointBuilderFactory.ArangoDbEndpointBuilder vertexCollection​(String vertexCollection)
        Collection name of vertices, when using ArangoDb as a Graph Database. Set the vertexCollection name to perform CRUD operation on vertices using these operations : SAVE_EDGE, FIND_EDGE_BY_KEY, UPDATE_EDGE, DELETE_EDGE. The graph attribute is mandatory. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        vertexCollection - the value to set
        Returns:
        the dsl builder

      • password

        default ArangoDbEndpointBuilderFactory.ArangoDbEndpointBuilder password​(String password)
        ArangoDB password. If user and password are default, this field is Optional. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        password - the value to set
        Returns:
        the dsl builder