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

Class DocumentRating

java.lang.Object

org.opensearch.client.opensearch.core.rank_eval.DocumentRating

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static DocumentRating.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	id()	Required - API name: _id
final String	index()	Required - API name: _index
static DocumentRating	of(Function<DocumentRating.Builder,ObjectBuilder<DocumentRating>> fn)
final int	rating()	Required - The document's relevance with regard to the specified search 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	setupDocumentRatingDeserializer(ObjectDeserializer<DocumentRating.Builder> op)
DocumentRating.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<DocumentRating> _DESERIALIZER

Json deserializer for DocumentRating

Method Details

of

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

id

@Nonnull
public final String id()

Required - API name: _id

index

@Nonnull
public final String index()

Required - API name: _index

rating

public final int rating()

Required - The document's relevance with regard to the specified search request.

API name: rating

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

Returns:

a new builder instance.

builder

@Nonnull
public static DocumentRating.Builder builder()

setupDocumentRatingDeserializer

protected static void setupDocumentRatingDeserializer(ObjectDeserializer<DocumentRating.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object