Package org.opensearch.client.opensearch.core

Class RankEvalRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<RankEvalRequest.Builder>

org.opensearch.client.opensearch.core.RankEvalRequest.Builder

All Implemented Interfaces:

CopyableBuilder<RankEvalRequest.Builder,RankEvalRequest>, MutableBuilder<RankEvalRequest.Builder,RankEvalRequest>, ObjectBuilder<RankEvalRequest>

Enclosing class:

RankEvalRequest

public static class RankEvalRequest.Builder
extends RequestBase.AbstractBuilder<RankEvalRequest.Builder>
implements CopyableBuilder<RankEvalRequest.Builder,RankEvalRequest>

Builder for RankEvalRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final RankEvalRequest.Builder	allowNoIndices(Boolean value)	If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.
RankEvalRequest	build()	Builds a RankEvalRequest.
RankEvalRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RankEvalRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indexes that are open, closed or both.
final RankEvalRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indexes that are open, closed or both.
final RankEvalRequest.Builder	ignoreUnavailable(Boolean value)	If true, missing or closed indexes are not included in the response.
final RankEvalRequest.Builder	index(String value, String... values)	Comma-separated list of data streams, indexes, and index aliases used to limit the request.
final RankEvalRequest.Builder	index(List<String> list)	Comma-separated list of data streams, indexes, and index aliases used to limit the request.
final RankEvalRequest.Builder	metric(Function<RankEvalMetric.Builder,ObjectBuilder<RankEvalMetric>> fn)	API name: metric
final RankEvalRequest.Builder	metric(RankEvalMetric value)	API name: metric
final RankEvalRequest.Builder	requests(Function<RankEvalRequestItem.Builder,ObjectBuilder<RankEvalRequestItem>> fn)	Required - A set of typical search requests, together with their provided ratings.
final RankEvalRequest.Builder	requests(List<RankEvalRequestItem> list)	Required - A set of typical search requests, together with their provided ratings.
final RankEvalRequest.Builder	requests(RankEvalRequestItem value, RankEvalRequestItem... values)	Required - A set of typical search requests, together with their provided ratings.
final RankEvalRequest.Builder	searchType(SearchType value)	Search operation type
protected RankEvalRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public RankEvalRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<RankEvalRequest.Builder,RankEvalRequest>

Returns:

a new builder instance.

self

@Nonnull
protected RankEvalRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RankEvalRequest.Builder>

allowNoIndices

@Nonnull
public final RankEvalRequest.Builder allowNoIndices(@Nullable
 Boolean value)

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. 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

@Nonnull
public final RankEvalRequest.Builder expandWildcards(List<ExpandWildcard> list)

Whether to expand wildcard expression to concrete indexes that are open, closed or both.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

@Nonnull
public final RankEvalRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

Whether to expand wildcard expression to concrete indexes that are open, closed or both.

API name: expand_wildcards

Adds one or more values to expandWildcards.

ignoreUnavailable

@Nonnull
public final RankEvalRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

If true, missing or closed indexes are not included in the response.

API name: ignore_unavailable

index

@Nonnull
public final RankEvalRequest.Builder index(List<String> list)

Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard (*) expressions are supported. To target all data streams and indexes in a cluster, omit this parameter or use _all or *.

API name: index

Adds all elements of list to index.

index

@Nonnull
public final RankEvalRequest.Builder index(String value,
 String... values)

Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard (*) expressions are supported. To target all data streams and indexes in a cluster, omit this parameter or use _all or *.

API name: index

Adds one or more values to index.

metric

@Nonnull
public final RankEvalRequest.Builder metric(@Nullable
 RankEvalMetric value)

API name: metric

metric

@Nonnull
public final RankEvalRequest.Builder metric(Function<RankEvalMetric.Builder,ObjectBuilder<RankEvalMetric>> fn)

API name: metric

requests

@Nonnull
public final RankEvalRequest.Builder requests(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

@Nonnull
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

@Nonnull
public final RankEvalRequest.Builder requests(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

@Nonnull
public final RankEvalRequest.Builder searchType(@Nullable
 SearchType value)

Search operation type

API name: search_type

build

@Nonnull
public RankEvalRequest build()

Builds a RankEvalRequest.

Specified by:

build in interface ObjectBuilder<RankEvalRequest>

Throws:

NullPointerException - if some of the required fields are null.