Package co.elastic.clients.elasticsearch._types.query_dsl

Class PercolateQuery

java.lang.Object
co.elastic.clients.elasticsearch._types.query_dsl.QueryBase
co.elastic.clients.elasticsearch._types.query_dsl.PercolateQuery
All Implemented Interfaces:
QueryVariant, JsonpSerializable
@JsonpDeserializable public class PercolateQuery extends QueryBase implements QueryVariant
See Also:

  • Field Details

  • Method Details

    • of

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

    • _queryKind

      public Query.Kind _queryKind()
      Query variant kind.
      Specified by:
      _queryKind in interface QueryVariant

    • document

      @Nullable public final JsonData document()
      The source of the document being percolated.

      API name: document

    • documents

      public final List<JsonData> documents()
      An array of sources of the documents being percolated.

      API name: documents

    • field

      public final String field()
      Required - Field that holds the indexed queries. The field must use the percolator mapping type.

      API name: field

    • id

      @Nullable public final String id()
      The ID of a stored document to percolate.

      API name: id

    • index

      @Nullable public final String index()
      The index of a stored document to percolate.

      API name: index

    • name

      @Nullable public final String name()
      The suffix used for the _percolator_document_slot field when multiple percolate queries are specified.

      API name: name

    • preference

      @Nullable public final String preference()
      Preference used to fetch document to percolate.

      API name: preference

    • routing

      @Nullable public final String routing()
      Routing used to fetch document to percolate.

      API name: routing

    • version

      @Nullable public final Long version()
      The expected version of a stored document to percolate.

      API name: version

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class QueryBase

    • setupPercolateQueryDeserializer

      protected static void setupPercolateQueryDeserializer(ObjectDeserializer<PercolateQuery.Builder> op)