Index

A B C D E F G H I J K L M N O P Q R S T U V W X Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

abbrName() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DayOpeningHours
Returns the value of the abbrName record component.
AbsentSearchQueryException - Exception Class in net.ygbstudio.jbrave.core.exceptions
Exception thrown when a search query is absent in a URL query builder method.
AbsentSearchQueryException(String) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.AbsentSearchQueryException
Creates a new instance with the given detail message.
AbsentSearchVerticalException - Exception Class in net.ygbstudio.jbrave.core.exceptions
Exception thrown when a search vertical is absent in a URL query builder.
AbsentSearchVerticalException(String) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.AbsentSearchVerticalException
Creates a new instance with the given detail message.
AbstractBraveRequestBuilder<T> - Class in net.ygbstudio.jbrave.core.builders
Abstract base class for building Brave API request builders.
AbstractBraveRequestBuilder() - Constructor for class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder
Creates a new abstract request builder with an empty request state.
AbstractGraphInfobox - Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents an abstract base class for graph infoboxes in search results.
AbstractGraphInfobox(AbstractGraphInfobox.Builder) - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Creates a new graph infobox from the given builder.
AbstractGraphInfobox.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result
Builder for AbstractGraphInfobox instances.
AbstractQueryUrlBuilder<T> - Class in net.ygbstudio.jbrave.core.builders
Abstract base class for building Brave API queries.
AbstractQueryUrlBuilder() - Constructor for class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Creates a new abstract query URL builder with an empty URL state.
AbstractRequestExecutor<T> - Class in net.ygbstudio.jbrave.core.executors
Base class for executing HTTP requests using a shared, long-lived HttpClient.
AbstractRequestExecutor() - Constructor for class net.ygbstudio.jbrave.core.executors.AbstractRequestExecutor
Creates a new executor backed by a shared, long-lived HttpClient.
action(Action) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the action.
Action - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents an action that can be performed, typically containing a type and a URL.
Action(String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Action
Creates an instance of a Action record class.
actors() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Returns the value of the actors record component.
adaptHttpResponse(HttpResponse<R>, U) - Method in class net.ygbstudio.jbrave.core.executors.AbstractRequestExecutor
Adapts an existing HttpResponse to a new response body type.
addHeader(K, String) - Method in class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder
Adds a header to the list of headers.
addInstanceVertical(SearchVertical) - Method in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Adds a vertical to the current builder instance so that it can be reused.
addOption(SearchOption, U) - Method in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Adds an option to the URL query.
addOptionCarrier(SearchOptionCarrier<V>) - Method in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Adds a search option carrier to the URL query.
addQueryTerm(String, boolean) - Method in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Adds a query term to the URL query and encodes it using UTF-8.
addressLocality() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PostalAddress
Returns the value of the addressLocality record component.
addressRegion() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PostalAddress
Returns the value of the addressRegion record component.
age - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The age of the result content.
age - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The age of the result content.
age() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult
Returns the age of the news.
age() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the age of the result.
age() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult
Returns the age of the video.
age(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult.Builder
Sets the age of the news.
age(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the age of the result.
age(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult.Builder
Sets the age of the video.
all() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ResultReference
Returns the value of the all record component.
altered() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageQuery
Returns the value of the altered record component.
altered() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Query
Returns the value of the altered record component.
altered() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the altered record component.
and(String, String) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds the logical AND operator and its corresponding values to the builder.
and(UnaryOperator<SearchOperatorBuilder>, UnaryOperator<SearchOperatorBuilder>) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds the logical AND operator and its corresponding values to the builder.
AND - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Logical AND operator.
answer() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.QA
Returns the value of the answer record component.
answer() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.QAPage
Returns the value of the answer record component.
Answer - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents an answer to a question in the FAQ section of Brave Search API responses.
Answer(String, String, Integer, Integer) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Answer
Creates an instance of a Answer record class.
API_VERSION - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
Api-Version request header; check the API changelog for the current value.
ApiErrorModel - Class in net.ygbstudio.jbrave.core.domain.dto.error
Error model object that Brave Search API uses to communicate with the user and provide remediation steps.
ApiErrorModel(ApiErrorModel.Builder) - Constructor for class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel
Creates a new error model from the given builder.
ApiErrorModel.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.error
Builder for ApiErrorModel instances.
ApiResponse - Interface in net.ygbstudio.jbrave.api.response
Represents a response from the Brave Search API.
applied() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.SearchOperators
Returns the value of the applied record component.
ARABIC - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Arabic.
ARGENTINA - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Argentina.
ARGENTINA - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Argentina.
article - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The article data for this result.
article - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The article data for this result.
article() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the article data.
article(Article) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the article data.
Article - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents an article in search results, containing metadata about the article such as authors, publication date, and accessibility information.
Article(List<Person>, String, Organization, Thumbnail, Boolean) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Article
Creates an instance of a Article record class.
askForLocation() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the askForLocation record component.
attachHeaders() - Method in class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder
Attaches the headers to the request builder.
attributes - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The infobox attributes as a list of key-value pairs.
attributes(List<List<String>>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the infobox attributes.
AUSTRALIA - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Australia.
AUSTRALIA - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Australia.
AUSTRIA - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Austria.
AUSTRIA - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Austria.
author() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.VideoData
Returns the value of the author record component.
author() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Answer
Returns the value of the author record component.
author() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Article
Returns the value of the author record component.
author() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Book
Returns the value of the author record component.
author() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Returns the value of the author record component.
author() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.TripAdvisorReview
Returns the value of the author record component.

B

badResults() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the badResults record component.
BASQUE - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Basque.
BELGIUM - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Belgium.
BELGIUM_DUTCH - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Belgium (Dutch).
BELGIUM_FRENCH - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Belgium (French).
BENGALI - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Bengali.
bestRating() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Rating
Returns the value of the bestRating record component.
between(LocalDate, LocalDate) - Static method in enum class net.ygbstudio.jbrave.api.filters.Freshness
Joins the given dates with the "to" keyword and returns it as a value for the freshness filter.
book - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The book data for this result.
book - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The book data for this result.
book() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the book data.
book(Book) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the book data.
Book - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a book in search results, containing detailed information about the book such as its title, authors, publication details, and ratings.
Book(String, List<Person>, String, Price, Integer, Person, Rating) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Book
Creates an instance of a Book record class.
BRAVE_SUBSCRIPTION_PROPERTY - Static variable in class net.ygbstudio.jbrave.core.local.LocalEnvironment
Name of the properties-file key that holds the Brave subscription token.
BRAVE_SUBSCRIPTION_TOKEN - Static variable in class net.ygbstudio.jbrave.core.local.LocalEnvironment
Name of the environment variable that holds the Brave subscription token.
BraveAPIConstant - Interface in net.ygbstudio.jbrave.core.domain
Interface for constants that are used in Brave API.
BraveApiException - Exception Class in net.ygbstudio.jbrave.core.exceptions
BraveApiException exists to alert users about known errors that require user attention.
BraveApiException(String) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.BraveApiException
Creates a new instance with the given detail message.
BraveApiException(Supplier<String>) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.BraveApiException
Creates a new instance with a lazily-evaluated detail message.
BraveClientException - Exception Class in net.ygbstudio.jbrave.core.exceptions
This exception is thrown when there is an error in a request involving the Brave Search API internal client.
BraveClientException(String) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.BraveClientException
Creates a new instance with the given detail message.
BraveClientException(String, Throwable) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.BraveClientException
Creates a new instance with the given detail message and cause.
BraveClientException(Supplier<String>) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.BraveClientException
Creates a new instance with a lazily-evaluated detail message.
BraveClientException(Supplier<String>, Throwable) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.BraveClientException
Creates a new instance with a lazily-evaluated detail message and a cause.
BraveErrorCode - Enum Class in net.ygbstudio.jbrave.core.model
Enumeration of Brave API error codes.
BraveExecutionGate - Class in net.ygbstudio.jbrave.core.executors
Serializes execution of HTTP requests against a shared Brave API execution context.
BraveExecutionGate() - Constructor for class net.ygbstudio.jbrave.core.executors.BraveExecutionGate
Creates a new execution gate backed by a single shared BraveRequestExecutor.
BraveGogglesIdentifierException - Exception Class in net.ygbstudio.jbrave.core.exceptions
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.
BraveGogglesIdentifierException(String) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.BraveGogglesIdentifierException
Creates a new instance with the given detail message.
BraveGogglesIdentifierException(Supplier<String>) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.BraveGogglesIdentifierException
Creates a new instance with a lazily-evaluated detail message.
BraveHeaders - Enum Class in net.ygbstudio.jbrave.core.model
Enumeration of possible Brave Search API headers.
BraveImageQuery - Class in net.ygbstudio.jbrave.api.builders
A builder for constructing Brave Image Search API queries.
BraveLocalEnvironmentException - Exception Class in net.ygbstudio.jbrave.core.exceptions
Exception thrown when there is an error related to the local environment.
BraveLocalEnvironmentException(String) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.BraveLocalEnvironmentException
Creates a new instance with the given detail message.
BraveLocalEnvironmentException(Supplier<String>) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.BraveLocalEnvironmentException
Creates a new instance with a lazily-evaluated detail message.
BraveNewsQuery - Class in net.ygbstudio.jbrave.api.builders
A builder for constructing Brave News API queries.
BraveQueryBuilder<T,E> - Interface in net.ygbstudio.jbrave.api.builders
An interface for Brave API query builders, implemented by all builders that build Brave API queries.
BraveRequestExecutor - Class in net.ygbstudio.jbrave.core.executors
The BraveRequestExecutor class is a concrete implementation of the AbstractRequestExecutor abstract class.
BraveResource - Enum Class in net.ygbstudio.jbrave.core.domain.verticals
Enum representing the different search resources of the Brave API.
BraveSearchHeader - Record Class in net.ygbstudio.jbrave.core.model
A record class representing a Brave Search API header.
BraveSearchHeader(String, String) - Constructor for record class net.ygbstudio.jbrave.core.model.BraveSearchHeader
Creates an instance of a BraveSearchHeader record class.
BraveSearchOperator - Enum Class in net.ygbstudio.jbrave.core.model
Enumeration of the search operators supported by the Brave Search API.
BraveSearchOption<V> - Record Class in net.ygbstudio.jbrave.core.model
A search option that can be used in the search methods.
BraveSearchOption(SearchOption, V) - Constructor for record class net.ygbstudio.jbrave.core.model.BraveSearchOption
Creates an instance of a BraveSearchOption record class.
BraveSpellcheckQuery - Class in net.ygbstudio.jbrave.api.builders
A builder for constructing Brave Spellcheck API queries.
BraveSuggestQuery - Class in net.ygbstudio.jbrave.api.builders
A builder for constructing Brave Suggest API queries.
BraveVerticalRequest - Interface in net.ygbstudio.jbrave.core.builders
Represents a Brave vertical search request.
BraveVerticalSearchRequest - Class in net.ygbstudio.jbrave.core.builders
Builds a Brave vertical search request.
BraveVideoQuery - Class in net.ygbstudio.jbrave.api.builders
A builder for constructing Brave Video API queries.
BraveWebQuery - Class in net.ygbstudio.jbrave.api.builders
A builder for constructing Brave Web search queries.
BraveWebRequest - Interface in net.ygbstudio.jbrave.core.builders
Represents a Brave web search request.
BraveWebSearchRequest - Class in net.ygbstudio.jbrave.core.builders
Builds a Brave web search request.
BRAZIL - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Brazil.
BRAZIL - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Brazil.
breaking() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult
Returns whether the news is breaking.
breaking(Boolean) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult.Builder
Sets whether the news is breaking.
build() - Method in class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder
Builds the request using the current state of the builder.
build() - Method in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Builds the final URL query.
build() - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Constructs the search operator string by concatenating the values of the builder with the corresponding operators.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel.Builder
Builds a new ApiErrorModel from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Builds a new AbstractGraphInfobox from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.DiscussionResult.Builder
Builds a new DiscussionResult from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.EntityInfobox.Builder
Builds a new EntityInfobox from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.GenericInfobox.Builder
Builds a new GenericInfobox from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxPlace.Builder
Builds a new InfoboxPlace from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation.Builder
Builds a new InfoboxWithLocation from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Builds a new LocationResult from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationWebResult.Builder
Builds a new LocationWebResult from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult.Builder
Builds a new NewsResult from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.QAInfobox.Builder
Builds a new QAInfobox from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result.Builder
Builds a new Result from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Builds a new SearchResult from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.ContactPoint.Builder
 
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Organization.Builder
Builds an Organization instance.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Person.Builder
Builds a new Person instance.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing.Builder
Builds a new Thing from the current builder state.
build() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult.Builder
Builds a new VideoResult from the current builder state.
builder() - Static method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Creates a new instance of BraveImageQuery.
builder() - Static method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Creates a new instance of BraveNewsQuery.
builder() - Static method in class net.ygbstudio.jbrave.api.builders.BraveSpellcheckQuery
Creates a new instance of BraveSpellcheckQuery.
builder() - Static method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
Creates a new instance of BraveSuggestQuery.
builder() - Static method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Creates a new instance of BraveVideoQuery
builder() - Static method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Creates a new instance of BraveWebQuery with an empty URL query.
builder() - Static method in class net.ygbstudio.jbrave.core.builders.BraveVerticalSearchRequest
Creates a new instance of BraveVerticalSearchRequest.
builder() - Static method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Creates a new instance of BraveWebSearchRequest.
builder() - Static method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Creates a new instance of the SearchOperatorBuilder class.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.DiscussionResult.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.EntityInfobox.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.GenericInfobox.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxPlace.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.LocationWebResult.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.QAInfobox.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.Result.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.thing.ContactPoint.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.thing.Organization.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.thing.Person.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing.Builder
Creates a new builder with all fields unset.
Builder() - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult.Builder
Creates a new builder with all fields unset.
buildParam() - Method in record class net.ygbstudio.jbrave.core.model.BraveSearchOption
Builds the URL parameter for this search option.
buildParam() - Method in interface net.ygbstudio.jbrave.core.model.SearchOptionCarrier
Builds the URL-ready parameter for this search option to be joined.
BULGARIAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Bulgarian.
ButtonResult - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents an interactive button in search results, providing users with actions they can take directly from the search results.
ButtonResult(String, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.ButtonResult
Creates an instance of a ButtonResult record class.
buttons() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DeepResult
Returns the value of the buttons record component.

C

CACHE_CONTROL - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
Cache-Control request header; send no-cache to prevent caching.
callbackKey() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.RichCallbackHint
Returns the value of the callbackKey record component.
calories() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the calories record component.
CANADA - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Canada.
CANADA_ENGLISH - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Canada (English).
CANADA_FRENCH - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Canada (French).
CATALAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Catalan.
categories(List<String>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the categories.
category - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The infobox category.
category() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns the value of the category record component.
category(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the infobox category.
CHILE - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Chile.
CHILE - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Chile.
CHINA - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
China.
CHINA - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
China.
CHINESE_SIMPLIFIED - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Chinese (Simplified).
CHINESE_TRADITIONAL - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Chinese (Traditional).
city() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the city record component.
CITY - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
Generic name of the client's city.
cleaned() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Query
Returns the value of the cleaned record component.
cleaned() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the cleaned record component.
cleanedQuery() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.SearchOperators
Returns the value of the cleanedQuery record component.
clear() - Method in class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder
Clears the request builder, resetting it to its initial state.
clear() - Method in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Clears the URL query by resetting the internal builder to an empty state.
clear() - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Clears the search operator builder by removing all the operators and their corresponding values.
clearRetainURI() - Method in class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder
Clears the request builder, resetting it to its initial state while retaining the currently set URI.
client - Variable in class net.ygbstudio.jbrave.core.executors.AbstractRequestExecutor
The shared, long-lived HttpClient used to execute all requests through this executor.
ClientInfo - Class in net.ygbstudio.jbrave.core.local
Represents the client information.
ClientProvidedOption - Interface in net.ygbstudio.jbrave.core.domain
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.
closes() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DayOpeningHours
Returns the value of the closes record component.
cluster - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The cluster of results this result belongs to.
cluster - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The cluster of results this result belongs to.
cluster() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the result cluster.
cluster(List<Result>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the result cluster.
clusterType - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The type of cluster this result belongs to.
clusterType - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The type of cluster this result belongs to.
clusterType() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the cluster type.
clusterType(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the cluster type.
code() - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel
Returns the error code.
code(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel.Builder
Sets the error code, converting the raw value to the BraveErrorCode enum.
codeRepository() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Returns the value of the codeRepository record component.
component() - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.ErrorMeta
Returns the value of the component record component.
confidence() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageResult
Returns the value of the confidence record component.
configureMapper() - Static method in class net.ygbstudio.jbrave.core.utils.JsonSupport
Configures and returns a pre-configured ObjectMapper instance.
contact(Contact) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the contact information.
Contact - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents contact information for an entity in search results, such as a business, organization, or service provider.
Contact(String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Contact
Creates an instance of a Contact record class.
ContactPoint - Class in net.ygbstudio.jbrave.core.domain.dto.result.thing
Represents a contact point for an organization or person.
ContactPoint.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result.thing
Builder for ContactPoint instances.
contactPoints(List<ContactPoint>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Organization.Builder
Sets the contact points for the organization.
contentSize() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ImageProperties
Returns the value of the contentSize record component.
contentType - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The content type of this result.
contentType - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The content type of this result.
contentType() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the content type.
contentType(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the content type.
Context - Record Class in net.ygbstudio.jbrave.core.domain.dto.error
A Data Transfer Object representing the context of a response error object.
Context(String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.error.Context
Creates an instance of a Context record class.
cookTime() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the cookTime record component.
coordinates(List<Double>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation.Builder
Sets the coordinates.
coordinates(List<Double>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the coordinates.
count(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Adds the count option to the URL query.
count(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds the count option to the URL query.
count(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
Adds the count option to the URL query.
count(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Adds the count option to the URL query.
count(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds the count option to the URL query.
count(int) - Static method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Create a new instance of BraveSearchOption with SearchOptions.COUNT and the given value.
COUNT - Enum constant in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Number of results to return.
country() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the country record component.
country() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PostalAddress
Returns the value of the country record component.
country(T) - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Adds the country option to the URL query.
country(T) - Method in class net.ygbstudio.jbrave.api.builders.BraveSpellcheckQuery
Adds the country option to the URL query.
country(T) - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
Adds the country option to the URL query.
country(T) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds the country option to the URL query.
Country - Enum Class in net.ygbstudio.jbrave.api.options
Enumeration representing a country supported by the Brave Search API.
COUNTRY - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
Two-letter country code (ISO 3166-1 alpha-2).
CountryIdentifier - Interface in net.ygbstudio.jbrave.core.domain.provided
An interface representing a country identifier.
creativeWork - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The creative work data for this result.
creativeWork - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The creative work data for this result.
creativeWork() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the creative work data.
creativeWork(CreativeWork) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the creative work data.
CreativeWork - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
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.
CreativeWork(String, Thumbnail, Rating) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.CreativeWork
Creates an instance of a CreativeWork record class.
creator() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.VideoData
Returns the value of the creator record component.
CROATIAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Croatian.
ctx() - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.Error
Returns the value of the ctx record component.
currentDay() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.OpeningHours
Returns the value of the currentDay record component.
customLocationLabel() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the customLocationLabel record component.
CZECH - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Czech.

D

DANISH - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Danish.
data(ForumData) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.DiscussionResult.Builder
Sets the forum data.
data(QAPage) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.QAInfobox.Builder
Sets the Q&A page data.
DataProvider - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.profile
Represents a data provider in search results.
DataProvider(String, String, String, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.profile.DataProvider
Creates an instance of a DataProvider record class.
date() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Article
Returns the value of the date record component.
date() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Book
Returns the value of the date record component.
date() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.TripAdvisorReview
Returns the value of the date record component.
datePublished() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Returns the value of the datePublished record component.
DayOpeningHours - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents the opening hours for a specific day of the week for a business or location.
DayOpeningHours(String, String, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.DayOpeningHours
Creates an instance of a DayOpeningHours record class.
days() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.OpeningHours
Returns the value of the days record component.
decodeByteArray(byte[], Charset) - Method in class net.ygbstudio.jbrave.core.executors.AbstractRequestExecutor
Decodes a byte array into a String using the given character set.
decodeByteHttpResponse(HttpResponse<byte[]>) - Method in class net.ygbstudio.jbrave.core.executors.AbstractRequestExecutor
Decodes an HttpResponse with a byte[] body into a String.
decompressGunzip(byte[]) - Method in class net.ygbstudio.jbrave.core.executors.AbstractRequestExecutor
Decompresses a GZIP-compressed byte array.
DeepResult - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a comprehensive set of information about a search result in the Brave Search API.
DeepResult(List<NewsResult>, List<ButtonResult>, List<VideoResult>, List<Image>) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.DeepResult
Creates an instance of a DeepResult record class.
deepResults - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Deep results associated with this result.
deepResults - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Deep results associated with this result.
deepResults() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the deep results.
deepResults(DeepResult) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the deep results.
delayedOperators - Variable in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Buffer holding search operators deferred until the query term is present.
DENMARK - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Denmark.
DENMARK - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Denmark.
description - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.Result
The result description.
description() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Returns the result description.
description() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.SuggestResult
Returns the value of the description record component.
description() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.LocationDescription
Returns the value of the description record component.
description() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Returns the value of the description record component.
description() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns the value of the description record component.
description() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the description record component.
description() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Review
Returns the value of the description record component.
description() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.TripAdvisorReview
Returns the value of the description record component.
description(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result.Builder
Sets the result description.
detail() - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel
Returns the error detail message.
detail(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel.Builder
Sets the error detail message.
directors() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Returns the value of the directors record component.
DiscussionResult - Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents a discussion result in search results.
DiscussionResult(DiscussionResult.Builder) - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.DiscussionResult
Creates a new discussion result from the given builder.
DiscussionResult.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result
Builder for DiscussionResult instances.
discussions() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns the value of the discussions record component.
Discussions - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.search
Represents a record of discussion information in search results.
Discussions(String, List<DiscussionResult>, Boolean) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.search.Discussions
Creates an instance of a Discussions record class.
DISCUSSIONS - Enum constant in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
Include forum and discussion results.
displayAddress() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PostalAddress
Returns the value of the displayAddress record component.
distance - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The distance associated with the infobox.
distance(Unit) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the distance associated with the infobox.
distance(Unit) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the distance.
domain() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the domain record component.
downvoteCount() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Answer
Returns the value of the downvoteCount record component.
duration() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.VideoData
Returns the value of the duration record component.
duration() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Returns the value of the duration record component.
DUTCH - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Dutch.

E

email() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Contact
Returns the value of the email record component.
email(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.ContactPoint.Builder
Sets the email address for the contact point.
email(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Person.Builder
Sets the email address of the person.
EmptyTaskListException - Exception Class in net.ygbstudio.jbrave.core.exceptions
Exception thrown when a task list is empty and the client requested an asynchronous execution.
EmptyTaskListException(String) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.EmptyTaskListException
Creates a new instance with the given detail message.
EmptyTaskListException(Supplier<String>) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.EmptyTaskListException
Creates a new instance with a lazily-evaluated detail message.
ENABLE_RICH_CALLBACK - Enum constant in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Whether to enable rich callback support.
enableOperators() - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Adds the operators option to the URL query.
enableOperators() - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds the operators option to the URL query.
enableOperators(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds the operators option to the URL query.
enableRichCallback(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds the enable_rich_callback option to the URL query.
enableRichCallback(boolean) - Static method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Creates a new instance of BraveSearchOption with SearchOptions.ENABLE_RICH_CALLBACK and the given value.
ENGLISH - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
English.
ENGLISH_UNITED_KINGDOM - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
English (United Kingdom).
EntityInfobox - Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents an entity infobox in search results.
EntityInfobox.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result
Builder for EntityInfobox instances.
equals(Object) - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimit
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitPolicy
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitRemaining
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitReset
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.api.response.ErrorResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.api.response.ImageSearchApiResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.api.response.NewsSearchApiResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.api.response.RateLimitResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.api.response.SpellcheckSearchApiResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.api.response.SuggestSearchApiResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.api.response.VideoSearchApiResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel
 
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.Context
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.Error
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.ErrorMeta
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.Extra
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageQuery
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageThumbnail
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.Properties
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.MetaUrl
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.OriginalQuery
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.Query
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.DiscussionResult
 
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.EntityInfobox
 
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.GenericInfobox
 
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxPlace
 
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation
 
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
 
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationWebResult
 
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult
 
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.DataProvider
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.InfoboxProfile
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.Profile
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.QAInfobox
 
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Discussions
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.FAQ
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.GraphInfobox
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Locations
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.MixedResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.News
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.RichCallbackInfo
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Search
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Summarizer
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Videos
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
 
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.SpellCheckResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.SuggestResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.ContactPoint
 
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Organization
 
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Person
 
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.VideoData
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult
 
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.Thumbnail
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Action
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Answer
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Article
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Book
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ButtonResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Contact
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.CreativeWork
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DayOpeningHours
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DeepResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ForumData
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.HowTo
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Image
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ImageProperties
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Language
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.LocationDescription
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MusicRecording
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Offer
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.OpeningHours
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PictureResults
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PostalAddress
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Price
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ProductPair
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.QA
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.QAPage
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Rating
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ResultReference
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Review
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Reviews
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.RichCallbackHint
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.SearchOperators
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.TripAdvisorReview
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Unit
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.model.BraveSearchHeader
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.jbrave.core.model.BraveSearchOption
Indicates whether some other object is "equal to" this one.
error() - Method in record class net.ygbstudio.jbrave.api.response.ErrorResponse
Returns the value of the error record component.
Error - Record Class in net.ygbstudio.jbrave.core.domain.dto.error
A Data Transfer Object representing error information of a response object in the Brave Search API.
Error(String, List<String>, String, Context) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.error.Error
Creates an instance of a Error record class.
ErrorMeta - Record Class in net.ygbstudio.jbrave.core.domain.dto.error
A metaobject containing non-standard meta-information about the component affected by an error in the Brave Search API.
ErrorMeta(String, List<Error>) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.error.ErrorMeta
Creates an instance of a ErrorMeta record class.
ErrorResponse - Record Class in net.ygbstudio.jbrave.api.response
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.
ErrorResponse(String, ApiErrorModel, Integer) - Constructor for record class net.ygbstudio.jbrave.api.response.ErrorResponse
Creates an instance of a ErrorResponse record class.
errors() - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.ErrorMeta
Returns the value of the errors record component.
ESTONIAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Estonian.
exactMatch(String) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds double quotes to the corresponding value (exact search term match) and adds it to the builder.
exclude(String) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds a "-" operator with its corresponding value to the builder.
execute() - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Executes the request and stores the response.
execute() - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Executes the request and stores the response.
execute() - Method in interface net.ygbstudio.jbrave.api.builders.BraveQueryBuilder
Executes the request and stores the response.
execute() - Method in class net.ygbstudio.jbrave.api.builders.BraveSpellcheckQuery
 
execute() - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
 
execute() - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
 
execute() - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
 
execute(HttpRequest) - Method in class net.ygbstudio.jbrave.core.executors.AbstractRequestExecutor
Executes the given HTTP request and returns a decoded response.
expected() - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.Context
Returns the value of the expected record component.
ext(String) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds an "ext" operator and its corresponding value to the builder.
EXT - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
File extension search operator.
extra() - Method in record class net.ygbstudio.jbrave.api.response.ImageSearchApiResponse
Returns the value of the extra record component.
extra() - Method in record class net.ygbstudio.jbrave.api.response.VideoSearchApiResponse
Returns the value of the extra record component.
Extra - Record Class in net.ygbstudio.jbrave.core.domain.dto
Represents additional information in search results.
Extra(Boolean) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.Extra
Creates an instance of a Extra record class.
EXTRA_SNIPPETS - Enum constant in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Whether to include extra snippets in the results.
extract(HttpHeaders) - Method in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
Extracts a list of header values of the specified header from the HTTP headers.
extract(HttpHeaders, Function<String, R>) - Method in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
Extracts the first value of the specified header from the HTTP headers and transforms it using the provided function.
extraSnippets - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Extra snippets for this result.
extraSnippets - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Extra snippets for this result.
extraSnippets() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult
Returns the extra snippets.
extraSnippets() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the extra snippets.
extraSnippets(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds the extra_snippets option to the URL query.
extraSnippets(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds the extra_snippets option to the URL query.
extraSnippets(boolean) - Static method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Create a new instance of BraveSearchOption with SearchOptions.EXTRA_SNIPPETS and the given value.
extraSnippets(List<String>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult.Builder
Sets the extra snippets.
extraSnippets(List<String>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the extra snippets.

F

familyFriendly - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Whether the result is family friendly.
familyFriendly() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Returns whether the result is family friendly.
familyFriendly() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Search
Returns the value of the familyFriendly record component.
familyFriendly(Boolean) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result.Builder
Sets whether the result is family friendly.
faq - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The FAQ data for this result.
faq - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The FAQ data for this result.
faq() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns the value of the faq record component.
faq() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the FAQ data.
faq(FAQ) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the FAQ data.
FAQ - Enum constant in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
Include frequently-asked-questions results.
FAQ - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.search
Represents Frequently Asked Questions (FAQs) information in search results.
FAQ(String, List<QA>) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.search.FAQ
Creates an instance of a FAQ record class.
favicon() - Method in record class net.ygbstudio.jbrave.core.domain.dto.MetaUrl
Returns the value of the favicon record component.
favicon() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the favicon record component.
fetchedContentTimestamp - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.Result
The fetched content timestamp.
fetchedContentTimestamp() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Returns the fetched content timestamp.
fetchedContentTimestamp(Integer) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result.Builder
Sets the fetched content timestamp.
filetype(String) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds a "filetype" operator and its corresponding value to the builder.
FILETYPE - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Filetype search operator.
FINLAND - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Finland.
FINLAND - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Finland.
FINNISH - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Finnish.
forks() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Returns the value of the forks record component.
format() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ImageProperties
Returns the value of the format record component.
ForumData - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents forum data in search results, containing information about forum posts and discussions that are relevant to the search query.
ForumData(String, Integer, String, String, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.ForumData
Creates an instance of a ForumData record class.
forumName() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ForumData
Returns the value of the forumName record component.
foundInUrls(List<String>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.GenericInfobox.Builder
Sets the URLs where this infobox was found.
FRANCE - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
France.
FRANCE - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
France.
FRENCH - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
French.
freshness(LocalDate, LocalDate) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds a freshness option to the URL query representing a date range between the given start and end dates.
freshness(LocalDate, LocalDate) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Adds a freshness option to the URL query representing a date range.
freshness(LocalDate, LocalDate) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds a freshness option to the URL query representing a date range.
freshness(Freshness) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds a freshness option to the URL query using an existing Freshness instance.
freshness(Freshness) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Adds a freshness option to the URL query using an existing Freshness instance.
freshness(Freshness) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds a freshness option to the URL query using an existing Freshness instance.
Freshness - Enum Class in net.ygbstudio.jbrave.api.filters
An enumeration representing freshness filters for the API requests.
FRESHNESS - Enum constant in enum class net.ygbstudio.jbrave.core.domain.modes.SearchFilterMode
Freshness filter mode (freshness URL parameter).
from(File) - Static method in record class net.ygbstudio.jbrave.api.response.ErrorResponse
Deserializes a ErrorResponse from a JSON File.
from(File) - Static method in record class net.ygbstudio.jbrave.api.response.ImageSearchApiResponse
Deserializes a ImageSearchApiResponse from a JSON File.
from(File) - Static method in record class net.ygbstudio.jbrave.api.response.NewsSearchApiResponse
Deserializes a NewsSearchApiResponse from a JSON File.
from(File) - Static method in record class net.ygbstudio.jbrave.api.response.SpellcheckSearchApiResponse
Deserializes a SpellcheckSearchApiResponse from a JSON File.
from(File) - Static method in record class net.ygbstudio.jbrave.api.response.SuggestSearchApiResponse
Deserializes a SuggestSearchApiResponse from a JSON File.
from(File) - Static method in record class net.ygbstudio.jbrave.api.response.VideoSearchApiResponse
Deserializes a VideoSearchApiResponse from a JSON File.
from(File) - Static method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Deserializes a WebSearchApiResponse from a JSON File.
from(File, Class<T>) - Static method in interface net.ygbstudio.jbrave.api.response.ApiResponse
Deserializes an API response from a JSON file.
from(Reader) - Static method in record class net.ygbstudio.jbrave.api.response.ErrorResponse
Deserializes a ErrorResponse from a JSON Reader.
from(Reader) - Static method in record class net.ygbstudio.jbrave.api.response.ImageSearchApiResponse
Deserializes a ImageSearchApiResponse from a JSON Reader.
from(Reader) - Static method in record class net.ygbstudio.jbrave.api.response.NewsSearchApiResponse
Deserializes a NewsSearchApiResponse from a JSON Reader.
from(Reader) - Static method in record class net.ygbstudio.jbrave.api.response.SpellcheckSearchApiResponse
Deserializes a SpellcheckSearchApiResponse from a JSON Reader.
from(Reader) - Static method in record class net.ygbstudio.jbrave.api.response.SuggestSearchApiResponse
Deserializes a SuggestSearchApiResponse from a JSON Reader.
from(Reader) - Static method in record class net.ygbstudio.jbrave.api.response.VideoSearchApiResponse
Deserializes a VideoSearchApiResponse from a JSON Reader.
from(Reader) - Static method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Deserializes a WebSearchApiResponse from a JSON Reader.
from(Reader, Class<T>) - Static method in interface net.ygbstudio.jbrave.api.response.ApiResponse
Deserializes an API response from a JSON reader.
from(String) - Static method in record class net.ygbstudio.jbrave.api.response.ErrorResponse
Deserializes a ErrorResponse from a JSON String.
from(String) - Static method in record class net.ygbstudio.jbrave.api.response.ImageSearchApiResponse
Deserializes a ImageSearchApiResponse from a JSON String.
from(String) - Static method in record class net.ygbstudio.jbrave.api.response.NewsSearchApiResponse
Deserializes a NewsSearchApiResponse from a JSON String.
from(String) - Static method in record class net.ygbstudio.jbrave.api.response.SpellcheckSearchApiResponse
Deserializes a SpellcheckSearchApiResponse from a JSON String.
from(String) - Static method in record class net.ygbstudio.jbrave.api.response.SuggestSearchApiResponse
Deserializes a SuggestSearchApiResponse from a JSON String.
from(String) - Static method in record class net.ygbstudio.jbrave.api.response.VideoSearchApiResponse
Deserializes a VideoSearchApiResponse from a JSON String.
from(String) - Static method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Deserializes a WebSearchApiResponse from a JSON String.
from(String, Class<T>) - Static method in interface net.ygbstudio.jbrave.api.response.ApiResponse
Deserializes an API response from a JSON string.
from(HttpResponse<String>) - Static method in record class net.ygbstudio.jbrave.api.response.ErrorResponse
Deserializes a ErrorResponse from the body of an HTTP response.
from(HttpResponse<String>) - Static method in record class net.ygbstudio.jbrave.api.response.ImageSearchApiResponse
Deserializes a ImageSearchApiResponse from the body of an HTTP response.
from(HttpResponse<String>) - Static method in record class net.ygbstudio.jbrave.api.response.NewsSearchApiResponse
Deserializes a NewsSearchApiResponse from the body of an HTTP response.
from(HttpResponse<String>) - Static method in record class net.ygbstudio.jbrave.api.response.SpellcheckSearchApiResponse
Deserializes a SpellcheckSearchApiResponse from the body of an HTTP response.
from(HttpResponse<String>) - Static method in record class net.ygbstudio.jbrave.api.response.SuggestSearchApiResponse
Deserializes a SuggestSearchApiResponse from the body of an HTTP response.
from(HttpResponse<String>) - Static method in record class net.ygbstudio.jbrave.api.response.VideoSearchApiResponse
Deserializes a VideoSearchApiResponse from the body of an HTTP response.
from(HttpResponse<String>) - Static method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Deserializes a WebSearchApiResponse from the body of an HTTP response.
from(HttpResponse<String>, Class<T>) - Static method in interface net.ygbstudio.jbrave.api.response.ApiResponse
Deserializes an API response from the body of an HTTP response.
from(HttpResponse<T>) - Static method in record class net.ygbstudio.jbrave.api.rate.XRateLimit
Extracts the rate limit from the HTTP Response.
from(HttpResponse<T>) - Static method in record class net.ygbstudio.jbrave.api.rate.XRateLimitPolicy
Extracts the rate limit policy from the HTTP Response.
from(HttpResponse<T>) - Static method in record class net.ygbstudio.jbrave.api.rate.XRateLimitRemaining
Extracts the rate limit remaining from the HTTP Response.
from(HttpResponse<T>) - Static method in record class net.ygbstudio.jbrave.api.rate.XRateLimitReset
Extracts the rate limit reset from the HTTP Response.
from(HttpResponse<T>) - Static method in record class net.ygbstudio.jbrave.api.response.RateLimitResponse
Creates a RateLimitResponse object from the headers of an HttpResponse.
from(Set<ResultFilter>) - Static method in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
Joins the given result filter set into a comma-delimited string and returns it as a SearchOptionCarrier.
fromEnvironment() - Static method in class net.ygbstudio.jbrave.core.local.ClientInfo
Create a new instance of ClientInfo from the preconfigured environment variable BRAVE_SUBSCRIPTION_TOKEN
fromEnvironment(String) - Static method in class net.ygbstudio.jbrave.core.local.ClientInfo
Create a new instance of ClientInfo from environment variable.
fromHeaderMap(Map<K, String>) - Static method in record class net.ygbstudio.jbrave.core.model.BraveSearchHeader
Returns a stream of BraveSearchHeader objects created from the entries of the given map.
fromProperties(String) - Static method in class net.ygbstudio.jbrave.core.local.ClientInfo
Create a new instance of ClientInfo from properties file with the preconfigured property name brave.subscriptionToken
fromProperties(String, String) - Static method in class net.ygbstudio.jbrave.core.local.ClientInfo
Create a new instance of ClientInfo from properties file.
fullName() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DayOpeningHours
Returns the value of the fullName record component.

G

GALICIAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Galician.
GenericInfobox - Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents a generic infobox in search results.
GenericInfobox.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result
Builder for GenericInfobox instances.
genre() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Returns the value of the genre record component.
GERMAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
German.
GERMANY - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Germany.
GERMANY - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Germany.
getAction() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the action.
getAttributes() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the infobox attributes as a list of key-value pairs.
getCategories() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the categories.
getCategory() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the infobox category.
getContact() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the contact information.
getContactPoints() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Organization
Gets the contact points for the organization.
getCoordinates() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation
Returns the coordinates.
getCoordinates() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the coordinates.
getData() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.DiscussionResult
Returns the forum data.
getData() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.QAInfobox
Returns the Q&A page data.
getDistance() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the distance associated with the infobox.
getDistance() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the distance.
getEitherPOJO() - Method in interface net.ygbstudio.jbrave.api.builders.BraveQueryBuilder
Converts the current response to a POJO instance of the builder's response type E if the status code of the response is 200.
getEmail() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.ContactPoint
The email address for the contact point.
getEmail() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Person
Gets the email address of the person.
getErrorPOJO() - Method in interface net.ygbstudio.jbrave.api.builders.BraveQueryBuilder
Converts the current response to a POJO instance of ErrorResponse if the status code of the response is not 200.
getFoundInUrls() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.GenericInfobox
Returns the URLs where this infobox was found.
getHttpResponse() - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Returns the current HTTP response as an Optional.
getHttpResponse() - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Returns the current HTTP response as an Optional.
getHttpResponse() - Method in interface net.ygbstudio.jbrave.api.builders.BraveQueryBuilder
Returns the current HTTP response as an Optional.
getHttpResponse() - Method in class net.ygbstudio.jbrave.api.builders.BraveSpellcheckQuery
Returns the current HTTP response as an Optional.
getHttpResponse() - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
Returns the current HTTP response as an Optional.
getHttpResponse() - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Returns the current HTTP response as an Optional.
getHttpResponse() - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Returns the current HTTP response as an Optional.
getIconCategory() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the icon category.
getId() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the location identifier.
getImages() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the infobox images.
getInstance() - Static method in class net.ygbstudio.jbrave.core.executors.BraveRequestExecutor
Returns a new instance of BraveRequestExecutor.
getIsLocation() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation
Returns whether this is a location.
getLabel() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the infobox label.
getLocation() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxPlace
Returns the location.
getLongDesc() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the long description of the infobox.
getMapper() - Static method in class net.ygbstudio.jbrave.core.utils.JsonSupport
Returns the configured ObjectMapper instance that is reused throughout the application.
getMetaUrl() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationWebResult
Returns the meta URL.
getMetaUrl() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.QAInfobox
Returns the meta URL.
getMovie() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the movie data associated with the infobox.
getName() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing
Returns the thing name.
getOpeningHours() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the opening hours.
getPictures() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the pictures.
getPOJO() - Method in interface net.ygbstudio.jbrave.api.builders.BraveQueryBuilder
Converts the current response to a POJO instance of BraveQueryBuilder if the status code of the response is 200.
getPosition() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the infobox position.
getPostalAddress() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the postal address.
getPriceRange() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the price range.
getProfiles() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the graph infobox profiles.
getProfiles() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the profiles.
getProviders() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the infobox data providers.
getProviderUrl() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the provider URL.
getRateLimitPolicy() - Method in interface net.ygbstudio.jbrave.api.builders.BraveQueryBuilder
Returns the rate limit policy from the HTTP response.
getRateLimitRemaining() - Method in interface net.ygbstudio.jbrave.api.builders.BraveQueryBuilder
Returns the rate limit remaining from the HTTP response.
getRateLimits() - Method in interface net.ygbstudio.jbrave.api.builders.BraveQueryBuilder
Returns the rate limit from the HTTP response.
getRating() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the rating.
getRatings() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the infobox ratings.
getResponseType() - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
 
getResponseType() - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
 
getResponseType() - Method in interface net.ygbstudio.jbrave.api.builders.BraveQueryBuilder
Returns the type of the API response.
getResponseType() - Method in class net.ygbstudio.jbrave.api.builders.BraveSpellcheckQuery
 
getResponseType() - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
 
getResponseType() - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
 
getResponseType() - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
 
getReviews() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the reviews.
getServesCuisine() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the served cuisines.
getSubType() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.EntityInfobox
Returns the entity subtype.
getSubType() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.GenericInfobox
Returns the infobox subtype.
getSubType() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxPlace
Returns the place subtype.
getSubType() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation
Returns the infobox subtype.
getSubType() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.QAInfobox
Returns the infobox subtype.
getTelephone() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.ContactPoint
The telephone number for the contact point.
getThumbnail() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the infobox thumbnail.
getThumbnail() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the thumbnail.
getThumbnail() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing
Returns the thumbnail.
getTimezone() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the timezone.
getTimezoneOffset() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the timezone offset.
getType() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the infobox type.
getType() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the location type.
getType() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing
Returns the thing type.
getUrl() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing
Returns the thing URL.
getWebsiteUrl() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
Returns the website URL associated with the infobox.
getZoomLevel() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation
Returns the zoom level.
getZoomLevel() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Returns the zoom level.
goggles(URI) - Static method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Creates a new instance of BraveSearchOption with SearchOptions.GOGGLES and the given value.
goggles(URI) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds a goggles URL option to the URL query.
goggles(URI) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds a goggles URL option to the URL query.
GOGGLES - Enum constant in enum class net.ygbstudio.jbrave.core.model.SearchOptions
URI of a goggles resource to apply to the query.
GraphInfobox - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.search
Represents graph infobox information in search results.
GraphInfobox(String, List<AbstractGraphInfobox>) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.search.GraphInfobox
Creates an instance of a GraphInfobox record class.
GraphInfoboxProfile - Interface in net.ygbstudio.jbrave.core.domain.dto.result.profile
Marker interface for graph infobox profiles in search results.
GREECE - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Greece.
GREECE - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Greece.
GREEK - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Greek.
gtin() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns the value of the gtin record component.
gtin12() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns the value of the gtin12 record component.
gtin13() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns the value of the gtin13 record component.
gtin14() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns the value of the gtin14 record component.
gtin8() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns the value of the gtin8 record component.
GUJARATI - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Gujarati.

H

hasExecuted() - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Checks if the request has been executed.
hasExecuted() - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Checks if the request has been executed.
hasExecuted() - Method in interface net.ygbstudio.jbrave.api.builders.BraveQueryBuilder
Checks if the request has been executed.
hasExecuted() - Method in class net.ygbstudio.jbrave.api.builders.BraveSpellcheckQuery
 
hasExecuted() - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
 
hasExecuted() - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
 
hasExecuted() - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
 
hashCode() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimit
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitPolicy
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitRemaining
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitReset
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.api.response.ErrorResponse
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.api.response.ImageSearchApiResponse
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.api.response.NewsSearchApiResponse
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.api.response.RateLimitResponse
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.api.response.SpellcheckSearchApiResponse
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.api.response.SuggestSearchApiResponse
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.api.response.VideoSearchApiResponse
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns a hash code value for this object.
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel
 
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.Context
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.Error
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.ErrorMeta
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Extra
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageQuery
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageResult
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageThumbnail
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.Properties
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.MetaUrl
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.OriginalQuery
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Query
Returns a hash code value for this object.
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.DiscussionResult
 
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.EntityInfobox
 
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.GenericInfobox
 
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxPlace
 
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation
 
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
 
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationWebResult
 
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult
 
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.DataProvider
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.InfoboxProfile
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.Profile
Returns a hash code value for this object.
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.QAInfobox
 
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Discussions
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.FAQ
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.GraphInfobox
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Locations
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.MixedResponse
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.News
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.RichCallbackInfo
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Search
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Summarizer
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Videos
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns a hash code value for this object.
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
 
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.SpellCheckResult
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.SuggestResult
Returns a hash code value for this object.
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.ContactPoint
 
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Organization
 
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Person
 
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.VideoData
Returns a hash code value for this object.
hashCode() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult
 
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Thumbnail
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Action
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Answer
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Article
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Book
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ButtonResult
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Contact
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.CreativeWork
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DayOpeningHours
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DeepResult
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ForumData
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.HowTo
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Image
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ImageProperties
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Language
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.LocationDescription
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MusicRecording
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Offer
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.OpeningHours
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PictureResults
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PostalAddress
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Price
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ProductPair
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.QA
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.QAPage
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Rating
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ResultReference
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Review
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Reviews
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.RichCallbackHint
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.SearchOperators
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.TripAdvisorReview
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Unit
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.model.BraveSearchHeader
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.jbrave.core.model.BraveSearchOption
Returns a hash code value for this object.
header() - Method in record class net.ygbstudio.jbrave.core.model.BraveSearchHeader
Returns the value of the header record component.
headerCountry() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the headerCountry record component.
headers - Variable in class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder
Headers accumulated for the request before they are attached.
headersAttached - Variable in class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder
Whether the accumulated headers have already been attached to the request.
HEBREW - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Hebrew.
height() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageThumbnail
Returns the value of the height record component.
height() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.Properties
Returns the value of the height record component.
height() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ImageProperties
Returns the value of the height record component.
HINDI - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Hindi.
hint() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.RichCallbackInfo
Returns the value of the hint record component.
homepage() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Returns the value of the homepage record component.
HONG_KONG - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Hong Kong.
HONG_KONG - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Hong Kong.
hostname() - Method in record class net.ygbstudio.jbrave.core.domain.dto.MetaUrl
Returns the value of the hostname record component.
HowTo - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a step in a how-to guide or tutorial.
HowTo(String, String, String, List<String>) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.HowTo
Creates an instance of a HowTo record class.
HUNGARIAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Hungarian.

I

ICELANDIC - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Icelandic.
iconCategory(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the icon category.
id() - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel
Returns the error identifier.
id() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.LocationDescription
Returns the value of the id record component.
id(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel.Builder
Sets the error identifier.
id(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the location identifier.
image() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.HowTo
Returns the value of the image record component.
Image - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents an image in search results, containing the image's URL, thumbnail, and additional properties.
Image(Thumbnail, String, ImageProperties) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Image
Creates an instance of a Image record class.
IMAGE - Enum constant in enum class net.ygbstudio.jbrave.core.domain.verticals.BraveResource
The image search resource.
ImageProperties - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents the properties of an image in search results.
ImageProperties(String, String, String, Integer, Integer, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.ImageProperties
Creates an instance of a ImageProperties record class.
ImageQuery - Record Class in net.ygbstudio.jbrave.core.domain.dto.image
Represents an image query in search requests.
ImageQuery(String, String, Boolean, Boolean) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.image.ImageQuery
Creates an instance of a ImageQuery record class.
ImageResult - Record Class in net.ygbstudio.jbrave.core.domain.dto.image
Represents an image result in search responses.
ImageResult(String, String, String, String, String, ImageThumbnail, Properties, MetaUrl, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.image.ImageResult
Creates an instance of a ImageResult record class.
images - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The infobox images.
images() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DeepResult
Returns the value of the images record component.
images(List<Thumbnail>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the infobox images.
ImageSearchApiResponse - Record Class in net.ygbstudio.jbrave.api.response
Represents the response from the Brave Search API for image searches.
ImageSearchApiResponse(String, ImageQuery, List<ImageResult>, Extra) - Constructor for record class net.ygbstudio.jbrave.api.response.ImageSearchApiResponse
Creates an instance of a ImageSearchApiResponse record class.
ImageThumbnail - Record Class in net.ygbstudio.jbrave.core.domain.dto.image
Data transfer object for representing an image thumbnail in the Brave Search API.
ImageThumbnail(String, Integer, Integer) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.image.ImageThumbnail
Creates an instance of a ImageThumbnail record class.
img() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.DataProvider
Returns the value of the img record component.
img() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.InfoboxProfile
Returns the value of the img record component.
img() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.Profile
Returns the value of the img record component.
img() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.SuggestResult
Returns the value of the img record component.
IMPERIAL - Enum constant in enum class net.ygbstudio.jbrave.api.options.Units
Imperial units.
INBODY - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Body content search operator.
include(String) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds an "+" operator with its corresponding value to the builder.
INCLUDE_FETCH_METADATA - Enum constant in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Whether to include fetch metadata in the response.
includeFetchMetadata(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds the include_fetch_metadata option to the URL query.
includeFetchMetadata(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Adds the include_fetch_metadata option to the URL query.
includeFetchMetadata(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds the include_fetch_metadata option to the URL query.
includeFetchMetadata(boolean) - Static method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Creates a new instance of BraveSearchOption with SearchOptions.INCLUDE_FETCH_METADATA and the given value.
index() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ResultReference
Returns the value of the index record component.
INDIA - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
India.
INDIA - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
India.
INDONESIA - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Indonesia.
INDONESIA - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Indonesia.
infobox() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns the value of the infobox record component.
INFOBOX - Enum constant in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
Include infobox results.
InfoboxPlace - Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents an infobox for a place in search results.
InfoboxPlace.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result
Builder for InfoboxPlace instances.
InfoboxProfile - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.profile
Represents a profile in search results.
InfoboxProfile(String, String, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.profile.InfoboxProfile
Creates an instance of a InfoboxProfile record class.
InfoboxWithLocation - Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents an infobox with location information in search results.
InfoboxWithLocation.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result
Builder for InfoboxWithLocation instances.
ingredients() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the ingredients record component.
inpage(String) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds an "inpage" operator and its corresponding value to the builder.
INPAGE - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Page content search operator.
instructions() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the instructions record component.
INTERNAL - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveErrorCode
An internal server error.
internalRequestBuilder - Variable in class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder
The underlying HTTP request builder.
intitle(String) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds an "intitle" operator and its corresponding value to the builder.
INTITLE - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Title content search operator.
INVALID_URL - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveErrorCode
The request contained an invalid URL parameter.
InvalidFreshnessInterval - Exception Class in net.ygbstudio.jbrave.core.exceptions
Exception thrown when the interval of dates provided for a freshness filter is invalid.
InvalidFreshnessInterval(String) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.InvalidFreshnessInterval
Creates a new instance with the given detail message.
InvalidFreshnessInterval(Supplier<String>) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.InvalidFreshnessInterval
Creates a new instance with a lazily-evaluated detail message.
InvalidQueryTermException - Exception Class in net.ygbstudio.jbrave.core.exceptions
This exception is thrown when the query term added to the
AbstractQueryUrlBuilder is invalid.
InvalidQueryTermException(String) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.InvalidQueryTermException
Creates a new instance with the given detail message.
InvalidQueryTermException(Supplier<String>) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.InvalidQueryTermException
Creates a new instance with a lazily-evaluated detail message.
isAccessibleForFree() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Article
Returns the value of the isAccessibleForFree record component.
isEntity() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.SuggestResult
Returns the value of the isEntity record component.
isGeolocal() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the isGeolocal record component.
isLive - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Whether the result is a live stream.
isLive - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Whether the result is a live stream.
isLive() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult
Returns whether the news is live.
isLive() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns whether the result is a live stream.
isLive(Boolean) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult.Builder
Sets whether the news is live.
isLive(Boolean) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets whether the result is a live stream.
isLocation(Boolean) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation.Builder
Sets whether this is a location.
isLogicalOperator() - Method in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Returns true if the operator is a logical operator (AND, OR, NOT).
isNavigational() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the isNavigational record component.
isNewsBreaking() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the isNewsBreaking record component.
isNpm() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Returns the value of the isNpm record component.
isPypi() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Returns the value of the isPypi record component.
isSourceBoth - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Whether the source is both.
isSourceBoth() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Returns whether the source is both.
isSourceBoth(Boolean) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result.Builder
Sets whether the source is both.
isSourceLocal - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Whether the source is local.
isSourceLocal() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Returns whether the source is local.
isSourceLocal(Boolean) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result.Builder
Sets whether the source is local.
isTrending() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the isTrending record component.
isTripadvisor() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Rating
Returns the value of the isTripadvisor record component.
isValidQuery(String) - Method in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Checks if the given query term is valid.
ITALIAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Italian.
ITALY - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Italy.
ITALY - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Italy.

J

JAPAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Japan.
JAPAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Japan.
JAPANESE - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Japanese.
jsonReader(Reader, Class<T>) - Static method in class net.ygbstudio.jbrave.core.utils.JsonSupport
Reads a JSON string from a Reader and deserializes it into an object of the specified class.
JsonSupport - Class in net.ygbstudio.jbrave.core.utils
JsonSupport provides JSON serialization and deserialization support using Jackson.

K

KANNADA - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Kannada.
key() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Summarizer
Returns the value of the key record component.
KOREA - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Korea.
KOREA - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Korea.
KOREAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Korean.

L

label - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The infobox label.
label(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the infobox label.
lang(String) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds a "lang" operator and its corresponding value to the builder.
LANG - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Language search operator.
language - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.Result
The result language.
language() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Returns the result language.
language() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the language record component.
language() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.TripAdvisorReview
Returns the value of the language record component.
language(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result.Builder
Sets the result language.
language(T) - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Adds the search language option to the URL query.
language(T) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds the search language option to the URL query.
language(T) - Method in class net.ygbstudio.jbrave.api.builders.BraveSpellcheckQuery
Adds the language option to the URL query.
language(T) - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
Adds the search language option to the URL query.
language(T) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Adds the search language option to the URL query.
language(T) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds the language option to the URL query.
Language - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents language information in search results.
Language(String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Language
Creates an instance of a Language record class.
LanguageIdentifier - Interface in net.ygbstudio.jbrave.core.domain.provided
An interface representing a language identifier.
lat() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the lat record component.
LATITUDE - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
Client latitude in degrees, in the range [-90.0, +90.0].
LATVIAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Latvian.
limit() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitPolicy
Returns the value of the limit record component.
limitPerMonth() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitPolicy
Returns the value of the limitPerMonth record component.
LITHUANIAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Lithuanian.
loc() - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.Error
Returns the value of the loc record component.
loc(String) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds a "loc" operator and its corresponding value to the builder.
LOC - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Location search operator.
localDecision() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the localDecision record component.
LocalEnvironment - Class in net.ygbstudio.jbrave.core.local
Constants for the local environment variables used by the JBrave library.
localLocationsIdx() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the localLocationsIdx record component.
location - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The location associated with this result.
location - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The location associated with this result.
location() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the location.
location(LocationResult) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxPlace.Builder
Sets the location.
location(LocationResult) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation.Builder
Sets the location.
location(LocationResult) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the location.
LocationDescription - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents descriptive information about a specific location in search results.
LocationDescription(String, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.LocationDescription
Creates an instance of a LocationDescription record class.
LocationResult - Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents a location result in search results.
LocationResult(LocationResult.Builder) - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
Creates a new location result from the given builder.
LocationResult.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result
Builder for LocationResult instances.
locations() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns the value of the locations record component.
Locations - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.search
Represents location information in search results.
Locations(String, List<LocationResult>) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.search.Locations
Creates an instance of a Locations record class.
LOCATIONS - Enum constant in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
Include location results.
LocationWebResult - Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents a location web result in search results.
LocationWebResult(LocationWebResult.Builder) - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.LocationWebResult
Creates a new location web result from the given builder.
LocationWebResult.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result
Builder for LocationWebResult instances.
lon() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the lon record component.
longDesc - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The long description of the infobox.
longDesc(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the long description of the infobox.
LONGITUDE - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
Client longitude in degrees, in the range [-180.0, +180.0].
longName() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.DataProvider
Returns the value of the longName record component.
longName() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.InfoboxProfile
Returns the value of the longName record component.
longName() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.Profile
Returns the value of the longName record component.

M

main() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.MixedResponse
Returns the value of the main record component.
main() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Language
Returns the value of the main record component.
MALAY - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Malay.
MALAYALAM - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Malayalam.
MALAYSIA - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Malaysia.
MALAYSIA - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Malaysia.
MARATHI - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Marathi.
market(T) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds the market option to the URL query.
market(T) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Adds the market option to the URL query.
market(T) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds the market option to the URL query.
MarketLocale - Enum Class in net.ygbstudio.jbrave.api.options
Enumeration representing a market locale supported by the Brave Search API.
meta() - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel
Returns additional error metadata.
meta(ErrorMeta) - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel.Builder
Sets additional error metadata.
metaUrl - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The meta URL information for this result.
metaUrl - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The meta URL information for this result.
metaUrl() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageResult
Returns the value of the metaUrl record component.
metaUrl() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult
Returns the meta URL.
metaUrl() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the meta URL.
metaUrl() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult
Returns the meta URL.
metaUrl() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.QA
Returns the value of the metaUrl record component.
metaUrl(MetaUrl) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationWebResult.Builder
Sets the meta URL.
metaUrl(MetaUrl) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult.Builder
Sets the meta URL.
metaUrl(MetaUrl) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.QAInfobox.Builder
Sets the meta URL.
metaUrl(MetaUrl) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the meta URL.
metaUrl(MetaUrl) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult.Builder
Sets the meta URL.
MetaUrl - Record Class in net.ygbstudio.jbrave.core.domain.dto
Represents metadata about a URL in search results.
MetaUrl(String, String, String, String, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.MetaUrl
Creates an instance of a MetaUrl record class.
METRIC - Enum constant in enum class net.ygbstudio.jbrave.api.options.Units
Metric units.
MEXICO - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Mexico.
MEXICO - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Mexico.
mightBeOffensive() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Extra
Returns the value of the mightBeOffensive record component.
MINUS - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Exclusion operator (-).
MissingSubscriptionTokenException - Exception Class in net.ygbstudio.jbrave.core.exceptions
This exception is thrown when there is a missing subscription token.
MissingSubscriptionTokenException(String) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.MissingSubscriptionTokenException
Creates a new instance with the given detail message.
mixed() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns the value of the mixed record component.
MixedResponse - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.search
Represents mixed response information in search results.
MixedResponse(String, List<ResultReference>, List<ResultReference>, List<ResultReference>) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.search.MixedResponse
Creates an instance of a MixedResponse record class.
MODERATE - Enum constant in enum class net.ygbstudio.jbrave.api.filters.SafeSearch
Moderate safe search filtering.
monthlyRequestsRemaining() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitRemaining
Returns the value of the monthlyRequestsRemaining record component.
moreResultsAvailable() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the moreResultsAvailable record component.
movie - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The movie data associated with the infobox.
movie - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The movie data for this result.
movie - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The movie data for this result.
movie() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the movie data.
movie(MovieData) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the movie data associated with the infobox.
movie(MovieData) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the movie data.
MovieData - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents detailed information about a movie in search results.
MovieData(String, String, String, Thumbnail, String, List<Person>, List<Person>, Rating, String, List<String>, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Creates an instance of a MovieData record class.
msg() - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.Error
Returns the value of the msg record component.
musicRecording - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The music recording data for this result.
musicRecording - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The music recording data for this result.
musicRecording() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the music recording data.
musicRecording(MusicRecording) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the music recording data.
MusicRecording - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a music recording (e.g., a song or track) in search results.
MusicRecording(String, Thumbnail, Rating) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.MusicRecording
Creates an instance of a MusicRecording record class.
mutatedByGoggles() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Discussions
Returns the value of the mutatedByGoggles record component.
mutatedByGoggles() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.News
Returns the value of the mutatedByGoggles record component.
mutatedByGoggles() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Videos
Returns the value of the mutatedByGoggles record component.

N

name - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing
The thing name.
name() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.DataProvider
Returns the value of the name record component.
name() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.InfoboxProfile
Returns the value of the name record component.
name() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.Profile
Returns the value of the name record component.
name() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.CreativeWork
Returns the value of the name record component.
name() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.HowTo
Returns the value of the name record component.
name() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Returns the value of the name record component.
name() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MusicRecording
Returns the value of the name record component.
name() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns the value of the name record component.
name() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Review
Returns the value of the name record component.
name() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Returns the value of the name record component.
name(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing.Builder
Sets the thing name.
net.ygbstudio.jbrave.api.builders - package net.ygbstudio.jbrave.api.builders
Public, fluent builders for constructing, configuring, and executing Brave Search API queries.
net.ygbstudio.jbrave.api.filters - package net.ygbstudio.jbrave.api.filters
Enums that model the filtering parameters accepted by the Brave Search API.
net.ygbstudio.jbrave.api.options - package net.ygbstudio.jbrave.api.options
Enums representing Brave Search API options whose values are selected from fixed, API-defined vocabularies.
net.ygbstudio.jbrave.api.rate - package net.ygbstudio.jbrave.api.rate
Records that decode the rate-limit HTTP headers returned by the Brave Search API.
net.ygbstudio.jbrave.api.response - package net.ygbstudio.jbrave.api.response
Sealed response model returned by the Brave Search API.
net.ygbstudio.jbrave.core.builders - package net.ygbstudio.jbrave.core.builders
Internal building blocks that assemble Brave Search API request URLs and HTTP requests.
net.ygbstudio.jbrave.core.domain - package net.ygbstudio.jbrave.core.domain
Core domain model shared across JBrave.
net.ygbstudio.jbrave.core.domain.dto - package net.ygbstudio.jbrave.core.domain.dto
Shared data-transfer objects that mirror the JSON payloads returned by the Brave Search API.
net.ygbstudio.jbrave.core.domain.dto.error - package net.ygbstudio.jbrave.core.domain.dto.error
Data-transfer objects that model the error payload returned by the Brave Search API.
net.ygbstudio.jbrave.core.domain.dto.image - package net.ygbstudio.jbrave.core.domain.dto.image
Data-transfer objects that model image search results from the Brave Search API.
net.ygbstudio.jbrave.core.domain.dto.result - package net.ygbstudio.jbrave.core.domain.dto.result
Data-transfer objects that model web and generic search results from the Brave Search API.
net.ygbstudio.jbrave.core.domain.dto.result.profile - package net.ygbstudio.jbrave.core.domain.dto.result.profile
Data-transfer objects that model knowledge-graph profile data embedded in search results.
net.ygbstudio.jbrave.core.domain.dto.result.search - package net.ygbstudio.jbrave.core.domain.dto.result.search
Data-transfer objects that model the container and rich components of a web search response.
net.ygbstudio.jbrave.core.domain.dto.result.thing - package net.ygbstudio.jbrave.core.domain.dto.result.thing
Data-transfer objects that model schema.org-style entities in search results.
net.ygbstudio.jbrave.core.domain.dto.web - package net.ygbstudio.jbrave.core.domain.dto.web
Data-transfer objects that model rich web result types returned by the Brave Search API.
net.ygbstudio.jbrave.core.domain.modes - package net.ygbstudio.jbrave.core.domain.modes
Internal constants that group filter value enums under their URL parameter modes.
net.ygbstudio.jbrave.core.domain.provided - package net.ygbstudio.jbrave.core.domain.provided
Interfaces identifying search options whose accepted values are defined by the Brave Search API.
net.ygbstudio.jbrave.core.domain.verticals - package net.ygbstudio.jbrave.core.domain.verticals
Enumeration of the search resources (verticals) exposed by the Brave Search API.
net.ygbstudio.jbrave.core.exceptions - package net.ygbstudio.jbrave.core.exceptions
Runtime exceptions raised by JBrave for API, client, and builder lifecycle errors.
net.ygbstudio.jbrave.core.executors - package net.ygbstudio.jbrave.core.executors
Coordination primitives that serialize and rate-limit execution of Brave Search API requests.
net.ygbstudio.jbrave.core.local - package net.ygbstudio.jbrave.core.local
Helpers for resolving client credentials and local environment configuration.
net.ygbstudio.jbrave.core.model - package net.ygbstudio.jbrave.core.model
Core model types for search options, headers, operators, and API error codes.
net.ygbstudio.jbrave.core.utils - package net.ygbstudio.jbrave.core.utils
Internal utilities for JBrave.
NETHERLANDS - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Netherlands.
NETHERLANDS - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Netherlands.
netloc() - Method in record class net.ygbstudio.jbrave.core.domain.dto.MetaUrl
Returns the value of the netloc record component.
NEW_ZEALAND - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
New Zealand.
NEW_ZEALAND - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
New Zealand.
news() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns the value of the news record component.
news() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DeepResult
Returns the value of the news record component.
News - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.search
Represents news information in search results.
News(String, List<NewsResult>, Boolean) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.search.News
Creates an instance of a News record class.
NEWS - Enum constant in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
Include news results.
NEWS - Enum constant in enum class net.ygbstudio.jbrave.core.domain.verticals.BraveResource
The news search resource.
NewsResult - Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents a news result in search results.
NewsResult(NewsResult.Builder) - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult
Creates a new news result from the given builder.
NewsResult.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result
Builder for NewsResult instances.
NewsSearchApiResponse - Record Class in net.ygbstudio.jbrave.api.response
Represents the response from the Brave Search API for news searches.
NewsSearchApiResponse(String, Query, List<NewsResult>) - Constructor for record class net.ygbstudio.jbrave.api.response.NewsSearchApiResponse
Creates an instance of a NewsSearchApiResponse record class.
NORWAY - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Norway.
NORWAY - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Norway.
NORWEGIAN_BOKMAL - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Norwegian (Bokmål).
not(String, String) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds the logical NOT operator and its corresponding values to the builder.
not(UnaryOperator<SearchOperatorBuilder>, UnaryOperator<SearchOperatorBuilder>) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds the logical NOT operator and its corresponding values to the builder.
NOT - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Logical NOT operator.
numAnswers() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ForumData
Returns the value of the numAnswers record component.

O

objectFromJson(String, Class<T>) - Static method in class net.ygbstudio.jbrave.core.utils.JsonSupport
Deserializes a JSON string into an object of the specified class.
of(SearchOption, V) - Static method in record class net.ygbstudio.jbrave.core.model.BraveSearchOption
Creates a new BraveSearchOption with the given key and value.
OFF - Enum constant in enum class net.ygbstudio.jbrave.api.filters.SafeSearch
Safe search disabled.
Offer - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a product or service offering in search results.
Offer(String, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Offer
Creates an instance of a Offer record class.
offers() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns the value of the offers record component.
offset(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds the offset option to the URL query.
offset(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Adds the offset option to the URL query.
offset(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds the offset option to the URL query.
offset(int) - Static method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Create a new instance of BraveSearchOption with SearchOptions.OFFSET and the given value.
OFFSET - Enum constant in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Number of results to skip.
openingHours(OpeningHours) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the opening hours.
OpeningHours - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents the opening hours for a business or location, including both the current day's hours and a weekly schedule.
OpeningHours(List<DayOpeningHours>, List<List<DayOpeningHours>>) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.OpeningHours
Creates an instance of a OpeningHours record class.
opens() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DayOpeningHours
Returns the value of the opens record component.
operators(boolean) - Static method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Create a new instance of BraveSearchOption with SearchOptions.OPERATORS and the given value.
OPERATORS - Enum constant in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Whether the API should read search operators from the query term.
option() - Method in record class net.ygbstudio.jbrave.core.model.BraveSearchOption
Returns the value of the option record component.
option() - Method in interface net.ygbstudio.jbrave.core.model.SearchOptionCarrier
Returns the SearchOption associated with this carrier.
OPTION_NOT_IN_PLAN - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveErrorCode
The requested option is not included in the current subscription plan.
optionMissing(SearchOption) - Method in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Checks if the given search option is already present in the URL query.
optionTracker - Variable in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Tracks which search options have already been added, to prevent duplicates.
or(String, String) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds the logical OR operator and its corresponding values to the builder.
or(UnaryOperator<SearchOperatorBuilder>, UnaryOperator<SearchOperatorBuilder>) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds the logical OR operator and its corresponding values to the builder.
OR - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Logical OR operator.
organization - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The organization data for this result.
organization - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The organization data for this result.
organization() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the organization data.
organization(Organization) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the organization data.
Organization - Class in net.ygbstudio.jbrave.core.domain.dto.result.thing
Represents an organization in search results.
Organization.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result.thing
Builder for Organization instances.
original() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageQuery
Returns the value of the original record component.
original() - Method in record class net.ygbstudio.jbrave.core.domain.dto.OriginalQuery
Returns the value of the original record component.
original() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Query
Returns the value of the original record component.
original() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the original record component.
original() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Thumbnail
Returns the value of the original record component.
OriginalQuery - Record Class in net.ygbstudio.jbrave.core.domain.dto
Represents the original query in a search request.
OriginalQuery(String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.OriginalQuery
Creates an instance of a OriginalQuery record class.

P

pageAge - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.Result
The page age.
pageAge() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Returns the page age.
pageAge(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result.Builder
Sets the page age.
pageFetched - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.Result
The page fetched timestamp string.
pageFetched() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageResult
Returns the value of the pageFetched record component.
pageFetched() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Returns the page fetched timestamp string.
pageFetched(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result.Builder
Sets the page fetched timestamp string.
pages() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Book
Returns the value of the pages record component.
path() - Method in record class net.ygbstudio.jbrave.core.domain.dto.MetaUrl
Returns the value of the path record component.
pathDisplay() - Method in record class net.ygbstudio.jbrave.core.domain.dto.MetaUrl
Returns the value of the pathDisplay record component.
Person - Class in net.ygbstudio.jbrave.core.domain.dto.result.thing
Represents a person in search results.
Person(Person.Builder) - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.thing.Person
Constructs a new Person instance.
Person.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result.thing
Builder for Person instances.
PHILIPPINES - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Philippines.
PHILIPPINES - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Philippines.
PictureResults - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a collection of image results in search responses.
PictureResults(String, List<Thumbnail>) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.PictureResults
Creates an instance of a PictureResults record class.
pictures(PictureResults) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the pictures.
placeholder() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.Properties
Returns the value of the placeholder record component.
placeholder() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ImageProperties
Returns the value of the placeholder record component.
PLUS - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Inclusion operator (+).
POLAND - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Poland.
POLAND - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Poland.
POLISH - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Polish.
PORTUGAL - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Portugal.
PORTUGUESE_BRAZIL - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Portuguese (Brazil).
PORTUGUESE_PORTUGAL - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Portuguese (Portugal).
position - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The infobox position.
position(Integer) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the infobox position.
POSTAL_CODE - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
Client's postal code.
postalAddress(PostalAddress) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the postal address.
PostalAddress - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a physical mailing address in search results.
PostalAddress(String, String, String, String, String, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.PostalAddress
Creates an instance of a PostalAddress record class.
postalCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the postalCode record component.
postalCode() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PostalAddress
Returns the value of the postalCode record component.
prepTime() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the prepTime record component.
price() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Book
Returns the value of the price record component.
price() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Offer
Returns the value of the price record component.
price() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Price
Returns the value of the price record component.
price() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns the value of the price record component.
Price - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a monetary amount with its associated currency.
Price(String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Price
Creates an instance of a Price record class.
priceCurrency() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Offer
Returns the value of the priceCurrency record component.
priceCurrency() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Price
Returns the value of the priceCurrency record component.
priceRange(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the price range.
product - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The primary product for this result.
product - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The primary product for this result.
product() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the primary product.
product() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ProductPair
Returns the value of the product record component.
product(ProductPair) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the primary product.
Product - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a product in search results, containing detailed information about the product such as its name, category, price, and GTIN identifiers.
Product(String, String, String, String, Thumbnail, String, List<Offer>, Rating, String, String, String, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Creates an instance of a Product record class.
productCluster - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The cluster of related products.
productCluster - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The cluster of related products.
productCluster() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the product cluster.
productCluster(List<ProductPair>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the product cluster.
ProductPair - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a product along with its associated review.
ProductPair(Product, Review) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.ProductPair
Creates an instance of a ProductPair record class.
profile - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.Result
The profile.
profile() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Returns the profile.
profile() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Rating
Returns the value of the profile record component.
profile(Profile) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result.Builder
Sets the profile.
Profile - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.profile
Represents a profile in search results.
Profile(String, String, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.profile.Profile
Creates an instance of a Profile record class.
profiles - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The graph infobox profiles.
profiles(List<DataProvider>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the profiles.
profiles(List<GraphInfoboxProfile>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the graph infobox profiles.
programmingLanguage() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Returns the value of the programmingLanguage record component.
properties() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageResult
Returns the value of the properties record component.
properties() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Image
Returns the value of the properties record component.
Properties - Record Class in net.ygbstudio.jbrave.core.domain.dto.image
Data transfer object for representing metadata for the images in the Brave Search API.
Properties(String, String, Integer, Integer) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.image.Properties
Creates an instance of a Properties record class.
ProvidedOption - Interface in net.ygbstudio.jbrave.core.domain
An interface representing a search option that provides a key and a value for a URL parameter.
providers - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The infobox data providers.
providers(List<DataProvider>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the infobox data providers.
providerUrl(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the provider URL.
publisher() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.VideoData
Returns the value of the publisher record component.
publisher() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Article
Returns the value of the publisher record component.
publisher() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Book
Returns the value of the publisher record component.
PUNJABI - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Punjabi.

Q

qa - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The Q&A page data for this result.
qa - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The Q&A page data for this result.
qa() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the Q&A page data.
qa(QAPage) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the Q&A page data.
QA - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a question and answer pair in search results, typically used in FAQ sections or question-and-answer platforms.
QA(String, String, String, String, MetaUrl) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.QA
Creates an instance of a QA record class.
QAInfobox - Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents a QA infobox in search results.
QAInfobox(QAInfobox.Builder) - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.QAInfobox
Creates a new QA infobox from the given builder.
QAInfobox.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result
Builder for QAInfobox instances.
QAPage - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a question and answer page in search results, containing a question and its corresponding answer.
QAPage(String, Answer) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.QAPage
Creates an instance of a QAPage record class.
query() - Method in record class net.ygbstudio.jbrave.api.response.ImageSearchApiResponse
Returns the value of the query record component.
query() - Method in record class net.ygbstudio.jbrave.api.response.NewsSearchApiResponse
Returns the value of the query record component.
query() - Method in record class net.ygbstudio.jbrave.api.response.SpellcheckSearchApiResponse
Returns the value of the query record component.
query() - Method in record class net.ygbstudio.jbrave.api.response.SuggestSearchApiResponse
Returns the value of the query record component.
query() - Method in record class net.ygbstudio.jbrave.api.response.VideoSearchApiResponse
Returns the value of the query record component.
query() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns the value of the query record component.
query() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.SpellCheckResult
Returns the value of the query record component.
query() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.SuggestResult
Returns the value of the query record component.
query() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Returns the value of the query record component.
query(String) - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Adds a search term to the URL query.
query(String) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds a search term to the URL query.
query(String) - Method in class net.ygbstudio.jbrave.api.builders.BraveSpellcheckQuery
Adds a search term to the URL query.
query(String) - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
Adds a search term to the URL query.
query(String) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Adds a search term to the URL query.
query(String) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds a search term to the URL query.
Query - Record Class in net.ygbstudio.jbrave.core.domain.dto
Represents a query in search requests.
Query(String, String, String, Boolean, Boolean) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.Query
Creates an instance of a Query record class.
QUERY - Enum constant in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
Include the original query metadata.
QUERY_PROMPT - Static variable in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
The query parameter prefix ("q=") used when building the URL.
queryAddress(URI) - Method in class net.ygbstudio.jbrave.core.builders.BraveVerticalSearchRequest
Sets the URI for the request.
queryAddress(URI) - Method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Sets the URI for the request.
queryMissing() - Method in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Checks if the query prompt is already present in the URL query.
queryURI(URI) - Method in class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder
Sets the URI for the request.
question() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ForumData
Returns the value of the question record component.
question() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.QA
Returns the value of the question record component.
question() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.QAPage
Returns the value of the question record component.
QUOTA_LIMITED - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveErrorCode
The request quota for the current period has been exhausted.
QUOTE - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Exact match operator (wraps a value in double quotes).

R

RATE_LIMITED - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveErrorCode
The request was rate-limited; the client should honor the X-RateLimit-Reset window.
RateLimitResponse - Record Class in net.ygbstudio.jbrave.api.response
Constructs a RateLimitResponse with the given rate limit information.
RateLimitResponse(Optional<XRateLimit>, Optional<XRateLimitPolicy>, Optional<XRateLimitRemaining>, Optional<XRateLimitReset>) - Constructor for record class net.ygbstudio.jbrave.api.response.RateLimitResponse
Creates an instance of a RateLimitResponse record class.
rating - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The rating for this result.
rating - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The rating for this result.
rating() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the rating.
rating() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Book
Returns the value of the rating record component.
rating() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.CreativeWork
Returns the value of the rating record component.
rating() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Returns the value of the rating record component.
rating() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MusicRecording
Returns the value of the rating record component.
rating() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns the value of the rating record component.
rating() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the rating record component.
rating() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Review
Returns the value of the rating record component.
rating() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.TripAdvisorReview
Returns the value of the rating record component.
rating(Rating) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the rating.
rating(Rating) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the rating.
Rating - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents rating information for various entities in search results, such as products, businesses, or services.
Rating(Double, Double, Integer, Profile, Boolean) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Rating
Creates an instance of a Rating record class.
ratings - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The infobox ratings.
ratings(List<Rating>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the infobox ratings.
ratingValue() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Rating
Returns the value of the ratingValue record component.
readJsonFs(File, Class<T>) - Static method in class net.ygbstudio.jbrave.core.utils.JsonSupport
Reads a JSON file from the filesystem and deserializes it into an object of the specified class.
recipe - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The recipe data for this result.
recipe - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The recipe data for this result.
recipe() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the recipe data.
recipe(Recipe) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the recipe data.
Recipe - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a recipe in search results.
Recipe(String, String, Thumbnail, String, String, String, String, String, String, String, List<HowTo>, Integer, Integer, Rating, String, String, VideoData) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Creates an instance of a Recipe record class.
recipeCategory() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the recipeCategory record component.
recipeCusine() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the recipeCusine record component.
redditCluster() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the redditCluster record component.
RegionLocaleIdentifier - Interface in net.ygbstudio.jbrave.core.domain.provided
An interface representing a region-locale identifier.
release() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Returns the value of the release record component.
requestAvailable() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitRemaining
Returns the value of the requestAvailable record component.
requestGate() - Method in class net.ygbstudio.jbrave.core.local.ClientInfo
Returns the execution gate that serializes and rate-limits requests for this client's token.
RequestProcessingInterrupted - Exception Class in net.ygbstudio.jbrave.core.exceptions
An exception that is thrown when a request processing thread is interrupted while waiting to acquire execution admission
RequestProcessingInterrupted(String) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.RequestProcessingInterrupted
Creates a new instance with the given detail message.
RequestProcessingInterrupted(String, Throwable) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.RequestProcessingInterrupted
Creates a new instance with the given detail message and cause.
RequestProcessingInterrupted(Supplier<String>) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.RequestProcessingInterrupted
Creates a new instance with a lazily-evaluated detail message.
RequestProcessingInterrupted(Supplier<String>, Throwable) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.RequestProcessingInterrupted
Creates a new instance with a lazily-evaluated detail message and a cause.
RequestRetryInterruptedException - Exception Class in net.ygbstudio.jbrave.core.exceptions
Thrown when all retry attempts for an HTTP request have been exhausted, indicating that the executor was unable to complete a series of retries.
RequestRetryInterruptedException(String, Throwable) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.RequestRetryInterruptedException
Creates a new instance with the given detail message and cause.
requestsPerMonth() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimit
Returns the value of the requestsPerMonth record component.
requestsPerSecond() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimit
Returns the value of the requestsPerSecond record component.
requestURI - Variable in class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder
The request URI, retained by AbstractBraveRequestBuilder.clearRetainURI().
requiresSubscription() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.VideoData
Returns the value of the requiresSubscription record component.
reset() - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Clears the current instance of BraveImageQuery by resetting its state to its initial values.
reset() - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Clears the current instance of BraveNewsQuery by resetting its state to its initial values.
reset() - Method in interface net.ygbstudio.jbrave.api.builders.BraveQueryBuilder
Clears the builder by resetting it to its initial state.
reset() - Method in class net.ygbstudio.jbrave.api.builders.BraveSpellcheckQuery
Clears the current instance of BraveSpellcheckQuery by resetting its state to its initial values.
reset() - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
Clears the current instance of BraveSuggestQuery by resetting its state to its initial values.
reset() - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Clears the current instance of BraveVideoQuery by resetting its state to its initial values.
reset() - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Clears the current instance of BraveWebQuery by resetting its state to its initial values.
resized() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ImageProperties
Returns the value of the resized record component.
RESOURCE_NOT_ALLOWED - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveErrorCode
The requested resource is not allowed under the current subscription plan.
ResponseDecompressionException - Exception Class in net.ygbstudio.jbrave.core.exceptions
Exception thrown when a compressed HTTP response body cannot be decompressed by JBrave.
ResponseDecompressionException(String) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.ResponseDecompressionException
Creates a new instance with the given detail message.
ResponseDecompressionException(Supplier<String>) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.ResponseDecompressionException
Creates a new instance with a lazily-evaluated detail message.
Result - Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents a generic result in search results.
Result(Result.Builder) - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.Result
Creates a new result from the given builder.
RESULT_FILTER - Enum constant in enum class net.ygbstudio.jbrave.core.domain.modes.SearchFilterMode
Result filter mode (result_filter URL parameter).
Result.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result
Builder for Result instances.
ResultFilter - Enum Class in net.ygbstudio.jbrave.api.filters
Enumeration of possible result filters to be used in the api requests.
resultFilters(Set<ResultFilter>) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds result filters to the URL query.
ResultReference - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a reference to a search result or a group of results.
ResultReference(String, Integer, Boolean) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.ResultReference
Creates an instance of a ResultReference record class.
results() - Method in record class net.ygbstudio.jbrave.api.response.ImageSearchApiResponse
Returns the value of the results record component.
results() - Method in record class net.ygbstudio.jbrave.api.response.NewsSearchApiResponse
Returns the value of the results record component.
results() - Method in record class net.ygbstudio.jbrave.api.response.SpellcheckSearchApiResponse
Returns the value of the results record component.
results() - Method in record class net.ygbstudio.jbrave.api.response.SuggestSearchApiResponse
Returns the value of the results record component.
results() - Method in record class net.ygbstudio.jbrave.api.response.VideoSearchApiResponse
Returns the value of the results record component.
results() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Discussions
Returns the value of the results record component.
results() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.FAQ
Returns the value of the results record component.
results() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.GraphInfobox
Returns the value of the results record component.
results() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Locations
Returns the value of the results record component.
results() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.News
Returns the value of the results record component.
results() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Search
Returns the value of the results record component.
results() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Videos
Returns the value of the results record component.
results() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PictureResults
Returns the value of the results record component.
results() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Reviews
Returns the value of the results record component.
review - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The review data for this result.
review - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The review data for this result.
review() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the review data.
review() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ProductPair
Returns the value of the review record component.
review(Review) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the review data.
Review - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a single review in search results, containing information about the reviewer, their rating, and their comments.
Review(String, String, Thumbnail, String, Rating) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Review
Creates an instance of a Review record class.
reviewCount() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Rating
Returns the value of the reviewCount record component.
reviews(Reviews) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the reviews.
Reviews - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a collection of reviews in search results, typically associated with a business, product, or service.
Reviews(List<TripAdvisorReview>, String, Boolean) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Reviews
Creates an instance of a Reviews record class.
reviewsInForeignLanguage() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Reviews
Returns the value of the reviewsInForeignLanguage record component.
reviewUrl() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.TripAdvisorReview
Returns the value of the reviewUrl record component.
rich() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns the value of the rich record component.
rich(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
Adds the rich option to the URL query.
rich(boolean) - Static method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Creates a new instance of BraveSearchOption with SearchOptions.RICH and the given value.
RICH - Enum constant in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Whether to enable rich result formatting.
RichCallbackHint - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a hint for rich callbacks in search results.
RichCallbackHint(String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.RichCallbackHint
Creates an instance of a RichCallbackHint record class.
RichCallbackInfo - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.search
Represents rich callback information in search results.
RichCallbackInfo(String, RichCallbackHint) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.search.RichCallbackInfo
Creates an instance of a RichCallbackInfo record class.
ROMANIAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Romanian.
RUSSIA - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Russia.
RUSSIA - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Russia.
RUSSIAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Russian.

S

SAFE_SEARCH - Enum constant in enum class net.ygbstudio.jbrave.core.domain.modes.SearchFilterMode
Safe search filter mode (safesearch URL parameter).
safeSearch() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the safeSearch record component.
safeSearch(SafeSearch) - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Adds a safe search option to the URL query.
safeSearch(SafeSearch) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds a safe search option to the URL query.
safeSearch(SafeSearch) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Adds a safe search option to the URL query.
safeSearch(SafeSearch) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds a safe search option to the URL query.
SafeSearch - Enum Class in net.ygbstudio.jbrave.api.filters
Enumeration representing safe search filters for the API requests.
SAUDI_ARABIA - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Saudi Arabia.
schemas - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The schema definitions for this result.
schemas - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The schema definitions for this result.
schemas() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the schema definitions.
schemas(List<List<String>>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the schema definitions.
scheme() - Method in record class net.ygbstudio.jbrave.core.domain.dto.MetaUrl
Returns the value of the scheme record component.
score() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ForumData
Returns the value of the score record component.
Search - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.search
Represents search information in search results.
Search(String, List<SearchResult>, Boolean) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.search.Search
Creates an instance of a Search record class.
SEARCH_API_BASE - Static variable in interface net.ygbstudio.jbrave.core.domain.BraveAPIConstant
The base URL for the Brave API.
SEARCH_PATH - Static variable in interface net.ygbstudio.jbrave.core.domain.SearchVertical
The URL path segment appended after the vertical value ("search").
SearchFilterMode - Enum Class in net.ygbstudio.jbrave.core.domain.modes
Enumeration class representing filter modes for the Brave Search API.
SearchFilterOption - Interface in net.ygbstudio.jbrave.core.domain
An interface representing a search filter.
SearchHeader - Interface in net.ygbstudio.jbrave.core.domain
An interface representing a header for a search request.
SearchLanguage - Enum Class in net.ygbstudio.jbrave.api.options
Enum representing the different language identifiers supported by the Brave Search API.
SearchOperatorBuilder - Class in net.ygbstudio.jbrave.core.builders
A builder class for constructing search operators.
searchOperators() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the searchOperators record component.
SearchOperators - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Search operators that were detected and applied to the query according to the Brave Search API documentation.
SearchOperators(Boolean, String, List<String>) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.SearchOperators
Creates an instance of a SearchOperators record class.
SearchOption - Interface in net.ygbstudio.jbrave.core.domain
An interface representing a search option.
SearchOptionCarrier<V> - Interface in net.ygbstudio.jbrave.core.model
An interface that represents a carrier for a SearchOption and its corresponding value.
SearchOptions - Enum Class in net.ygbstudio.jbrave.core.model
Enumeration of the search options available in the Brave API.
SearchResult - Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents a search result in search results.
SearchResult(SearchResult.Builder) - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Creates a new search result from the given builder.
SearchResult.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result
Builder for SearchResult instances.
SearchVertical - Interface in net.ygbstudio.jbrave.core.domain
An interface representing a search vertical.
secondsUntilMonthlyReset() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitReset
Returns the value of the secondsUntilMonthlyReset record component.
secondsUntilNextRequest() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitReset
Returns the value of the secondsUntilNextRequest record component.
self() - Method in class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder
Returns the current instance of the builder.
self() - Method in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Returns the current instance of the builder.
self() - Method in class net.ygbstudio.jbrave.core.executors.AbstractRequestExecutor
Returns the current instance cast to the concrete subclass type.
SERBIAN_CYRILIC - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Serbian (Cyrillic).
servesCuisine(List<String>) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the served cuisines.
servings() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the servings record component.
shouldFallback() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the shouldFallback record component.
showStrictWarning() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageQuery
Returns the value of the showStrictWarning record component.
showStrictWarning() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Query
Returns the value of the showStrictWarning record component.
showStrictWarning() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the showStrictWarning record component.
side() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.MixedResponse
Returns the value of the side record component.
site(String) - Method in class net.ygbstudio.jbrave.core.builders.SearchOperatorBuilder
Adds a "site" operator and its corresponding value to the builder.
SITE - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Site restriction operator.
sites() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.SearchOperators
Returns the value of the sites record component.
SLOVAK - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Slovak.
SLOVENIAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Slovenian.
software - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The software data for this result.
software - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The software data for this result.
software() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the software data.
software(Software) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the software data.
Software - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents software information in search results.
Software(String, String, String, String, String, String, Boolean, Boolean, Integer, Integer, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Creates an instance of a Software record class.
source() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageResult
Returns the value of the source record component.
source() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult
Returns the source.
source(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult.Builder
Sets the source.
SOUTH_AFRICA - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
South Africa.
SOUTH_AFRICA - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
South Africa.
SPAIN - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Spain.
SPAIN - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Spain.
SPANISH - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Spanish.
spellcheck(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Adds the spell check option to the URL query.
spellcheck(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds the spell check option to the URL query.
spellcheck(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Adds the spell check option to the URL query.
spellCheck(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds the spellcheck option to the URL query.
spellCheck(boolean) - Static method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Create a new instance of BraveSearchOption with SearchOptions.SPELLCHECK and the given value.
SPELLCHECK - Enum constant in enum class net.ygbstudio.jbrave.core.domain.verticals.BraveResource
The spellcheck resource.
SPELLCHECK - Enum constant in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Whether to enable spellcheck.
spellcheckOff() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageQuery
Returns the value of the spellcheckOff record component.
spellcheckOff() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Query
Returns the value of the spellcheckOff record component.
spellcheckOff() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the spellcheckOff record component.
SpellCheckResult - Record Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents a spell check result in search responses.
SpellCheckResult(String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.SpellCheckResult
Creates an instance of a SpellCheckResult record class.
SpellcheckSearchApiResponse - Record Class in net.ygbstudio.jbrave.api.response
Represents the response from the Brave Search API for spell check.
SpellcheckSearchApiResponse(String, OriginalQuery, List<SpellCheckResult>) - Constructor for record class net.ygbstudio.jbrave.api.response.SpellcheckSearchApiResponse
Creates an instance of a SpellcheckSearchApiResponse record class.
src() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageThumbnail
Returns the value of the src record component.
src() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Thumbnail
Returns the value of the src record component.
stars() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Returns the value of the stars record component.
state() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the state record component.
STATE - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
First-level administrative subdivision (ISO 3166-2); up to three characters.
STATE_NAME - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
Human-readable name of the first-level administrative subdivision.
status() - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel
Returns the HTTP status code associated with the error.
status(Integer) - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel.Builder
Sets the HTTP status code associated with the error.
streetAddress() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PostalAddress
Returns the value of the streetAddress record component.
STRICT - Enum constant in enum class net.ygbstudio.jbrave.api.filters.SafeSearch
Strict safe search filtering.
submit(HttpRequest) - Method in class net.ygbstudio.jbrave.core.executors.BraveExecutionGate
Submits a request for serialized execution with a default retry policy.
submit(HttpRequest, int) - Method in class net.ygbstudio.jbrave.core.executors.BraveExecutionGate
Submits a request for serialized execution through the execution gate.
SUBSCRIPTION_NOT_FOUND - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveErrorCode
The subscription token does not match any active subscription.
SUBSCRIPTION_TOKEN - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
Subscription token identifying the calling client.
SUBSCRIPTION_TOKEN_INVALID - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveErrorCode
The provided subscription token is not valid.
subscriptionMissing() - Method in class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder
Checks if the subscription token header is missing.
subscriptionToken() - Method in class net.ygbstudio.jbrave.core.local.ClientInfo
Returns the subscription token associated with this client.
subtype - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The result subtype.
subtype - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The result subtype.
subtype() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the result subtype.
subtype(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.EntityInfobox.Builder
Sets the entity subtype.
subtype(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the result subtype.
subType(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.GenericInfobox.Builder
Sets the infobox subtype.
subType(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxPlace.Builder
Sets the place subtype.
subType(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation.Builder
Sets the infobox subtype.
subType(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.QAInfobox.Builder
Sets the infobox subtype.
SUGGEST - Enum constant in enum class net.ygbstudio.jbrave.core.domain.verticals.BraveResource
The query suggestion (autocomplete) resource.
SuggestResult - Record Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents a suggestion result in search responses.
SuggestResult(String, Boolean, String, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.SuggestResult
Creates an instance of a SuggestResult record class.
SuggestSearchApiResponse - Record Class in net.ygbstudio.jbrave.api.response
Represents the response from the Brave Search API for suggestions.
SuggestSearchApiResponse(String, OriginalQuery, List<SuggestResult>) - Constructor for record class net.ygbstudio.jbrave.api.response.SuggestSearchApiResponse
Creates an instance of a SuggestSearchApiResponse record class.
summarizer() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns the value of the summarizer record component.
Summarizer - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.search
Represents a summarizer in search results.
Summarizer(String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.search.Summarizer
Creates an instance of a Summarizer record class.
SUMMARIZER - Enum constant in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
Include AI-generated summaries.
summary(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds the summary option to the URL query.
summary(boolean) - Static method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Create a new instance of BraveSearchOption with SearchOptions.SUMMARY and the given value.
SUMMARY - Enum constant in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Whether to include a summary in the results.
summaryKey() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns the value of the summaryKey record component.
SWEDEN - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Sweden.
SWEDEN - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Sweden.
SWEDISH - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Swedish.
SWITZERLAND - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Switzerland.
SWITZERLAND_FRENCH - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Switzerland (French).
SWITZERLAND_GERMAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Switzerland (German).

T

tags() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.VideoData
Returns the value of the tags record component.
TAIWAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Taiwan.
TAIWAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Taiwan.
TAMIL - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Tamil.
telephone() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Contact
Returns the value of the telephone record component.
telephone(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.ContactPoint.Builder
Sets the telephone number for the contact point.
TELUGU - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Telugu.
text() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Answer
Returns the value of the text record component.
text() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.HowTo
Returns the value of the text record component.
TEXT_DECORATIONS - Enum constant in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Whether to include text decorations in the results.
textDecorations(boolean) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds the text_decorations option to the URL query.
textDecorations(boolean) - Static method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Create a new instance of BraveSearchOption with SearchOptions.TEXT_DECORATIONS and the given value.
THAI - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Thai.
Thing - Class in net.ygbstudio.jbrave.core.domain.dto.result.thing
Base type for the schema.org-style Thing entities referenced by search results.
Thing.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result.thing
Builder for Thing instances.
thumbnail - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The infobox thumbnail.
thumbnail - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The thumbnail for this result.
thumbnail - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The thumbnail for this result.
thumbnail - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing
The thing thumbnail.
thumbnail() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageResult
Returns the value of the thumbnail record component.
thumbnail() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult
Returns the thumbnail.
thumbnail() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the thumbnail.
thumbnail() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.VideoData
Returns the value of the thumbnail record component.
thumbnail() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult
Returns the thumbnail.
thumbnail() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Article
Returns the value of the thumbnail record component.
thumbnail() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.CreativeWork
Returns the value of the thumbnail record component.
thumbnail() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Image
Returns the value of the thumbnail record component.
thumbnail() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Returns the value of the thumbnail record component.
thumbnail() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MusicRecording
Returns the value of the thumbnail record component.
thumbnail() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns the value of the thumbnail record component.
thumbnail() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the thumbnail record component.
thumbnail() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Review
Returns the value of the thumbnail record component.
thumbnail(Thumbnail) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the infobox thumbnail.
thumbnail(Thumbnail) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the thumbnail.
thumbnail(Thumbnail) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult.Builder
Sets the thumbnail.
thumbnail(Thumbnail) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the thumbnail.
thumbnail(Thumbnail) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing.Builder
Sets the thumbnail.
thumbnail(Thumbnail) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult.Builder
Sets the thumbnail.
Thumbnail - Record Class in net.ygbstudio.jbrave.core.domain.dto
Represents a thumbnail image in search results.
Thumbnail(String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.Thumbnail
Creates an instance of a Thumbnail record class.
time() - Method in record class net.ygbstudio.jbrave.api.response.ErrorResponse
Returns the value of the time record component.
time() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the time record component.
timestamp() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitReset
Returns the value of the timestamp record component.
timezone(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the timezone.
TIMEZONE - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
IANA timezone of the client's device (for example "America/Costa_Rica").
timezoneOffset(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the timezone offset.
title - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.Result
The result title.
title() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageResult
Returns the value of the title record component.
title() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Returns the result title.
title() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.SuggestResult
Returns the value of the title record component.
title() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Book
Returns the value of the title record component.
title() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ButtonResult
Returns the value of the title record component.
title() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ForumData
Returns the value of the title record component.
title() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.QA
Returns the value of the title record component.
title() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the title record component.
title() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.TripAdvisorReview
Returns the value of the title record component.
title(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result.Builder
Sets the result title.
toEntry() - Method in record class net.ygbstudio.jbrave.core.model.BraveSearchHeader
Returns an immutable entry of this header.
toHttpRequest() - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Converts the current query to an HttpRequest instance.
toHttpRequest() - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Converts the current query to an HttpRequest instance.
toHttpRequest() - Method in interface net.ygbstudio.jbrave.api.builders.BraveQueryBuilder
Converts the current query to an HttpRequest instance.
toHttpRequest() - Method in class net.ygbstudio.jbrave.api.builders.BraveSpellcheckQuery
 
toHttpRequest() - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
Converts the current query to an HttpRequest instance.
toHttpRequest() - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Converts the current query to an HttpRequest instance.
toHttpRequest() - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
 
toJson() - Method in interface net.ygbstudio.jbrave.api.response.ApiResponse
Serializes the response object to a JSON string.
toJson() - Method in record class net.ygbstudio.jbrave.api.response.RateLimitResponse
Serializes this rate-limit response to a JSON string.
toJsonString(Object) - Static method in class net.ygbstudio.jbrave.core.utils.JsonSupport
Serializes an object into a JSON string.
top() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.MixedResponse
Returns the value of the top record component.
topComment() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ForumData
Returns the value of the topComment record component.
toSearchOption() - Method in enum class net.ygbstudio.jbrave.api.filters.Freshness
 
toSearchOption() - Method in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
 
toSearchOption() - Method in enum class net.ygbstudio.jbrave.api.filters.SafeSearch
 
toSearchOption() - Method in enum class net.ygbstudio.jbrave.api.options.Country
 
toSearchOption() - Method in enum class net.ygbstudio.jbrave.api.options.MarketLocale
 
toSearchOption() - Method in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
 
toSearchOption() - Method in enum class net.ygbstudio.jbrave.api.options.Units
 
toSearchOption() - Method in interface net.ygbstudio.jbrave.core.domain.provided.CountryIdentifier
Converts this country identifier to a SearchOptionCarrier for use in a search request.
toSearchOption() - Method in interface net.ygbstudio.jbrave.core.domain.provided.LanguageIdentifier
Converts this language identifier to a SearchOptionCarrier for use in a search request.
toSearchOption() - Method in interface net.ygbstudio.jbrave.core.domain.provided.RegionLocaleIdentifier
Converts this region-locale identifier to a SearchOptionCarrier for use in a search request.
toSearchOption() - Method in interface net.ygbstudio.jbrave.core.domain.ProvidedOption
Converts this search option to a SearchOptionCarrier that can be used to build a URL parameter.
toSearchOption() - Method in interface net.ygbstudio.jbrave.core.domain.SearchFilterOption
Converts this search filter to a SearchOptionCarrier that can be used to build a URL parameter.
toString() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimit
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitPolicy
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitRemaining
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitReset
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.api.response.ErrorResponse
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.api.response.ImageSearchApiResponse
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.api.response.NewsSearchApiResponse
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.api.response.RateLimitResponse
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.api.response.SpellcheckSearchApiResponse
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.api.response.SuggestSearchApiResponse
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.api.response.VideoSearchApiResponse
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns a string representation of this record class.
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.error.ApiErrorModel
 
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.Context
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.Error
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.ErrorMeta
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Extra
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageQuery
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageResult
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageThumbnail
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.Properties
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.MetaUrl
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.OriginalQuery
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Query
Returns a string representation of this record class.
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.DiscussionResult
 
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.EntityInfobox
 
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.GenericInfobox
 
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxPlace
 
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation
 
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult
 
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationWebResult
 
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.NewsResult
 
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.DataProvider
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.InfoboxProfile
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.Profile
Returns a string representation of this record class.
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.QAInfobox
 
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Discussions
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.FAQ
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.GraphInfobox
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Locations
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.MixedResponse
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.News
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.RichCallbackInfo
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Search
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Summarizer
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Videos
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Returns a string representation of this record class.
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
 
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.SpellCheckResult
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.SuggestResult
Returns a string representation of this record class.
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.ContactPoint
 
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Organization
 
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Person
 
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.VideoData
Returns a string representation of this record class.
toString() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult
 
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.Thumbnail
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Action
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Answer
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Article
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Book
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ButtonResult
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Contact
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.CreativeWork
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DayOpeningHours
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DeepResult
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ForumData
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.HowTo
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Image
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ImageProperties
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Language
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.LocationDescription
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MusicRecording
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Offer
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.OpeningHours
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PictureResults
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PostalAddress
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Price
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ProductPair
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.QA
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.QAPage
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Rating
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ResultReference
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Review
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Reviews
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.RichCallbackHint
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.SearchOperators
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.TripAdvisorReview
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Unit
Returns a string representation of this record class.
toString() - Method in enum class net.ygbstudio.jbrave.core.model.BraveErrorCode
 
toString() - Method in record class net.ygbstudio.jbrave.core.model.BraveSearchHeader
Returns a string representation of this record class.
toString() - Method in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
 
toString() - Method in record class net.ygbstudio.jbrave.core.model.BraveSearchOption
Returns a string representation of this record class.
toURI() - Method in interface net.ygbstudio.jbrave.api.builders.BraveQueryBuilder
Converts the current query to a URI.
toURI() - Method in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Converts the URL query to a URI.
TripAdvisorReview - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a review from TripAdvisor in search results.
TripAdvisorReview(String, String, String, Rating, Person, String, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.TripAdvisorReview
Creates an instance of a TripAdvisorReview record class.
TURKEY - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
Turkey.
TURKEY - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Turkey.
TURKISH - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Turkish.
type - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The infobox type.
type - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The result type.
type - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The result type.
type - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing
The thing type.
type() - Method in record class net.ygbstudio.jbrave.api.response.ErrorResponse
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.api.response.ImageSearchApiResponse
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.api.response.NewsSearchApiResponse
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.api.response.SpellcheckSearchApiResponse
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.api.response.SuggestSearchApiResponse
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.api.response.VideoSearchApiResponse
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.error.Error
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageResult
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.DataProvider
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Discussions
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.FAQ
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.GraphInfobox
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Locations
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.MixedResponse
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.News
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.RichCallbackInfo
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Search
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Summarizer
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.search.Videos
Returns the value of the type record component.
type() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the result type.
type() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult
Returns the video type.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Action
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ButtonResult
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.LocationDescription
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PostalAddress
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Product
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ResultReference
Returns the value of the type record component.
type() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Review
Returns the value of the type record component.
type(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the infobox type.
type(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the location type.
type(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the result type.
type(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing.Builder
Sets the thing type.
type(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult.Builder
Sets the video type.

U

UKRAINIAN - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Ukrainian.
UninitializedBuilderException - Exception Class in net.ygbstudio.jbrave.core.exceptions
Exception thrown when a URL query builder is not initialized before adding options.
UninitializedBuilderException(String) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.UninitializedBuilderException
Creates a new instance with the given detail message.
UninitializedBuilderException(Supplier<String>) - Constructor for exception class net.ygbstudio.jbrave.core.exceptions.UninitializedBuilderException
Creates a new instance with a lazily-evaluated detail message.
Unit - Record Class in net.ygbstudio.jbrave.core.domain.dto.web
Represents a value with its associated unit of measurement.
Unit(Double, String) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.web.Unit
Creates an instance of a Unit record class.
UNITED_KINGDOM - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
United Kingdom.
UNITED_KINGDOM - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
United Kingdom.
UNITED_STATES - Enum constant in enum class net.ygbstudio.jbrave.api.options.Country
United States.
UNITED_STATES_ENGLISH - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
United States (English).
UNITED_STATES_SPANISH - Enum constant in enum class net.ygbstudio.jbrave.api.options.MarketLocale
United States (Spanish).
units() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Unit
Returns the value of the units record component.
units(Units) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds the units option to the URL query.
Units - Enum Class in net.ygbstudio.jbrave.api.options
Enumeration of the different units of measurement that can be used in the search methods.
UNITS - Static variable in interface net.ygbstudio.jbrave.core.domain.ProvidedOption
The URL parameter name for the units option ("units").
upvoteCount() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Answer
Returns the value of the upvoteCount record component.
url - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.Result
The result URL.
url - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing
The thing URL.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageResult
Returns the value of the url record component.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.Properties
Returns the value of the url record component.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.DataProvider
Returns the value of the url record component.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.InfoboxProfile
Returns the value of the url record component.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.profile.Profile
Returns the value of the url record component.
url() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result
Returns the result URL.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Action
Returns the value of the url record component.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ButtonResult
Returns the value of the url record component.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.HowTo
Returns the value of the url record component.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Image
Returns the value of the url record component.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ImageProperties
Returns the value of the url record component.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.MovieData
Returns the value of the url record component.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Offer
Returns the value of the url record component.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.QA
Returns the value of the url record component.
url() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the url record component.
url(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.Result.Builder
Sets the result URL.
url(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.thing.Thing.Builder
Sets the thing URL.
URL_PARAM - Static variable in interface net.ygbstudio.jbrave.core.domain.provided.CountryIdentifier
The URL parameter name for the country option ("country").
URL_PARAM - Static variable in interface net.ygbstudio.jbrave.core.domain.provided.LanguageIdentifier
The URL parameter name for the search language option ("search_lang").
URL_PARAM - Static variable in interface net.ygbstudio.jbrave.core.domain.provided.RegionLocaleIdentifier
The URL parameter name for the UI language option ("ui_lang").
urlEnd - Variable in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Buffer holding the query parameters appended after the query term.
urlParam() - Method in enum class net.ygbstudio.jbrave.api.filters.Freshness
 
urlParam() - Method in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
 
urlParam() - Method in enum class net.ygbstudio.jbrave.api.filters.SafeSearch
 
urlParam() - Method in enum class net.ygbstudio.jbrave.api.options.Country
 
urlParam() - Method in enum class net.ygbstudio.jbrave.api.options.MarketLocale
 
urlParam() - Method in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
 
urlParam() - Method in enum class net.ygbstudio.jbrave.api.options.Units
 
urlParam() - Method in interface net.ygbstudio.jbrave.core.domain.BraveAPIConstant
Returns the URL parameter associated with this constant.
urlParam() - Method in enum class net.ygbstudio.jbrave.core.domain.modes.SearchFilterMode
 
urlParam() - Method in enum class net.ygbstudio.jbrave.core.domain.verticals.BraveResource
 
urlParam() - Method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
 
urlParam(CountryIdentifier) - Static method in interface net.ygbstudio.jbrave.core.domain.provided.CountryIdentifier
Generates the URL parameter for this country identifier.
urlParam(LanguageIdentifier) - Static method in interface net.ygbstudio.jbrave.core.domain.provided.LanguageIdentifier
Generates the URL parameter for this language identifier.
urlParam(RegionLocaleIdentifier) - Static method in interface net.ygbstudio.jbrave.core.domain.provided.RegionLocaleIdentifier
Generates the URL parameter for this region-locale identifier.
urlStart - Variable in class net.ygbstudio.jbrave.core.builders.AbstractQueryUrlBuilder
Buffer holding the base URL (API base and selected vertical) before parameters are appended.
urlVertical(SearchVertical) - Static method in interface net.ygbstudio.jbrave.core.domain.SearchVertical
Creates a URL query string for the given search vertical.
USAGE_LIMIT_EXCEEDED - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveErrorCode
The usage limit for the current subscription has been exceeded.
USER_AGENT - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
User-Agent request header.

V

VALIDATION - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveErrorCode
The request failed request-body validation.
value() - Method in enum class net.ygbstudio.jbrave.api.filters.Freshness
 
value() - Method in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
 
value() - Method in enum class net.ygbstudio.jbrave.api.filters.SafeSearch
 
value() - Method in enum class net.ygbstudio.jbrave.api.options.Country
 
value() - Method in enum class net.ygbstudio.jbrave.api.options.MarketLocale
 
value() - Method in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
 
value() - Method in enum class net.ygbstudio.jbrave.api.options.Units
 
value() - Method in interface net.ygbstudio.jbrave.core.domain.BraveAPIConstant
Returns the value of the constant.
value() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Unit
Returns the value of the value record component.
value() - Method in enum class net.ygbstudio.jbrave.core.domain.modes.SearchFilterMode
 
value() - Method in interface net.ygbstudio.jbrave.core.domain.SearchHeader
Returns the value of the header.
value() - Method in enum class net.ygbstudio.jbrave.core.domain.verticals.BraveResource
 
value() - Method in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
 
value() - Method in record class net.ygbstudio.jbrave.core.model.BraveSearchHeader
Returns the value of the value record component.
value() - Method in record class net.ygbstudio.jbrave.core.model.BraveSearchOption
Returns the value of the value record component.
value() - Method in interface net.ygbstudio.jbrave.core.model.SearchOptionCarrier
Returns the value associated with this carrier.
value() - Method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
 
valueOf(String) - Static method in enum class net.ygbstudio.jbrave.api.filters.Freshness
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.jbrave.api.filters.SafeSearch
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.jbrave.api.options.Country
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.jbrave.api.options.Units
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.jbrave.core.domain.modes.SearchFilterMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.jbrave.core.domain.verticals.BraveResource
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.jbrave.core.model.BraveErrorCode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Returns the enum constant of this class with the specified name.
values() - Static method in enum class net.ygbstudio.jbrave.api.filters.Freshness
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.jbrave.api.filters.SafeSearch
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.jbrave.api.options.Country
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.jbrave.api.options.MarketLocale
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.jbrave.api.options.Units
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.jbrave.core.domain.modes.SearchFilterMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.jbrave.core.domain.verticals.BraveResource
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.jbrave.core.model.BraveErrorCode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.jbrave.core.model.BraveSearchOperator
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.jbrave.core.model.SearchOptions
Returns an array containing the constants of this enum class, in the order they are declared.
version() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Software
Returns the value of the version record component.
vertical() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.RichCallbackHint
Returns the value of the vertical record component.
VerticalHeaderBuilder<T> - Interface in net.ygbstudio.jbrave.core.builders
Configures the standard headers of a Brave vertical search request.
video - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
The video data for this result.
video - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
The video data for this result.
video() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult
Returns the video data.
video() - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult
Returns the video data.
video() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Recipe
Returns the value of the video record component.
video(VideoData) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.SearchResult.Builder
Sets the video data.
video(VideoData) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult.Builder
Sets the video data.
VIDEO - Enum constant in enum class net.ygbstudio.jbrave.core.domain.verticals.BraveResource
The video search resource.
VideoData - Record Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents video data in search results.
VideoData(String, String, String, String, Thumbnail, List<String>, Profile, Boolean) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.VideoData
Creates an instance of a VideoData record class.
VideoResult - Class in net.ygbstudio.jbrave.core.domain.dto.result
Represents a video result in search results.
VideoResult(VideoResult.Builder) - Constructor for class net.ygbstudio.jbrave.core.domain.dto.result.VideoResult
Creates a new video result from the given builder.
VideoResult.Builder - Class in net.ygbstudio.jbrave.core.domain.dto.result
Builder for VideoResult instances.
videos() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns the value of the videos record component.
videos() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.DeepResult
Returns the value of the videos record component.
Videos - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.search
Represents video information in search results.
Videos(String, List<VideoResult>, Boolean) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.search.Videos
Creates an instance of a Videos record class.
VIDEOS - Enum constant in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
Include video results.
VideoSearchApiResponse - Record Class in net.ygbstudio.jbrave.api.response
Represents the response from the Brave Search API for video searches.
VideoSearchApiResponse(String, Query, List<VideoResult>, Extra) - Constructor for record class net.ygbstudio.jbrave.api.response.VideoSearchApiResponse
Creates an instance of a VideoSearchApiResponse record class.
VIETNAMESE - Enum constant in enum class net.ygbstudio.jbrave.api.options.SearchLanguage
Vietnamese.
viewMoreUrl() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.PictureResults
Returns the value of the viewMoreUrl record component.
viewMoreUrl() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.Reviews
Returns the value of the viewMoreUrl record component.
views() - Method in record class net.ygbstudio.jbrave.core.domain.dto.result.VideoData
Returns the value of the views record component.

W

web() - Method in record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Returns the value of the web record component.
WEB - Enum constant in enum class net.ygbstudio.jbrave.api.filters.ResultFilter
Include standard web results.
WEB - Enum constant in enum class net.ygbstudio.jbrave.core.domain.verticals.BraveResource
The web search resource.
WebHeaderBuilder<T> - Interface in net.ygbstudio.jbrave.core.builders
Configures the web-specific headers of a Brave web search request.
WebQuery - Record Class in net.ygbstudio.jbrave.core.domain.dto.result.search
Represents web query information in search results.
WebQuery(String, String, String, Boolean, Boolean, Boolean, Boolean, String, Integer, Boolean, Boolean, Boolean, Language, Boolean, String, Boolean, Boolean, String, String, String, String, String, String, Boolean, String, String, String, SearchOperators) - Constructor for record class net.ygbstudio.jbrave.core.domain.dto.result.search.WebQuery
Creates an instance of a WebQuery record class.
WebSearchApiResponse - Record Class in net.ygbstudio.jbrave.api.response
Represents the top-level response from the Brave Search API.
WebSearchApiResponse(String, Discussions, FAQ, GraphInfobox, Locations, MixedResponse, News, WebQuery, Videos, Search, Summarizer, RichCallbackInfo) - Constructor for record class net.ygbstudio.jbrave.api.response.WebSearchApiResponse
Creates an instance of a WebSearchApiResponse record class.
websiteUrl - Variable in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox
The website URL associated with the infobox.
websiteUrl(String) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.AbstractGraphInfobox.Builder
Sets the website URL associated with the infobox.
width() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.ImageThumbnail
Returns the value of the width record component.
width() - Method in record class net.ygbstudio.jbrave.core.domain.dto.image.Properties
Returns the value of the width record component.
width() - Method in record class net.ygbstudio.jbrave.core.domain.dto.web.ImageProperties
Returns the value of the width record component.
windowMonth() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitPolicy
Returns the value of the windowMonth record component.
windowSecond() - Method in record class net.ygbstudio.jbrave.api.rate.XRateLimitPolicy
Returns the value of the windowSecond record component.
withApiVersion(String) - Method in class net.ygbstudio.jbrave.core.builders.BraveVerticalSearchRequest
Adds an API version header to the request.
withApiVersion(String) - Method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Adds an API version header to the request.
withApiVersion(String) - Method in interface net.ygbstudio.jbrave.core.builders.VerticalHeaderBuilder
Adds an API version header to the request.
withCacheControl(String) - Method in class net.ygbstudio.jbrave.core.builders.BraveVerticalSearchRequest
Adds a cache control header to the request.
withCacheControl(String) - Method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Adds a cache control header to the request.
withCacheControl(String) - Method in interface net.ygbstudio.jbrave.core.builders.VerticalHeaderBuilder
Adds a cache control header to the request.
withCity(String) - Method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Adds a city header to the request.
withCity(String) - Method in interface net.ygbstudio.jbrave.core.builders.WebHeaderBuilder
Adds a city header to the request.
withCountry(String) - Method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Adds a country header to the request.
withCountry(String) - Method in interface net.ygbstudio.jbrave.core.builders.WebHeaderBuilder
Adds a country header to the request.
withHeaders(Consumer<VerticalHeaderBuilder<BraveVerticalRequest>>) - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Sets the request headers using the provided consumer.
withHeaders(Consumer<VerticalHeaderBuilder<BraveVerticalRequest>>) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Sets the request headers using the provided consumer.
withHeaders(Consumer<VerticalHeaderBuilder<BraveVerticalRequest>>) - Method in class net.ygbstudio.jbrave.api.builders.BraveSpellcheckQuery
Sets the request headers using the provided consumer.
withHeaders(Consumer<VerticalHeaderBuilder<BraveVerticalRequest>>) - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
Sets the request headers using the provided consumer.
withHeaders(Consumer<VerticalHeaderBuilder<BraveVerticalRequest>>) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Sets the request headers using the provided consumer.
withHeaders(Consumer<WebHeaderBuilder<BraveWebRequest>>) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Sets the request headers using the provided consumer.
WITHIN_1Y - Enum constant in enum class net.ygbstudio.jbrave.api.filters.Freshness
Results discovered within the last year.
WITHIN_24H - Enum constant in enum class net.ygbstudio.jbrave.api.filters.Freshness
Results discovered within the last 24 hours.
WITHIN_31D - Enum constant in enum class net.ygbstudio.jbrave.api.filters.Freshness
Results discovered within the last 31 days.
WITHIN_7D - Enum constant in enum class net.ygbstudio.jbrave.api.filters.Freshness
Results discovered within the last 7 days.
withLatitude(double) - Method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Adds a latitude header to the request.
withLatitude(double) - Method in interface net.ygbstudio.jbrave.core.builders.WebHeaderBuilder
Adds a latitude header to the request.
withLongitude(double) - Method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Adds a longitude header to the request.
withLongitude(double) - Method in interface net.ygbstudio.jbrave.core.builders.WebHeaderBuilder
Adds a longitude header to the request.
withOperators(Consumer<SearchOperatorBuilder>) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Adds search operations to the query term for advanced result filtering.
withOperators(Consumer<SearchOperatorBuilder>) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Adds search operations to the query term for advanced result filtering.
withPostalCode(String) - Method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Adds a postal code header to the request.
withPostalCode(String) - Method in interface net.ygbstudio.jbrave.core.builders.WebHeaderBuilder
Adds a postal code header to the request.
withRetries(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Sets the maximum number of retry attempts for rate-limited (HTTP 429) responses.
withRetries(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Sets the maximum number of retry attempts for rate-limited (HTTP 429) responses.
withRetries(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveSpellcheckQuery
Sets the maximum number of retry attempts for rate-limited (HTTP 429) responses.
withRetries(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
Sets the maximum number of retry attempts for rate-limited (HTTP 429) responses.
withRetries(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Sets the maximum number of retry attempts for rate-limited (HTTP 429) responses.
withRetries(int) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Sets the maximum number of retry attempts for rate-limited (HTTP 429) responses.
withSearchOperators(Consumer<SearchOperatorBuilder>) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Adds search operations to the query term for advanced result filtering.
withState(String) - Method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Adds a state header to the request.
withState(String) - Method in interface net.ygbstudio.jbrave.core.builders.WebHeaderBuilder
Adds a state header to the request.
withStateName(String) - Method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Adds a state name header to the request.
withStateName(String) - Method in interface net.ygbstudio.jbrave.core.builders.WebHeaderBuilder
Adds a state name header to the request.
withTimezone(ZoneId) - Method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Adds a timezone header to the request.
withTimezone(ZoneId) - Method in interface net.ygbstudio.jbrave.core.builders.WebHeaderBuilder
Adds a timezone header to the request.
withToken(String) - Method in class net.ygbstudio.jbrave.core.builders.BraveVerticalSearchRequest
Adds a brave subscription token header to the request.
withToken(String) - Method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Adds a brave subscription token header to the request.
withToken(ClientInfo) - Method in class net.ygbstudio.jbrave.api.builders.BraveImageQuery
Sets the subscription token header using the provided ClientInfo instance.
withToken(ClientInfo) - Method in class net.ygbstudio.jbrave.api.builders.BraveNewsQuery
Sets the subscription token header using the provided ClientInfo instance.
withToken(ClientInfo) - Method in class net.ygbstudio.jbrave.api.builders.BraveSpellcheckQuery
Sets the subscription token header using the provided ClientInfo instance.
withToken(ClientInfo) - Method in class net.ygbstudio.jbrave.api.builders.BraveSuggestQuery
Sets the subscription token header using the provided ClientInfo instance.
withToken(ClientInfo) - Method in class net.ygbstudio.jbrave.api.builders.BraveVideoQuery
Sets the subscription token header using the provided ClientInfo instance.
withToken(ClientInfo) - Method in class net.ygbstudio.jbrave.api.builders.BraveWebQuery
Sets the subscription token header using the provided ClientInfo instance.
withUserAgent(String) - Method in class net.ygbstudio.jbrave.core.builders.BraveVerticalSearchRequest
Adds a user agent header to the request.
withUserAgent(String) - Method in class net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest
Adds a user agent header to the request.
withUserAgent(String) - Method in interface net.ygbstudio.jbrave.core.builders.VerticalHeaderBuilder
Adds a user agent header to the request.
write(File) - Method in interface net.ygbstudio.jbrave.api.response.ApiResponse
Writes the response object to a file on the filesystem.
writeJsonFs(File, T) - Static method in class net.ygbstudio.jbrave.core.utils.JsonSupport
Serializes an object and writes it to a JSON file on the filesystem.

X

X_RATE_LIMIT - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
X-RateLimit-Limit response header reporting the plan's request limit.
X_RATE_LIMIT_POLICY - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
X-RateLimit-Policy response header describing the rate-limit policy.
X_RATE_LIMIT_REMAINING - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
X-RateLimit-Remaining response header reporting the remaining request quota.
X_RATE_LIMIT_RESET - Enum constant in enum class net.ygbstudio.jbrave.core.model.BraveHeaders
X-RateLimit-Reset response header reporting the time until the quota resets.
xRateLimit() - Method in record class net.ygbstudio.jbrave.api.response.RateLimitResponse
Returns the value of the xRateLimit record component.
XRateLimit - Record Class in net.ygbstudio.jbrave.api.rate
Shows the maximum number of requests allowed for each time window in your plan.
XRateLimit(int, int) - Constructor for record class net.ygbstudio.jbrave.api.rate.XRateLimit
Creates an instance of a XRateLimit record class.
xRateLimitPolicy() - Method in record class net.ygbstudio.jbrave.api.response.RateLimitResponse
Returns the value of the xRateLimitPolicy record component.
XRateLimitPolicy - Record Class in net.ygbstudio.jbrave.api.rate
Provides the complete policy specification including time window sizes.
XRateLimitPolicy(int, int, int, int) - Constructor for record class net.ygbstudio.jbrave.api.rate.XRateLimitPolicy
Creates an instance of a XRateLimitPolicy record class.
XRateLimitRemaining - Record Class in net.ygbstudio.jbrave.api.rate
Indicates how many requests you can still make within each time window before hitting the limit.
XRateLimitRemaining(int, int) - Constructor for record class net.ygbstudio.jbrave.api.rate.XRateLimitRemaining
Creates an instance of a XRateLimitRemaining record class.
xRateLimitReset() - Method in record class net.ygbstudio.jbrave.api.response.RateLimitResponse
Returns the value of the xRateLimitReset record component.
XRateLimitReset - Record Class in net.ygbstudio.jbrave.api.rate
Shows when each quota window will reset, expressed in seconds from now.
XRateLimitReset(int, int, Instant) - Constructor for record class net.ygbstudio.jbrave.api.rate.XRateLimitReset
Creates an instance of a XRateLimitReset record class.
xRateRemaining() - Method in record class net.ygbstudio.jbrave.api.response.RateLimitResponse
Returns the value of the xRateRemaining record component.

Z

zoomLevel(Integer) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.InfoboxWithLocation.Builder
Sets the zoom level.
zoomLevel(Integer) - Method in class net.ygbstudio.jbrave.core.domain.dto.result.LocationResult.Builder
Sets the zoom level.
A B C D E F G H I J K L M N O P Q R S T U V W X Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form