org.hibernate.search.backend.elasticsearch.search.query

Interface ElasticsearchSearchRequestTransformerContext

public interface ElasticsearchSearchRequestTransformerContext

The context passed to ElasticsearchSearchRequestTransformer.transform(ElasticsearchSearchRequestTransformerContext).

WARNING: Direct changes to the request may conflict with Hibernate Search features and be supported differently by different versions of Elasticsearch. Thus they cannot be guaranteed to continue to work when upgrading Hibernate Search, even for micro upgrades (x.y.z to x.y.(z+1)). Use this at your own risk.

Experimental

This type is under active development. Usual compatibility policies do not apply: incompatible changes may be introduced in any future release.

Method Summary

Modifier and Type	Method and Description
com.google.gson.JsonObject	getBody()
Map<String,String>	getParametersMap()
String	getPath()
void	setPath(String newPath) Set a new path for the HTTP request for this search.

Method Detail

getPath

String getPath()

Returns:

The URL-encoded path of the HTTP request for this search.

setPath

void setPath(String newPath)

Set a new path for the HTTP request for this search.

Parameters:

newPath - A HTTP path, already URL-encoded. Should not include the query parameters (?foo=bar&...): use getParametersMap() for that instead.

getParametersMap

Map<String,String> getParametersMap()

Returns:

A (mutable) representation of the HTTP query parameters for this search, as a Map. The query parameters are not URL-encoded.

getBody

com.google.gson.JsonObject getBody()

Returns:

A (mutable) representation of the HTTP request body for this search, as a JsonObject.