Package org.opensearch.client.opensearch.core.rank_eval

Class DocumentRating.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.rank_eval.DocumentRating.Builder

All Implemented Interfaces:

CopyableBuilder<DocumentRating.Builder,DocumentRating>, MutableBuilder<DocumentRating.Builder,DocumentRating>, ObjectBuilder<DocumentRating>

Enclosing class:

DocumentRating

public static class DocumentRating.Builder
extends ObjectBuilderBase
implements CopyableBuilder<DocumentRating.Builder,DocumentRating>

Builder for DocumentRating.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DocumentRating	build()	Builds a DocumentRating.
DocumentRating.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DocumentRating.Builder	id(String value)	Required - API name: _id
final DocumentRating.Builder	index(String value)	Required - API name: _index
final DocumentRating.Builder	rating(int value)	Required - The document's relevance with regard to the specified search request.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public DocumentRating.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<DocumentRating.Builder,DocumentRating>

Returns:

a new builder instance.

id

@Nonnull
public final DocumentRating.Builder id(String value)

Required - API name: _id

index

@Nonnull
public final DocumentRating.Builder index(String value)

Required - API name: _index

rating

@Nonnull
public final DocumentRating.Builder rating(int value)

Required - The document's relevance with regard to the specified search request.

API name: rating

build

@Nonnull
public DocumentRating build()

Builds a DocumentRating.

Specified by:

build in interface ObjectBuilder<DocumentRating>

Throws:

NullPointerException - if some of the required fields are null.