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

Interface GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    Enclosing interface:
    GeoCoderEndpointBuilderFactory
    public static interface GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint for the Geocoder component.

    • Method Detail

      • headersOnly

        default GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder headersOnly​(boolean headersOnly)
        Whether to only enrich the Exchange with headers, and leave the body as-is. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        headersOnly - the value to set
        Returns:
        the dsl builder

      • headersOnly

        default GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder headersOnly​(String headersOnly)
        Whether to only enrich the Exchange with headers, and leave the body as-is. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        headersOnly - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder 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 GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder 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

      • serverUrl

        default GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder serverUrl​(String serverUrl)
        URL to the geocoder server. Mandatory for Nominatim server. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        serverUrl - the value to set
        Returns:
        the dsl builder

      • type

        default GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder type​(org.apache.camel.component.geocoder.GeoCoderType type)
        Type of GeoCoding server. Supported Nominatim and Google. The option is a: <code>org.apache.camel.component.geocoder.GeoCoderType</code> type. Group: producer
        Parameters:
        type - the value to set
        Returns:
        the dsl builder

      • type

        default GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder type​(String type)
        Type of GeoCoding server. Supported Nominatim and Google. The option will be converted to a <code>org.apache.camel.component.geocoder.GeoCoderType</code> type. Group: producer
        Parameters:
        type - the value to set
        Returns:
        the dsl builder

      • proxyAuthDomain

        default GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder proxyAuthDomain​(String proxyAuthDomain)
        Proxy Authentication Domain to access Google GeoCoding server. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        proxyAuthDomain - the value to set
        Returns:
        the dsl builder

      • proxyAuthHost

        default GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder proxyAuthHost​(String proxyAuthHost)
        Proxy Authentication Host to access Google GeoCoding server. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        proxyAuthHost - the value to set
        Returns:
        the dsl builder

      • proxyAuthMethod

        default GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder proxyAuthMethod​(String proxyAuthMethod)
        Authentication Method to Google GeoCoding server. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        proxyAuthMethod - the value to set
        Returns:
        the dsl builder

      • proxyAuthPassword

        default GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder proxyAuthPassword​(String proxyAuthPassword)
        Proxy Password to access GeoCoding server. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        proxyAuthPassword - the value to set
        Returns:
        the dsl builder

      • proxyAuthUsername

        default GeoCoderEndpointBuilderFactory.GeoCoderEndpointBuilder proxyAuthUsername​(String proxyAuthUsername)
        Proxy Username to access GeoCoding server. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        proxyAuthUsername - the value to set
        Returns:
        the dsl builder