java.lang.Object

org.opensearch.index.rankeval.RatedDocument

public class RatedDocument
extends java.lang.Object
implements Writeable, ToXContentObject

Represents a document (specified by its _index/_id) and its corresponding rating with respect to a specific search query.

The json structure of this element in a request:

 {
   "_index": "my_index",
   "_id": "doc1",
   "rating": 0
 }

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
Field Summary

Fields inherited from interface org.opensearch.common.xcontent.ToXContent
EMPTY_PARAMS
Constructor Summary

Constructors

Constructor Description

RatedDocument(java.lang.String index, java.lang.String id, int rating)

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDocID()`
`java.lang.String`	`getIndex()`
`org.opensearch.index.rankeval.RatedDocument.DocumentKey`	`getKey()`
`int`	`getRating()`
`int`	`hashCode()`
`java.lang.String`	`toString()`
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`
`void`	`writeTo(StreamOutput out)`

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

isFragment

Constructor Details
- RatedDocument
  
  public RatedDocument(java.lang.String index, java.lang.String id, int rating)
Method Details
- getKey
  
  public org.opensearch.index.rankeval.RatedDocument.DocumentKey getKey()
- getIndex
  
  public java.lang.String getIndex()
- getDocID
  
  public java.lang.String getDocID()
- getRating
  
  public int getRating()
- writeTo
  
  public void writeTo(StreamOutput out) throws java.io.IOException
  
  Specified by:
  
  writeTo in interface Writeable
  
  Throws:
  
  java.io.IOException
- toXContent
  
  public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
  
  Specified by:
  
  toXContent in interface ToXContent
  
  Throws:
  
  java.io.IOException
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object
- equals
  
  public final boolean equals(java.lang.Object obj)
  
  Overrides:
  
  equals in class java.lang.Object
- hashCode
  
  public final int hashCode()
  
  Overrides:
  
  hashCode in class java.lang.Object

Class RatedDocument