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

@JsonpDeserializable
public class DocumentRating
extends java.lang.Object
implements JsonpSerializable

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 JsonpDeserializer<DocumentRating>	_DESERIALIZER	Json deserializer for DocumentRating

Method Summary

Modifier and Type	Method	Description
java.lang.String	id()	Required - The document ID.
java.lang.String	index()	Required - The document's index.
static DocumentRating	of(java.util.function.Function<DocumentRating.Builder,ObjectBuilder<DocumentRating>> fn)
int	rating()	Required - The document's relevance with regard to this 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)

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<DocumentRating> _DESERIALIZER

Json deserializer for DocumentRating

Method Detail

of

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

id

public final java.lang.String id()

Required - The document ID.

API name: _id

index

public final java.lang.String index()

Required - The document's index. For data streams, this should be the document's backing index.

API name: _index

rating

public final int rating()

Required - The document's relevance with regard to this 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)

setupDocumentRatingDeserializer

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