Uses of Interface
net.ygbstudio.jbrave.api.response.ApiResponse

Packages that use ApiResponse

Package	Description
net.ygbstudio.jbrave.api.builders	Public, fluent builders for constructing, configuring, and executing Brave Search API queries.
net.ygbstudio.jbrave.api.response	Sealed response model returned by the Brave Search API.

Uses of ApiResponse in net.ygbstudio.jbrave.api.builders

Classes in net.ygbstudio.jbrave.api.builders with type parameters of type ApiResponse

Modifier and Type	Interface	Description
interface	BraveQueryBuilder<T,E extends ApiResponse>	An interface for Brave API query builders, implemented by all builders that build Brave API queries.

Methods in net.ygbstudio.jbrave.api.builders that return types with arguments of type ApiResponse

Modifier and Type	Method	Description
default Optional<ApiResponse>	BraveQueryBuilder.getEitherPOJO()	Converts the current response to a POJO instance of the builder's response type E if the status code of the response is 200.

Uses of ApiResponse in net.ygbstudio.jbrave.api.response

Classes in net.ygbstudio.jbrave.api.response that implement ApiResponse

Modifier and Type	Class	Description
final record	ErrorResponse	Error response object that the Brave Search API sends in case the client's request results in either 404, 422, or 429 http status codes.
final record	ImageSearchApiResponse	Represents the response from the Brave Search API for image searches.
final record	NewsSearchApiResponse	Represents the response from the Brave Search API for news searches.
final record	SpellcheckSearchApiResponse	Represents the response from the Brave Search API for spell check.
final record	SuggestSearchApiResponse	Represents the response from the Brave Search API for suggestions.
final record	VideoSearchApiResponse	Represents the response from the Brave Search API for video searches.
final record	WebSearchApiResponse	Represents the top-level response from the Brave Search API.

Methods in net.ygbstudio.jbrave.api.response with type parameters of type ApiResponse

Modifier and Type	Method	Description
static <T extends ApiResponse> T	ApiResponse.from(File dataFile, Class<T> clazz)	Deserializes an API response from a JSON file.
static <T extends ApiResponse> T	ApiResponse.from(Reader dataReader, Class<T> clazz)	Deserializes an API response from a JSON reader.
static <T extends ApiResponse> T	ApiResponse.from(String dataString, Class<T> clazz)	Deserializes an API response from a JSON string.
static <T extends ApiResponse> T	ApiResponse.from(@NotNull HttpResponse<String> dataResponse, Class<T> clazz)	Deserializes an API response from the body of an HTTP response.