Package org.opensearch.client.opensearch._global.rank_eval

Class DocumentRating

java.lang.Object

org.opensearch.client.opensearch._global.rank_eval.DocumentRating

All Implemented Interfaces:

ToJsonp

public final class DocumentRating
extends java.lang.Object
implements ToJsonp

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DocumentRating(DocumentRating.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.String	id()	The document ID.
java.lang.String	index()	The document's index.
java.lang.Number	rating()	The document's relevance with regard to this search request.
protected static void	setupDocumentRatingDeserializer(DelegatingDeserializer<DocumentRating.Builder> op)
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<DocumentRating> DESERIALIZER

Json deserializer for DocumentRating

Constructor Details

DocumentRating

protected DocumentRating(DocumentRating.Builder builder)

Method Details

id

public java.lang.String id()

The document ID. API name: _id

index

public java.lang.String index()

The document's index. For data streams, this should be the document's backing index. API name: _index

rating

public java.lang.Number rating()

The document's relevance with regard to this search request. API name: rating

toJsonp

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

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

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

setupDocumentRatingDeserializer

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