Package co.elastic.clients.elasticsearch.query_rules

Class QueryRuleCriteria.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<QueryRuleCriteria.Builder>
co.elastic.clients.elasticsearch.query_rules.QueryRuleCriteria.Builder
All Implemented Interfaces:
WithJson<QueryRuleCriteria.Builder>, ObjectBuilder<QueryRuleCriteria>
Enclosing class:
QueryRuleCriteria
public static class QueryRuleCriteria.Builder extends WithJsonObjectBuilderBase<QueryRuleCriteria.Builder> implements ObjectBuilder<QueryRuleCriteria>
Builder for QueryRuleCriteria.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • type

      public final QueryRuleCriteria.Builder type(QueryRuleCriteriaType value)
      Required - The type of criteria. The following criteria types are supported:
      • always: Matches all queries, regardless of input.
      • contains: Matches that contain this value anywhere in the field meet the criteria defined by the rule. Only applicable for string values.
      • exact: Only exact matches meet the criteria defined by the rule. Applicable for string or numerical values.
      • fuzzy: Exact matches or matches within the allowed Levenshtein Edit Distance meet the criteria defined by the rule. Only applicable for string values.
      • gt: Matches with a value greater than this value meet the criteria defined by the rule. Only applicable for numerical values.
      • gte: Matches with a value greater than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values.
      • lt: Matches with a value less than this value meet the criteria defined by the rule. Only applicable for numerical values.
      • lte: Matches with a value less than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values.
      • prefix: Matches that start with this value meet the criteria defined by the rule. Only applicable for string values.
      • suffix: Matches that end with this value meet the criteria defined by the rule. Only applicable for string values.

      API name: type

    • metadata

      public final QueryRuleCriteria.Builder metadata(@Nullable String value)
      The metadata field to match against. This metadata will be used to match against match_criteria sent in the rule. It is required for all criteria types except always.

      API name: metadata

    • values

      public final QueryRuleCriteria.Builder values(List<JsonData> list)
      The values to match against the metadata field. Only one value must match for the criteria to be met. It is required for all criteria types except always.

      API name: values

      Adds all elements of list to values.

    • values

      public final QueryRuleCriteria.Builder values(JsonData value, JsonData... values)
      The values to match against the metadata field. Only one value must match for the criteria to be met. It is required for all criteria types except always.

      API name: values

      Adds one or more values to values.

    • self

      protected QueryRuleCriteria.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<QueryRuleCriteria.Builder>

    • build

      public QueryRuleCriteria build()
      Builds a QueryRuleCriteria.
      Specified by:
      build in interface ObjectBuilder<QueryRuleCriteria>
      Throws:
      NullPointerException - if some of the required fields are null.