Package co.elastic.clients.elasticsearch.rollup

Class RollupSearchRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.rollup.RollupSearchRequest
All Implemented Interfaces:
JsonpSerializable
@Deprecated @JsonpDeserializable public class RollupSearchRequest extends RequestBase implements JsonpSerializable
Deprecated.
8.11.0
Search rolled-up data. The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.

The request body supports a subset of features from the regular search API. The following functionality is not available:

size: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely. highlighter, suggestors, post_filter, profile, explain: These are similarly disallowed.

For more detailed examples of using the rollup search API, including querying rolled-up data only or combining rolled-up and live data, refer to the External documentation.

See Also:

  • Field Details

  • Method Details

    • of

      public static RollupSearchRequest of(Function<RollupSearchRequest.Builder,ObjectBuilder<RollupSearchRequest>> fn)
      Deprecated.

    • aggregations

      public final Map<String,Aggregation> aggregations()
      Deprecated.
      Specifies aggregations.

      API name: aggregations

    • index

      public final List<String> index()
      Deprecated.
      Required - A comma-separated list of data streams and indices used to limit the request. This parameter has the following rules:
      • At least one data stream, index, or wildcard expression must be specified. This target can include a rollup or non-rollup index. For data streams, the stream's backing indices can only serve as non-rollup indices. Omitting the parameter or using _all are not permitted.
      • Multiple non-rollup indices may be specified.
      • Only one rollup index may be specified. If more than one are supplied, an exception occurs.
      • Wildcard expressions (*) may be used. If they match more than one rollup index, an exception occurs. However, you can use an expression to match multiple non-rollup indices or data streams.

      API name: index

    • query

      @Nullable public final Query query()
      Deprecated.
      Specifies a DSL query that is subject to some limitations.

      API name: query

    • size

      @Nullable public final Integer size()
      Deprecated.
      Must be zero if set, as rollups work on pre-aggregated data.

      API name: size

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Deprecated.
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Deprecated.

    • setupRollupSearchRequestDeserializer

      protected static void setupRollupSearchRequestDeserializer(ObjectDeserializer<RollupSearchRequest.Builder> op)
      Deprecated.

    • createRollupSearchEndpoint

      public static <TDocument> Endpoint<RollupSearchRequest,RollupSearchResponse<TDocument>,ErrorResponse> createRollupSearchEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)
      Deprecated.
      Create an "rollup.rollup_search" endpoint.