Package org.opensearch.client.opensearch._types.query_dsl

Class FieldValueFactorScoreFunction.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.FieldValueFactorScoreFunction.Builder

All Implemented Interfaces:

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

Enclosing class:

FieldValueFactorScoreFunction

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

Builder for FieldValueFactorScoreFunction.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FieldValueFactorScoreFunction	build()	Builds a FieldValueFactorScoreFunction.
FieldValueFactorScoreFunction.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final FieldValueFactorScoreFunction.Builder	factor(Float value)	Optional factor to multiply the field value with.
final FieldValueFactorScoreFunction.Builder	field(String value)	Required - API name: field
final FieldValueFactorScoreFunction.Builder	missing(Double value)	Value used if the document doesn't have that field.
final FieldValueFactorScoreFunction.Builder	modifier(FieldValueFactorModifier value)	API name: modifier

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

Returns:

a new builder instance.

factor

@Nonnull
public final FieldValueFactorScoreFunction.Builder factor(@Nullable
 Float value)

Optional factor to multiply the field value with.

API name: factor

field

@Nonnull
public final FieldValueFactorScoreFunction.Builder field(String value)

Required - API name: field

missing

@Nonnull
public final FieldValueFactorScoreFunction.Builder missing(@Nullable
 Double value)

Value used if the document doesn't have that field. The modifier and factor are still applied to it as though it were read from the document.

API name: missing

modifier

@Nonnull
public final FieldValueFactorScoreFunction.Builder modifier(@Nullable
 FieldValueFactorModifier value)

API name: modifier

build

@Nonnull
public FieldValueFactorScoreFunction build()

Builds a FieldValueFactorScoreFunction.

Specified by:

build in interface ObjectBuilder<FieldValueFactorScoreFunction>

Throws:

NullPointerException - if some of the required fields are null.