Package co.elastic.clients.elasticsearch.core

Class RankEvalRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final RankEvalRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      API name: allow_no_indices

    • expandWildcards

      public final RankEvalRequest.Builder expandWildcards​(java.util.List<ExpandWildcard> list)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final RankEvalRequest.Builder expandWildcards​(ExpandWildcard value, ExpandWildcard... values)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • ignoreUnavailable

      public final RankEvalRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      If true, missing or closed indices are not included in the response.

      API name: ignore_unavailable

    • index

      public final RankEvalRequest.Builder index​(java.util.List<java.lang.String> list)
      Required - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (*) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.

      API name: index

      Adds all elements of list to index.

    • index

      public final RankEvalRequest.Builder index​(java.lang.String value, java.lang.String... values)
      Required - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (*) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.

      API name: index

      Adds one or more values to index.

    • metric

      public final RankEvalRequest.Builder metric​(@Nullable RankEvalMetric value)
      Definition of the evaluation metric to calculate

      API name: metric

    • metric

      public final RankEvalRequest.Builder metric​(java.util.function.Function<RankEvalMetric.Builder,​ObjectBuilder<RankEvalMetric>> fn)
      Definition of the evaluation metric to calculate

      API name: metric

    • requests

      public final RankEvalRequest.Builder requests​(java.util.List<RankEvalRequestItem> list)
      Required - A set of typical search requests, together with their provided ratings

      API name: requests

      Adds all elements of list to requests.

    • requests

      public final RankEvalRequest.Builder requests​(RankEvalRequestItem value, RankEvalRequestItem... values)
      Required - A set of typical search requests, together with their provided ratings

      API name: requests

      Adds one or more values to requests.

    • requests

      public final RankEvalRequest.Builder requests​(java.util.function.Function<RankEvalRequestItem.Builder,​ObjectBuilder<RankEvalRequestItem>> fn)
      Required - A set of typical search requests, together with their provided ratings

      API name: requests

      Adds a value to requests using a builder lambda.

    • searchType

      public final RankEvalRequest.Builder searchType​(@Nullable java.lang.String value)
      Search operation type

      API name: search_type

    • self

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

    • build

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