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

Interface ElasticsearchSearchRequestTransformerContext

@Incubating 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.

  • Method Summary

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

  • Method Details

    • path

      String path()
      Returns:
      The URL-encoded path of the HTTP request for this search.

    • path

      void path(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 parametersMap() for that instead.

    • parametersMap

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

    • body

      com.google.gson.JsonObject body()
      Returns:
      A (mutable) representation of the HTTP request body for this search, as a JsonObject.