DocumentRating (java-client 7.15.2 API)

java.lang.Object

co.elastic.clients.elasticsearch.core.rank_eval.DocumentRating

All Implemented Interfaces:: JsonpSerializable

@JsonpDeserializable
public final 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

Constructor Summary

Constructors
Constructor	Description
`DocumentRating(DocumentRating.Builder builder)`
`DocumentRating(java.util.function.Function<DocumentRating.Builder,DocumentRating.Builder> fn)`

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`id()`	Required - The document ID.
`java.lang.String`	`index()`	Required - The document’s index.
`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(DelegatingDeserializer<DocumentRating.Builder> op)`

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
  
  public DocumentRating(DocumentRating.Builder builder)
- DocumentRating
  
  public DocumentRating(java.util.function.Function<DocumentRating.Builder,DocumentRating.Builder> fn)
Method Details
- id
  
  public java.lang.String id()
  
  Required - The document ID.
  API name: _id
- index
  
  public 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 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(DelegatingDeserializer<DocumentRating.Builder> op)