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

Interface MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    Enclosing interface:
    MiloBrowseEndpointBuilderFactory
    public static interface MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint for the OPC UA Browser component.

    • Method Detail

      • depth

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder depth​(int depth)
        When browsing recursively into sub-types, what's the maximum search depth for diving into the tree. Default value notice: Maximum depth for browsing recursively (only if recursive = true). The option is a: <code>int</code> type. Default: 3 Group: producer
        Parameters:
        depth - the value to set
        Returns:
        the dsl builder

      • depth

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder depth​(String depth)
        When browsing recursively into sub-types, what's the maximum search depth for diving into the tree. Default value notice: Maximum depth for browsing recursively (only if recursive = true). The option will be converted to a <code>int</code> type. Default: 3 Group: producer
        Parameters:
        depth - the value to set
        Returns:
        the dsl builder

      • direction

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder direction​(org.eclipse.milo.opcua.stack.core.types.enumerated.BrowseDirection direction)
        The direction to browse (forward, inverse, ...). Default value notice: The direction to browse; see org.eclipse.milo.opcua.stack.core.types.enumerated.BrowseDirection. The option is a: <code>org.eclipse.milo.opcua.stack.core.types.enumerated.BrowseDirection</code> type. Default: Forward Group: producer
        Parameters:
        direction - the value to set
        Returns:
        the dsl builder

      • direction

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder direction​(String direction)
        The direction to browse (forward, inverse, ...). Default value notice: The direction to browse; see org.eclipse.milo.opcua.stack.core.types.enumerated.BrowseDirection. The option will be converted to a <code>org.eclipse.milo.opcua.stack.core.types.enumerated.BrowseDirection</code> type. Default: Forward Group: producer
        Parameters:
        direction - the value to set
        Returns:
        the dsl builder

      • discoveryEndpointSuffix

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder discoveryEndpointSuffix​(String discoveryEndpointSuffix)
        A suffix for endpoint URI when discovering. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        discoveryEndpointSuffix - the value to set
        Returns:
        the dsl builder

      • discoveryEndpointUri

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder discoveryEndpointUri​(String discoveryEndpointUri)
        An alternative discovery URI. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        discoveryEndpointUri - the value to set
        Returns:
        the dsl builder

      • filter

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder filter​(String filter)
        Filter out node ids to limit browsing. Default value notice: Regular filter expression matching node ids. The option is a: <code>java.lang.String</code> type. Default: None Group: producer
        Parameters:
        filter - the value to set
        Returns:
        the dsl builder

      • includeSubTypes

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder includeSubTypes​(boolean includeSubTypes)
        Whether to include sub-types for browsing; only applicable for non-recursive browsing. The option is a: <code>boolean</code> type. Default: true Group: producer
        Parameters:
        includeSubTypes - the value to set
        Returns:
        the dsl builder

      • includeSubTypes

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder includeSubTypes​(String includeSubTypes)
        Whether to include sub-types for browsing; only applicable for non-recursive browsing. The option will be converted to a <code>boolean</code> type. Default: true Group: producer
        Parameters:
        includeSubTypes - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder 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 MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder 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

      • maxNodeIdsPerRequest

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder maxNodeIdsPerRequest​(int maxNodeIdsPerRequest)
        The maximum number node ids requested per server call. Default value notice: Maximum number of node ids requested per browse call (applies to browsing sub-types only; only if recursive = true). The option is a: <code>int</code> type. Default: 10 Group: producer
        Parameters:
        maxNodeIdsPerRequest - the value to set
        Returns:
        the dsl builder

      • maxNodeIdsPerRequest

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder maxNodeIdsPerRequest​(String maxNodeIdsPerRequest)
        The maximum number node ids requested per server call. Default value notice: Maximum number of node ids requested per browse call (applies to browsing sub-types only; only if recursive = true). The option will be converted to a <code>int</code> type. Default: 10 Group: producer
        Parameters:
        maxNodeIdsPerRequest - the value to set
        Returns:
        the dsl builder

      • node

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder node​(String node)
        The node definition (see Node ID). Default value notice: Root folder as per OPC-UA spec. The option is a: <code>java.lang.String</code> type. Default: ns=0;id=84 Group: producer
        Parameters:
        node - the value to set
        Returns:
        the dsl builder

      • nodeClasses

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder nodeClasses​(String nodeClasses)
        The mask indicating the node classes of interest in browsing. Default value notice: Comma-separated node class list; see org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass. The option is a: <code>java.lang.String</code> type. Default: Variable,Object,DataType Group: producer
        Parameters:
        nodeClasses - the value to set
        Returns:
        the dsl builder

      • recursive

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder recursive​(boolean recursive)
        Whether to browse recursively into sub-types, ignores includeSubTypes setting as it's implied to be set to true. Default value notice: Whether to recursively browse sub-types: truefalse. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        recursive - the value to set
        Returns:
        the dsl builder

      • recursive

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder recursive​(String recursive)
        Whether to browse recursively into sub-types, ignores includeSubTypes setting as it's implied to be set to true. Default value notice: Whether to recursively browse sub-types: truefalse. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        recursive - the value to set
        Returns:
        the dsl builder

      • allowedSecurityPolicies

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder allowedSecurityPolicies​(String allowedSecurityPolicies)
        A set of allowed security policy URIs. Default is to accept all and use the highest. The option is a: <code>java.lang.String</code> type. Group: client
        Parameters:
        allowedSecurityPolicies - the value to set
        Returns:
        the dsl builder

      • applicationName

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder applicationName​(String applicationName)
        The application name. The option is a: <code>java.lang.String</code> type. Default: Apache Camel adapter for Eclipse Milo Group: client
        Parameters:
        applicationName - the value to set
        Returns:
        the dsl builder

      • applicationUri

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder applicationUri​(String applicationUri)
        The application URI. The option is a: <code>java.lang.String</code> type. Default: http://camel.apache.org/EclipseMilo/Client Group: client
        Parameters:
        applicationUri - the value to set
        Returns:
        the dsl builder

      • maxPendingPublishRequests

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder maxPendingPublishRequests​(Long maxPendingPublishRequests)
        The maximum number of pending publish requests. The option is a: <code>java.lang.Long</code> type. Group: client
        Parameters:
        maxPendingPublishRequests - the value to set
        Returns:
        the dsl builder

      • maxPendingPublishRequests

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder maxPendingPublishRequests​(String maxPendingPublishRequests)
        The maximum number of pending publish requests. The option will be converted to a <code>java.lang.Long</code> type. Group: client
        Parameters:
        maxPendingPublishRequests - the value to set
        Returns:
        the dsl builder

      • maxResponseMessageSize

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder maxResponseMessageSize​(Long maxResponseMessageSize)
        The maximum number of bytes a response message may have. The option is a: <code>java.lang.Long</code> type. Group: client
        Parameters:
        maxResponseMessageSize - the value to set
        Returns:
        the dsl builder

      • maxResponseMessageSize

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder maxResponseMessageSize​(String maxResponseMessageSize)
        The maximum number of bytes a response message may have. The option will be converted to a <code>java.lang.Long</code> type. Group: client
        Parameters:
        maxResponseMessageSize - the value to set
        Returns:
        the dsl builder

      • overrideHost

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder overrideHost​(boolean overrideHost)
        Override the server reported endpoint host with the host from the endpoint URI. The option is a: <code>boolean</code> type. Default: false Group: client
        Parameters:
        overrideHost - the value to set
        Returns:
        the dsl builder

      • overrideHost

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder overrideHost​(String overrideHost)
        Override the server reported endpoint host with the host from the endpoint URI. The option will be converted to a <code>boolean</code> type. Default: false Group: client
        Parameters:
        overrideHost - the value to set
        Returns:
        the dsl builder

      • requestedPublishingInterval

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder requestedPublishingInterval​(Double requestedPublishingInterval)
        The requested publishing interval in milliseconds. The option is a: <code>java.lang.Double</code> type. Default: 1_000.0 Group: client
        Parameters:
        requestedPublishingInterval - the value to set
        Returns:
        the dsl builder

      • requestedPublishingInterval

        default MiloBrowseEndpointBuilderFactory.MiloBrowseEndpointBuilder requestedPublishingInterval​(String requestedPublishingInterval)
        The requested publishing interval in milliseconds. The option will be converted to a <code>java.lang.Double</code> type. Default: 1_000.0 Group: client
        Parameters:
        requestedPublishingInterval - the value to set
        Returns:
        the dsl builder