Package org.opensearch.client.opensearch.search_pipeline

Class RerankContext.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.search_pipeline.RerankContext.Builder

All Implemented Interfaces:

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

Enclosing class:

RerankContext

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

Builder for RerankContext.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RerankContext	build()	Builds a RerankContext.
RerankContext.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RerankContext.Builder	documentFields(String value, String... values)	Required - API name: document_fields
final RerankContext.Builder	documentFields(List<String> list)	Required - API name: document_fields

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 RerankContext.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<RerankContext.Builder,RerankContext>

Returns:

a new builder instance.

documentFields

@Nonnull
public final RerankContext.Builder documentFields(List<String> list)

Required - API name: document_fields

Adds all elements of list to documentFields.

documentFields

@Nonnull
public final RerankContext.Builder documentFields(String value,
 String... values)

Required - API name: document_fields

Adds one or more values to documentFields.

build

@Nonnull
public RerankContext build()

Builds a RerankContext.

Specified by:

build in interface ObjectBuilder<RerankContext>

Throws:

NullPointerException - if some of the required fields are null.