Package co.elastic.clients.elasticsearch.core.msearch

Class MultisearchHeader

java.lang.Object
co.elastic.clients.elasticsearch.core.msearch.MultisearchHeader
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class MultisearchHeader extends Object implements JsonpSerializable
Contains parameters used to limit or change the subsequent search body request.
See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      API name: allow_no_indices

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      API name: expand_wildcards

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      API name: ignore_unavailable

    • index

      public final List<String> index()
      API name: index

    • preference

      @Nullable public final String preference()
      API name: preference

    • projectRouting

      @Nullable public final String projectRouting()
      API name: project_routing

    • requestCache

      @Nullable public final Boolean requestCache()
      API name: request_cache

    • routing

      public final List<String> routing()
      API name: routing

    • searchType

      @Nullable public final SearchType searchType()
      API name: search_type

    • ccsMinimizeRoundtrips

      @Nullable public final Boolean ccsMinimizeRoundtrips()
      API name: ccs_minimize_roundtrips

    • allowPartialSearchResults

      @Nullable public final Boolean allowPartialSearchResults()
      API name: allow_partial_search_results

    • ignoreThrottled

      @Nullable public final Boolean ignoreThrottled()
      API name: ignore_throttled

    • serialize

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

    • serializeInternal

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • rebuild

      public MultisearchHeader.Builder rebuild()
      Returns:
      New MultisearchHeader.Builder initialized with field values of this instance

    • setupMultisearchHeaderDeserializer

      protected static void setupMultisearchHeaderDeserializer(ObjectDeserializer<MultisearchHeader.Builder> op)