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

Interface ControlBusEndpointBuilderFactory.ControlBusEndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    Enclosing interface:
    ControlBusEndpointBuilderFactory
    public static interface ControlBusEndpointBuilderFactory.ControlBusEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint for the Control Bus component.

    • Method Detail

      • action

        default ControlBusEndpointBuilderFactory.ControlBusEndpointBuilder action​(String action)
        To denote an action that can be either: start, stop, or status. To either start or stop a route, or to get the status of the route as output in the message body. You can use suspend and resume to either suspend or resume a route. You can use stats to get performance statics returned in XML format; the routeId option can be used to define which route to get the performance stats for, if routeId is not defined, then you get statistics for the entire CamelContext. The restart action will restart the route. And the fail action will stop and mark the route as failed (stopped due to an exception). The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        action - the value to set
        Returns:
        the dsl builder

      • async

        default ControlBusEndpointBuilderFactory.ControlBusEndpointBuilder async​(boolean async)
        Whether to execute the control bus task asynchronously. Important: If this option is enabled, then any result from the task is not set on the Exchange. This is only possible if executing tasks synchronously. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        async - the value to set
        Returns:
        the dsl builder

      • async

        default ControlBusEndpointBuilderFactory.ControlBusEndpointBuilder async​(String async)
        Whether to execute the control bus task asynchronously. Important: If this option is enabled, then any result from the task is not set on the Exchange. This is only possible if executing tasks synchronously. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        async - the value to set
        Returns:
        the dsl builder

      • loggingLevel

        default ControlBusEndpointBuilderFactory.ControlBusEndpointBuilder loggingLevel​(org.apache.camel.LoggingLevel loggingLevel)
        Logging level used for logging when task is done, or if any exceptions occurred during processing the task. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: INFO Group: producer
        Parameters:
        loggingLevel - the value to set
        Returns:
        the dsl builder

      • loggingLevel

        default ControlBusEndpointBuilderFactory.ControlBusEndpointBuilder loggingLevel​(String loggingLevel)
        Logging level used for logging when task is done, or if any exceptions occurred during processing the task. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: INFO Group: producer
        Parameters:
        loggingLevel - the value to set
        Returns:
        the dsl builder

      • restartDelay

        default ControlBusEndpointBuilderFactory.ControlBusEndpointBuilder restartDelay​(int restartDelay)
        The delay in millis to use when restarting a route. The option is a: <code>int</code> type. Default: 1000 Group: producer
        Parameters:
        restartDelay - the value to set
        Returns:
        the dsl builder

      • restartDelay

        default ControlBusEndpointBuilderFactory.ControlBusEndpointBuilder restartDelay​(String restartDelay)
        The delay in millis to use when restarting a route. The option will be converted to a <code>int</code> type. Default: 1000 Group: producer
        Parameters:
        restartDelay - the value to set
        Returns:
        the dsl builder

      • routeId

        default ControlBusEndpointBuilderFactory.ControlBusEndpointBuilder routeId​(String routeId)
        To specify a route by its id. The special keyword current indicates the current route. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        routeId - the value to set
        Returns:
        the dsl builder