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

Class RankEvalRequestItem

java.lang.Object

org.opensearch.client.opensearch.core.rank_eval.RankEvalRequestItem

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<RankEvalRequestItem.Builder,RankEvalRequestItem>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class RankEvalRequestItem
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<RankEvalRequestItem.Builder,RankEvalRequestItem>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RankEvalRequestItem.Builder	Builder for RankEvalRequestItem.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<RankEvalRequestItem>	_DESERIALIZER	Json deserializer for RankEvalRequestItem

Method Summary

Modifier and Type	Method	Description
static RankEvalRequestItem.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	id()	Required - API name: id
static RankEvalRequestItem	of(Function<RankEvalRequestItem.Builder,ObjectBuilder<RankEvalRequestItem>> fn)
final Map<String,JsonData>	params()	The search template parameters.
final List<DocumentRating>	ratings()	Required - A list of document ratings.
final RankEvalQuery	request()	API name: request
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRankEvalRequestItemDeserializer(ObjectDeserializer<RankEvalRequestItem.Builder> op)
final String	templateId()	API name: template_id
RankEvalRequestItem.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RankEvalRequestItem> _DESERIALIZER

Json deserializer for RankEvalRequestItem

Method Details

of

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

id

@Nonnull
public final String id()

Required - API name: id

params

@Nonnull
public final Map<String,JsonData> params()

The search template parameters.

API name: params

ratings

@Nonnull
public final List<DocumentRating> ratings()

Required - A list of document ratings.

API name: ratings

request

@Nullable
public final RankEvalQuery request()

API name: request

templateId

@Nullable
public final String templateId()

API name: template_id

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public RankEvalRequestItem.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RankEvalRequestItem.Builder,RankEvalRequestItem>

Returns:

a new builder instance.

builder

@Nonnull
public static RankEvalRequestItem.Builder builder()

setupRankEvalRequestItemDeserializer

protected static void setupRankEvalRequestItemDeserializer(ObjectDeserializer<RankEvalRequestItem.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object