WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

WeatherEndpointBuilderFactory.WeatherEndpointBuilder

Enclosing interface:

WeatherEndpointBuilderFactory
```
public static interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint producers for the Weather component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default WeatherEndpointBuilderFactory.AdvancedWeatherEndpointProducerBuilder`	`advanced()`
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`appid(String appid)` APPID ID used to authenticate the user connected to the API Server.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`cnt(Integer cnt)` Number of results to be found.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`cnt(String cnt)` Number of results to be found.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`geolocationAccessKey(String geolocationAccessKey)` The geolocation service now needs an accessKey to be used.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`geolocationRequestHostIP(String geolocationRequestHostIP)` The geolocation service now needs to specify the IP associated to the accessKey you're using.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`headerName(String headerName)` To store the weather result in this header instead of the message body.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`ids(List<String> ids)` List of id's of city/stations.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`ids(String ids)` List of id's of city/stations.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`language(String language)` Language of the response.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`language(WeatherEndpointBuilderFactory.WeatherLanguage language)` Language of the response.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`lat(String lat)` Latitude of location.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`lazyStartProducer(String lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`location(String location)` If null Camel will try and determine your current location using the geolocation of your ip address, else specify the city,country.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`lon(String lon)` Longitude of location.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`mode(String mode)` The output format of the weather data.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`mode(WeatherEndpointBuilderFactory.WeatherMode mode)` The output format of the weather data.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`period(String period)` If null, the current weather will be returned, else use values of 5, 7, 14 days.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`rightLon(String rightLon)` For boxed queries this is the right longtitude.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`topLat(String topLat)` For boxed queries this is the top latitude.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`units(String units)` The units for temperature measurement.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`units(WeatherEndpointBuilderFactory.WeatherUnits units)` The units for temperature measurement.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`weatherApi(String weatherApi)` The API to use (current, forecast/3 hour, forecast daily, station).
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`weatherApi(WeatherEndpointBuilderFactory.WeatherApi weatherApi)` The API to use (current, forecast/3 hour, forecast daily, station).
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`zip(String zip)` Zip-code, e.g.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`zoom(Integer zoom)` For boxed queries this is the zoom.
`default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder`	`zoom(String zoom)` For boxed queries this is the zoom.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve

- Method Detail
  - advanced
