Package org.opensearch.client.opensearch.core.rank_eval

Class RankEvalHit.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.rank_eval.RankEvalHit.Builder

All Implemented Interfaces:

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

Enclosing class:

RankEvalHit

public static class RankEvalHit.Builder
extends ObjectBuilderBase
implements CopyableBuilder<RankEvalHit.Builder,RankEvalHit>

Builder for RankEvalHit.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalHit	build()	Builds a RankEvalHit.
RankEvalHit.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RankEvalHit.Builder	id(String value)	Required - API name: _id
final RankEvalHit.Builder	index(String value)	Required - API name: _index
final RankEvalHit.Builder	score(double value)	Required - API name: _score

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 RankEvalHit.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<RankEvalHit.Builder,RankEvalHit>

Returns:

a new builder instance.

id

@Nonnull
public final RankEvalHit.Builder id(String value)

Required - API name: _id

index

@Nonnull
public final RankEvalHit.Builder index(String value)

Required - API name: _index

score

@Nonnull
public final RankEvalHit.Builder score(double value)

Required - API name: _score

build

@Nonnull
public RankEvalHit build()

Builds a RankEvalHit.

Specified by:

build in interface ObjectBuilder<RankEvalHit>

Throws:

NullPointerException - if some of the required fields are null.