The Bridge is the class responsible for marshalling a query to and from the search service.
Constructor to create a bridge object that connects to the search api.
Constructor to create a bridge object that connects to the search api.
Constructor to create a bridge object that connects to the search api.
Constructor to create a bridge object that connects to the search api.
Sets any additional parameters that can be used to trigger rules.
Sets any additional parameters that can be used to trigger rules.
Helper method that takes a ~ separated string of additional parameters that can be
used to trigger rules.
Specify which navigations should not be returned.
Specify which fields should be returned on each record that comes back from the engine.
An array that specifies which navigations should be returned.
Specify which fields should be queried with 'OR' instead of the default 'AND'.
Add a range refinement.
Add a range refinement.
Set up a mapping for a refinement.
A helper method to parse and set refinements.
Adds a new replacement rule that will be applied to the search term and mapped refinements.
Adds a new replacement rule that will only be applied to the specified refinement.
Add a value refinement.
Add a value refinement.
Clean up all mappings.
Constructor to create a bridge object that connects to the Search API.
Constructor to create a bridge object that connects to the search api.
Create a UrlBeautifier and store it for the lifetime of this JVM under the name specified.
Convert a URI into a query object.
Convert a URI into a query object.
Generates a secured payload
Generates a secured payload
Generates a secured payload
Return the current appended URL segment
Used internally by the bridge object to generate the JSON that is sent to the search service.
Used internally by the bridge object to generate the JSON that is sent to the search service.
Get a map of UrlBeautifiers keyed by name.
Connects to the refinements service, parses the response into a model
Retrieves at most 10,000 refinements for the navigation specified.
Connects to the search service, parses the response into a model
Quite often URLs need to end with specific extensions to map to the correct controller in the backend.
The area you wish to fire against, production, staging, etc...
Add a biasing profile, which is defined at query time.
Override the biasing profile used for this query - takes precedence over any
biasing profile set in the command center.
Url Parameter to indicate whether this query is bot traffic or not.
If using the semantic layer, this tells the semantic layer to not cache the response.
The collection to use.
Specifies whether the auto-correction behavior should be disabled.
Set a list of headers.
Sets the language filter on the query and restricts the results to a certain language.
A match strategy allows you to explicitly manage recall on a per query basis.
Override the match strategy used for this query - takes precedence over any
match strategy set in the command center.
Sets the maximum number of times to try a request before returning an error.
Page size.
Add pinned value refinement.
By default, the engine will return up to twenty refinements for a navigation.
| Parameter | Default State |
|----|----|
|`pruneRefinements` | `true` |
By default, the engine will only return refinements that make a difference in the returned results.
Set a search string.
Sets the query level url parameters.
Sets the name of the query parameter with which non-mapped refinements will show up in the query string.
Warning This will count as two queries against your search index.
Warning See Query.setRestrictNavigation(RestrictNavigation).
Sets the retry timeout for a failed request.
Tells the search service to return binary data.
Set the mapping from a search term to a path segment.
Add a secured payload to the query.
A unique string identifier of the session that your customer is currently in.
Tell the search service to offset by N records.
Specifies the sort order applied to the fields in the order specified.
A unique string identifier of an end customer.
Indicate if the *(star) character in the search string should be treated as a wildcard prefix search.
Cleanup HTTP connection pool.UrlBeautifier.toUrl(String, Map) ()}
Convert a search term and a list of refinements into a beautified URL.Copyright © 2013–2019 GroupBy Inc.. All rights reserved.