```
default WeatherEndpointBuilderFactory.AdvancedWeatherEndpointProducerBuilder advanced()
```
  - appid
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder appid(String appid)
```
    APPID ID used to authenticate the user connected to the API Server. The option is a: <code>java.lang.String</code> type. Required: true Group: common
    
    Parameters:
    
    appid - the value to set
    
    Returns:
    
    the dsl builder
  - headerName
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder headerName(String headerName)
```
    To store the weather result in this header instead of the message body. This is useable if you want to keep current message body as-is. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    headerName - the value to set
    
    Returns:
    
    the dsl builder
  - language
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder language(WeatherEndpointBuilderFactory.WeatherLanguage language)
```
    Language of the response. The option is a: <code>org.apache.camel.component.weather.WeatherLanguage</code> type. Default: en Group: common
    
    Parameters:
    
    language - the value to set
    
    Returns:
    
    the dsl builder
  - language
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder language(String language)
```
    Language of the response. The option will be converted to a <code>org.apache.camel.component.weather.WeatherLanguage</code> type. Default: en Group: common
    
    Parameters:
    
    language - the value to set
    
    Returns:
    
    the dsl builder
  - mode
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder mode(WeatherEndpointBuilderFactory.WeatherMode mode)
```
    The output format of the weather data. The option is a: <code>org.apache.camel.component.weather.WeatherMode</code> type. Default: JSON Group: common
    
    Parameters:
    
    mode - the value to set
    
    Returns:
    
    the dsl builder
  - mode
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder mode(String mode)
```
    The output format of the weather data. The option will be converted to a <code>org.apache.camel.component.weather.WeatherMode</code> type. Default: JSON Group: common
    
    Parameters:
    
    mode - the value to set
    
    Returns:
    
    the dsl builder
  - period
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder period(String period)
```
    If null, the current weather will be returned, else use values of 5, 7, 14 days. Only the numeric value for the forecast period is actually parsed, so spelling, capitalisation of the time period is up to you (its ignored). The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    period - the value to set
    
    Returns:
    
    the dsl builder
  - units
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder units(WeatherEndpointBuilderFactory.WeatherUnits units)
```
    The units for temperature measurement. The option is a: <code>org.apache.camel.component.weather.WeatherUnits</code> type. Group: common
    
    Parameters:
    
    units - the value to set
    
    Returns:
    
    the dsl builder
  - units
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder units(String units)
```
    The units for temperature measurement. The option will be converted to a <code>org.apache.camel.component.weather.WeatherUnits</code> type. Group: common
    
    Parameters:
    
    units - the value to set
    
    Returns:
    
    the dsl builder
  - weatherApi
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder weatherApi(WeatherEndpointBuilderFactory.WeatherApi weatherApi)
```
    The API to use (current, forecast/3 hour, forecast daily, station). The option is a: <code>org.apache.camel.component.weather.WeatherApi</code> type. Group: common
    
    Parameters:
    
    weatherApi - the value to set
    
    Returns:
    
    the dsl builder
  - weatherApi
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder weatherApi(String weatherApi)
```
    The API to use (current, forecast/3 hour, forecast daily, station). The option will be converted to a <code>org.apache.camel.component.weather.WeatherApi</code> type. Group: common
    
    Parameters:
    
    weatherApi - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder 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 WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder 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
  - cnt
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder cnt(Integer cnt)
```
    Number of results to be found. The option is a: <code>java.lang.Integer</code> type. Group: filter
    
    Parameters:
    
    cnt - the value to set
    
    Returns:
    
    the dsl builder
  - cnt
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder cnt(String cnt)
```
    Number of results to be found. The option will be converted to a <code>java.lang.Integer</code> type. Group: filter
    
    Parameters:
    
    cnt - the value to set
    
    Returns:
    
    the dsl builder
  - ids
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder ids(List<String> ids)
```
    List of id's of city/stations. You can separate multiple ids by comma. The option is a: <code>java.util.List<java.lang.String></code> type. Group: filter
    
    Parameters:
    
    ids - the value to set
    
    Returns:
    
    the dsl builder
  - ids
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder ids(String ids)
```
    List of id's of city/stations. You can separate multiple ids by comma. The option will be converted to a <code>java.util.List<java.lang.String></code> type. Group: filter
    
    Parameters:
    
    ids - the value to set
    
    Returns:
    
    the dsl builder
  - lat
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder lat(String lat)
```
    Latitude of location. You can use lat and lon options instead of location. For boxed queries this is the bottom latitude. The option is a: <code>java.lang.String</code> type. Group: filter
    
    Parameters:
    
    lat - the value to set
    
    Returns:
    
    the dsl builder
  - location
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder location(String location)
```
    If null Camel will try and determine your current location using the geolocation of your ip address, else specify the city,country. For well known city names, Open Weather Map will determine the best fit, but multiple results may be returned. Hence specifying and country as well will return more accurate data. If you specify current as the location then the component will try to get the current latitude and longitude and use that to get the weather details. You can use lat and lon options instead of location. The option is a: <code>java.lang.String</code> type. Group: filter
    
    Parameters:
    
    location - the value to set
    
    Returns:
    
    the dsl builder
  - lon
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder lon(String lon)
```
    Longitude of location. You can use lat and lon options instead of location. For boxed queries this is the left longtitude. The option is a: <code>java.lang.String</code> type. Group: filter
    
    Parameters:
    
    lon - the value to set
    
    Returns:
    
    the dsl builder
  - rightLon
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder rightLon(String rightLon)
```
    For boxed queries this is the right longtitude. Needs to be used in combination with topLat and zoom. The option is a: <code>java.lang.String</code> type. Group: filter
    
    Parameters:
    
    rightLon - the value to set
    
    Returns:
    
    the dsl builder
  - topLat
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder topLat(String topLat)
```
    For boxed queries this is the top latitude. Needs to be used in combination with rightLon and zoom. The option is a: <code>java.lang.String</code> type. Group: filter
    
    Parameters:
    
    topLat - the value to set
    
    Returns:
    
    the dsl builder
  - zip
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder zip(String zip)
```
    Zip-code, e.g. 94040,us. The option is a: <code>java.lang.String</code> type. Group: filter
    
    Parameters:
    
    zip - the value to set
    
    Returns:
    
    the dsl builder
  - zoom
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder zoom(Integer zoom)
```
    For boxed queries this is the zoom. Needs to be used in combination with rightLon and topLat. The option is a: <code>java.lang.Integer</code> type. Group: filter
    
    Parameters:
    
    zoom - the value to set
    
    Returns:
    
    the dsl builder
  - zoom
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder zoom(String zoom)
```
    For boxed queries this is the zoom. Needs to be used in combination with rightLon and topLat. The option will be converted to a <code>java.lang.Integer</code> type. Group: filter
    
    Parameters:
    
    zoom - the value to set
    
    Returns:
    
    the dsl builder
  - geolocationAccessKey
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder geolocationAccessKey(String geolocationAccessKey)
```
    The geolocation service now needs an accessKey to be used. The option is a: <code>java.lang.String</code> type. Required: true Group: security
    
    Parameters:
    
    geolocationAccessKey - the value to set
    
    Returns:
    
    the dsl builder
  - geolocationRequestHostIP
```
default WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder geolocationRequestHostIP(String geolocationRequestHostIP)
```
    The geolocation service now needs to specify the IP associated to the accessKey you're using. The option is a: <code>java.lang.String</code> type. Required: true Group: security
    
    Parameters:
    
    geolocationRequestHostIP - the value to set
    
    Returns:
    
    the dsl builder

Interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

advanced

appid

headerName

language

language

mode

mode

period

units

units

weatherApi

weatherApi

lazyStartProducer

lazyStartProducer

cnt

cnt

ids

ids

lat

location

lon

rightLon

topLat

zip

zoom

zoom

geolocationAccessKey

geolocationRequestHostIP