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

Class DocumentRating.Builder

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<DocumentRating>

Enclosing class:

DocumentRating

public static class DocumentRating.Builder
extends java.lang.Object
implements ObjectBuilder<DocumentRating>

Builder for DocumentRating.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DocumentRating	build()	Builds a DocumentRating.
DocumentRating.Builder	id(java.lang.String value)	The document ID.
DocumentRating.Builder	index(java.lang.String value)	The document's index.
DocumentRating.Builder	rating(java.lang.Number value)	The document's relevance with regard to this search request.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

id

public DocumentRating.Builder id(java.lang.String value)

The document ID. API name: _id

index

public DocumentRating.Builder index(java.lang.String value)

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

rating

public DocumentRating.Builder rating(java.lang.Number value)

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

build

public DocumentRating build()

Builds a DocumentRating.

Specified by:

build in interface ObjectBuilder<DocumentRating>

Throws:

java.lang.NullPointerException - if some of the required fields are null.