Package org.hibernate.search.backend.elasticsearch.search.aggregation.dsl

Interface ElasticsearchSearchAggregationFactory

All Superinterfaces:
org.hibernate.search.engine.search.aggregation.dsl.ExtendedSearchAggregationFactory<ElasticsearchSearchAggregationFactory,ElasticsearchSearchPredicateFactory>, org.hibernate.search.engine.search.aggregation.dsl.SearchAggregationFactory
public interface ElasticsearchSearchAggregationFactory extends org.hibernate.search.engine.search.aggregation.dsl.ExtendedSearchAggregationFactory<ElasticsearchSearchAggregationFactory,ElasticsearchSearchPredicateFactory>

  • Method Summary

    Modifier and Type
    Method
    Description
    org.hibernate.search.engine.search.aggregation.dsl.AggregationFinalStep<com.google.gson.JsonObject>
    fromJson(com.google.gson.JsonObject jsonObject)
    Create an aggregation from JSON.
    org.hibernate.search.engine.search.aggregation.dsl.AggregationFinalStep<com.google.gson.JsonObject>
    fromJson(String jsonString)
    Create an aggregation from JSON.

    Methods inherited from interface org.hibernate.search.engine.search.aggregation.dsl.ExtendedSearchAggregationFactory

    range, terms, withRoot

    Methods inherited from interface org.hibernate.search.engine.search.aggregation.dsl.SearchAggregationFactory

    extension, toAbsolutePath, withParameters

  • Method Details

    • fromJson

      org.hibernate.search.engine.search.aggregation.dsl.AggregationFinalStep<com.google.gson.JsonObject> fromJson(com.google.gson.JsonObject jsonObject)
      Create an aggregation from JSON.

      The created aggregation will return the result as a JsonObject.

      Parameters:
      jsonObject - A JsonObject representing an Elasticsearch aggregation. The JSON object must be a syntactically correct Elasticsearch aggregation. See the Elasticsearch documentation.
      Returns:
      The final step of the aggregation DSL.

    • fromJson

      org.hibernate.search.engine.search.aggregation.dsl.AggregationFinalStep<com.google.gson.JsonObject> fromJson(String jsonString)
      Create an aggregation from JSON.

      The created aggregation will return the result as a JsonObject.

      Parameters:
      jsonString - A JSON-formatted string representing an Elasticsearch aggregation. The JSON object must be a syntactically correct Elasticsearch aggregation. See the Elasticsearch documentation.
      Returns:
      The final step of the aggregation DSL.