All Classes and Interfaces
Class
Description
Exception thrown when a search query is absent in a URL query builder method.
Exception thrown when a search vertical is absent in a URL query builder.
Abstract base class for building Brave API request builders.
Represents an abstract base class for graph infoboxes in search results.
Abstract base class for building Brave API queries.
Base class for executing HTTP requests using a shared, long-lived
HttpClient.Represents an action that can be performed, typically containing a type and a URL.
Represents an answer to a question in the FAQ section of Brave Search API responses.
Error model object that Brave Search API uses to communicate with the user and provide
remediation steps.
This marker interface represents the API response objects from the Brave Search API.
Represents an article in search results, containing metadata about the article such as authors,
publication date, and accessibility information.
Represents a book in search results, containing detailed information about the book such as its
title, authors, publication details, and ratings.
Interface for constants that are used in Brave API.
BraveApiException exist to alert users about known errors that require user attention.
This exception is thrown when there is an error in a request involving the Brave Search API
internal client.
Enumeration of Brave API error codes.
Serializes execution of HTTP requests against a shared Brave API execution context.
Exception that is thrown when a supplied goggles URI is not a valid URL candidate for its
parameter value, for example, the resulting URL from URI is malformed.
Enumeration of possible Brave Search API headers.
A builder for constructing Brave Image Search API queries.
Exception thrown when there is an error related to the local environment.
The
BraveNewsQuery class provides a builder for building Brave News API queries.An interface for Brave API query builders.
The
BraveRequestExecutor class is a concrete implementation of the AbstractRequestExecutor abstract class.Enum representing the different search resources of the Brave API.
A record class representing a Brave Search API header.
A search option that can be used in the search methods.
A builder class for building Brave Spell Check API queries.
The
BraveSuggestQuery class provides a builder for building Brave Suggest API queries.A builder class for building Brave Video API queries.
A builder class for constructing Brave Web search queries.
Represents an interactive button in search results, providing users with actions they can take
directly from the search results.
Represents the client information.
This interface identifies search options that must provide methods to ensure that they produce
the correct typed
SearchOptionCarrier since their values are provided by the client, not
by the API.Represents contact information for an entity in search results, such as a business, organization,
or service provider.
Represents a contact point for an organization or person.
A Data Transfer Object representing the context of a response error object.
Enumeration representing a country supported by the Brave Search API.
An interface representing a country identifier.
Represents a creative work in search results, which is a broad category that includes various
types of content such as articles, books, movies, music, and more.
Represents a data provider in search results.
Represents the opening hours for a specific day of the week for a business or location.
Represents a comprehensive set of information about a search result in the Brave Search API.
Represents a discussion result in search results.
Represents a record of discussion information in search results.
Exception thrown when a task list is empty and the client requested an asynchronous execution.
Represents an entity infobox in search results.
A Data Transfer Object representing error information of a response object in the Brave Search
API.
A metaobject containing non-standard meta-information about the component affected by an error in
the Brave Search API.
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.
Represents additional information in search results.
Represents Frequently Asked Questions (FAQs) information in search results.
Represents forum data in search results, containing information about forum posts and discussions
that are relevant to the search query.
An enumeration representing freshness filters for the API requests.
Represents a generic infobox in search results.
Represents graph infobox information in search results.
Marker interface for graph infobox profiles in search results.
Represents a step in a how-to guide or tutorial.
Represents an image in search results, containing the image's URL, thumbnail, and additional
properties.
Represents the properties of an image in search results.
Represents an image query in search requests.
Represents an image result in search responses.
Represents the response from the Brave Search API for image searches.
Data transfer object for representing an image thumbnail in the Brave Search API.
Represents an infobox for a place in search results.
Represents a profile in search results.
Represents an infobox with location information in search results.
Exception thrown when the interval of dates provided for a freshness filter is invalid.
This exception is thrown when the query term added to the
AbstractQueryUrlBuilder is invalid.JsonSupport provides JSON serialization and deserialization support using Jackson.
Represents language information in search results.
An interface representing a language identifier.
Constants for the local environment variables used by the JBrave library.
Represents descriptive information about a specific location in search results.
Represents a location result in search results.
Represents location information in search results.
Represents a location web result in search results.
Enumeration representing a market locale supported by the Brave Search API.
Represents metadata about a URL in search results.
This exception is thrown when there is a missing subscription token.
Represents mixed response information in search results.
Represents detailed information about a movie in search results.
Represents a music recording (e.g., a song or track) in search results.
Represents news information in search results.
Represents a news result in search results.
Represents the response from the Brave Search API for news searches.
Represents a product or service offering in search results.
Represents the opening hours for a business or location, including both the current day's hours
and a weekly schedule.
Represents an organization in search results.
Builder class for Organization.
Represents the original query in a search request.
Represents a person in search results.
Builder class for Person.
Represents a collection of image results in search responses.
Represents a physical mailing address in search results.
Represents a monetary amount with its associated currency.
Represents a product in search results, containing detailed information about the product such as
its name, category, price, and GTIN identifiers.
Represents a product along with its associated review.
Represents a profile in search results.
Data transfer object for representing metadata for the images in the Brave Search API.
An interface representing a search option that provides a key and a value for a URL parameter.
Represents a question and answer pair in search results, typically used in FAQ sections or
question-and-answer platforms.
Represents a QA infobox in search results.
Represents a question and answer page in search results, containing a question and its
corresponding answer.
Represents a query in search requests.
Constructs a
RateLimitResponse with the given rate limit information.Represents rating information for various entities in search results, such as products,
businesses, or services.
Represents a recipe in search results.
An interface representing a region-locale identifier.
An exception that is thrown when a request processing thread is interrupted while waiting to
acquire execution admission
Thrown when all retry attempts for an HTTP request have been exhausted, indicating that the
executor was unable to complete a series of retries.
Represents a generic result in search results.
Enumeration of possible result filters to be used in the api requests.
Represents a reference to a search result or a group of results.
Represents a single review in search results, containing information about the reviewer, their
rating, and their comments.
Represents a collection of reviews in search results, typically associated with a business,
product, or service.
Represents a hint for rich callbacks in search results.
Represents rich callback information in search results.
Enumeration representing safe search filters for the API requests.
Represents search information in search results.
Enumeration class representing filter modes for the Brave Search API.
An interface representing a search filter.
An interface representing a header for a search request.
Enum representing the different language identifiers supported by the Brave Search API.
A builder class for constructing search operators.
Search operators that were detected and applied to the query according to the Brave Search API
documentation.
An interface representing a search option.
An interface that represents a carrier for a
SearchOption and its corresponding value.Enumeration of the search options available in the Brave API.
Represents a search result in search results.
An interface representing a search vertical.
Represents software information in search results.
Represents a spell check result in search responses.
Represents the response from the Brave Search API for spell check.
Represents a suggestion result in search responses.
Represents the response from the Brave Search API for suggestions.
Represents a summarizer in search results.
Represents a thumbnail image in search results.
Represents a review from TripAdvisor in search results.
Exception thrown when a URL query builder is not initialized before adding options.
Represents a value with its associated unit of measurement.
Enumeration of the different units of measurement that can be used in the search methods.
Represents video data in search results.
Represents a video result in search results.
Represents video information in search results.
Represents the response from the Brave Search API for video searches.
Represents web query information in search results.
Represents the top-level response from the Brave Search API.
Shows the maximum number of requests allowed for each time window in your plan.
Provides the complete policy specification including time window sizes.
Indicates how many requests you can still make within each time window before hitting the limit.
Shows when each quota window will reset, expressed in seconds from now.