Interface WeatherEndpointBuilderFactory.WeatherEndpointBuilder
-
- 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
-
Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri
-
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri
-
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.endpoint.dsl.WeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
lazyStartProducer, lazyStartProducer
-
-
-
-
Method Detail
-
advanced
default WeatherEndpointBuilderFactory.AdvancedWeatherEndpointBuilder advanced()
- Specified by:
advanced
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
advanced
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
appid
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder appid(String appid)
APPID ID used to authenticate the user connected to the API Server. The option is a:java.lang.String
type. Required: true Group: common- Specified by:
appid
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
appid
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
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:java.lang.String
type. Group: common- Specified by:
headerName
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
headerName
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
language
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder language(WeatherEndpointBuilderFactory.WeatherLanguage language)
Language of the response. The option is a:org.apache.camel.component.weather.WeatherLanguage
type. Default: en Group: common- Specified by:
language
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
language
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
language
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder language(String language)
Language of the response. The option will be converted to aorg.apache.camel.component.weather.WeatherLanguage
type. Default: en Group: common- Specified by:
language
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
language
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
mode
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder mode(WeatherEndpointBuilderFactory.WeatherMode mode)
The output format of the weather data. The option is a:org.apache.camel.component.weather.WeatherMode
type. Default: JSON Group: common- Specified by:
mode
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
mode
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
mode
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder mode(String mode)
The output format of the weather data. The option will be converted to aorg.apache.camel.component.weather.WeatherMode
type. Default: JSON Group: common- Specified by:
mode
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
mode
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
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:java.lang.String
type. Group: common- Specified by:
period
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
period
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
units
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder units(WeatherEndpointBuilderFactory.WeatherUnits units)
The units for temperature measurement. The option is a:org.apache.camel.component.weather.WeatherUnits
type. Group: common- Specified by:
units
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
units
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
units
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder units(String units)
The units for temperature measurement. The option will be converted to aorg.apache.camel.component.weather.WeatherUnits
type. Group: common- Specified by:
units
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
units
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
weatherApi
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder weatherApi(WeatherEndpointBuilderFactory.WeatherApi weatherApi)
The API to use (current, forecast/3 hour, forecast daily, station). The option is a:org.apache.camel.component.weather.WeatherApi
type. Group: common- Specified by:
weatherApi
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
weatherApi
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
weatherApi
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder weatherApi(String weatherApi)
The API to use (current, forecast/3 hour, forecast daily, station). The option will be converted to aorg.apache.camel.component.weather.WeatherApi
type. Group: common- Specified by:
weatherApi
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
weatherApi
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
cnt
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder cnt(Integer cnt)
Number of results to be found. The option is a:java.lang.Integer
type. Group: filter- Specified by:
cnt
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
cnt
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
cnt
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder cnt(String cnt)
Number of results to be found. The option will be converted to ajava.lang.Integer
type. Group: filter- Specified by:
cnt
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
cnt
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
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:java.util.List<java.lang.String>
type. Group: filter- Specified by:
ids
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
ids
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
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 ajava.util.List<java.lang.String>
type. Group: filter- Specified by:
ids
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
ids
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
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:java.lang.String
type. Group: filter- Specified by:
lat
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
lat
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
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:java.lang.String
type. Group: filter- Specified by:
location
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
location
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
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:java.lang.String
type. Group: filter- Specified by:
lon
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
lon
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
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:java.lang.String
type. Group: filter- Specified by:
rightLon
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
rightLon
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
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:java.lang.String
type. Group: filter- Specified by:
topLat
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
topLat
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
zip
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder zip(String zip)
Zip-code, e.g. 94040,us. The option is a:java.lang.String
type. Group: filter- Specified by:
zip
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
zip
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
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:java.lang.Integer
type. Group: filter- Specified by:
zoom
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
zoom
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
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 ajava.lang.Integer
type. Group: filter- Specified by:
zoom
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
zoom
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
geolocationAccessKey
default WeatherEndpointBuilderFactory.WeatherEndpointBuilder geolocationAccessKey(String geolocationAccessKey)
The geolocation service now needs an accessKey to be used. The option is a:java.lang.String
type. Required: true Group: security- Specified by:
geolocationAccessKey
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
geolocationAccessKey
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
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:java.lang.String
type. Required: true Group: security- Specified by:
geolocationRequestHostIP
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointConsumerBuilder
- Specified by:
geolocationRequestHostIP
in interfaceWeatherEndpointBuilderFactory.WeatherEndpointProducerBuilder
-
-