WeatherEndpointBuilderFactory.WeatherEndpointBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder, WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder

Enclosing interface:

WeatherEndpointBuilderFactory
```
public static interface WeatherEndpointBuilderFactory.WeatherEndpointBuilder
extends WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder, WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
```
Builder for endpoint for the Weather component.

Method Summary

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

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, bridgeErrorHandler, bridgeErrorHandler, delay, delay, greedy, greedy, initialDelay, initialDelay, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, startScheduler, startScheduler, timeUnit, timeUnit, useFixedDelay, useFixedDelay

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

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

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
lazyStartProducer, lazyStartProducer

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.AdvancedWeatherEndpointBuilder advanced()
```
    Specified by:
    
    advanced in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    advanced in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
  - appid
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    appid in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    appid in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    appid - the value to set
    
    Returns:
    
    the dsl builder
  - headerName
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    headerName in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    headerName in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    headerName - the value to set
    
    Returns:
    
    the dsl builder
  - language
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    language in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    language in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    language - the value to set
    
    Returns:
    
    the dsl builder
  - language
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    language in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    language in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    language - the value to set
    
    Returns:
    
    the dsl builder
  - mode
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    mode in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    mode in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    mode - the value to set
    
    Returns:
    
    the dsl builder
  - mode
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    mode in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    mode in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    mode - the value to set
    
    Returns:
    
    the dsl builder
  - period
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    period in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    period in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    period - the value to set
    
    Returns:
    
    the dsl builder
  - units
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder units(WeatherEndpointBuilderFactory.WeatherUnits units)
```
    The units for temperature measurement. The option is a: <code>org.apache.camel.component.weather.WeatherUnits</code> type. Group: common
    
    Specified by:
    
    units in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    units in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    units - the value to set
    
    Returns:
    
    the dsl builder
  - units
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    units in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    units in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    units - the value to set
    
    Returns:
    
    the dsl builder
  - weatherApi
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    weatherApi in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    weatherApi in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    weatherApi - the value to set
    
    Returns:
    
    the dsl builder
  - weatherApi
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    weatherApi in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    weatherApi in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    weatherApi - the value to set
    
    Returns:
    
    the dsl builder
  - cnt
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder cnt(Integer cnt)
```
    Number of results to be found. The option is a: <code>java.lang.Integer</code> type. Group: filter
    
    Specified by:
    
    cnt in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    cnt in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    cnt - the value to set
    
    Returns:
    
    the dsl builder
  - cnt
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder cnt(String cnt)
```
    Number of results to be found. The option will be converted to a <code>java.lang.Integer</code> type. Group: filter
    
    Specified by:
    
    cnt in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    cnt in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    cnt - the value to set
    
    Returns:
    
    the dsl builder
  - ids
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    ids in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    ids in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    ids - the value to set
    
    Returns:
    
    the dsl builder
  - ids
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    ids in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    ids in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    ids - the value to set
    
    Returns:
    
    the dsl builder
  - lat
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    lat in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    lat in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    lat - the value to set
    
    Returns:
    
    the dsl builder
  - location
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    location in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    location in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    location - the value to set
    
    Returns:
    
    the dsl builder
  - lon
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    lon in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    lon in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    lon - the value to set
    
    Returns:
    
    the dsl builder
  - rightLon
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    rightLon in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    rightLon in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    rightLon - the value to set
    
    Returns:
    
    the dsl builder
  - topLat
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    topLat in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    topLat in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    topLat - the value to set
    
    Returns:
    
    the dsl builder
  - zip
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder zip(String zip)
```
    Zip-code, e.g. 94040,us. The option is a: <code>java.lang.String</code> type. Group: filter
    
    Specified by:
    
    zip in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    zip in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    zip - the value to set
    
    Returns:
    
    the dsl builder
  - zoom
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    zoom in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    zoom in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    zoom - the value to set
    
    Returns:
    
    the dsl builder
  - zoom
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    zoom in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    zoom in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    zoom - the value to set
    
    Returns:
    
    the dsl builder
  - geolocationAccessKey
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    geolocationAccessKey in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    geolocationAccessKey in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    geolocationAccessKey - the value to set
    
    Returns:
    
    the dsl builder
  - geolocationRequestHostIP
```
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder 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
    
    Specified by:
    
    geolocationRequestHostIP in interface WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
    
    Specified by:
    
    geolocationRequestHostIP in interface WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
    
    Parameters:
    
    geolocationRequestHostIP - the value to set
    
    Returns:
    
    the dsl builder

Interface WeatherEndpointBuilderFactory.WeatherEndpointBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.WeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder

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

cnt

cnt

ids

ids

lat

location

lon

rightLon

topLat

zip

zoom

zoom

geolocationAccessKey

geolocationRequestHostIP