Package org.bsc.spring.agentexecutor.function

Class WeatherFunction

java.lang.Object

org.bsc.spring.agentexecutor.function.WeatherFunction

All Implemented Interfaces:

Function<WeatherFunction.Request,WeatherFunction.Response>

public class WeatherFunction
extends Object
implements Function<WeatherFunction.Request,WeatherFunction.Response>

Class representing the WeatherFunction which implements a Function interface to retrieve weather data from an external API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	WeatherFunction.Condition	Record representing weather conditions described in text form.
static final record	WeatherFunction.Current	Record representing current weather details as part of the weather response.
static final record	WeatherFunction.Location	Record representing location information as part of the weather response.
static final record	WeatherFunction.Request	Record representing the request object for WeatherFunction.
static final record	WeatherFunction.Response	Record representing the response object returned by the WeatherFunction.

Constructor Summary

Constructors

Constructor	Description
WeatherFunction(WeatherConfig props)	Constructor for the WeatherFunction class that initializes the necessary components based on provided configuration properties and logs relevant debug information.

Method Summary

Modifier and Type	Method	Description
WeatherFunction.Response	apply(WeatherFunction.Request weatherRequest)	Main method to apply the function, which retrieves weather data for a given city.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Details

WeatherFunction

public WeatherFunction(WeatherConfig props)

Constructor for the WeatherFunction class that initializes the necessary components based on provided configuration properties and logs relevant debug information.

Parameters:

props - Configuration properties for initializing the RestClient.

Method Details

apply

public WeatherFunction.Response apply(WeatherFunction.Request weatherRequest)

Main method to apply the function, which retrieves weather data for a given city.

Specified by:

apply in interface Function<WeatherFunction.Request,WeatherFunction.Response>

Parameters:

weatherRequest - The request object containing the city for which weather data is required.

Returns:

The response object containing the retrieved weather data.