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

Class RankFeatureFunctionSaturation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.RankFeatureFunction.AbstractBuilder<RankFeatureFunctionSaturation.Builder>

org.opensearch.client.opensearch._types.query_dsl.RankFeatureFunctionSaturation.Builder

All Implemented Interfaces:

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

Enclosing class:

RankFeatureFunctionSaturation

public static class RankFeatureFunctionSaturation.Builder
extends RankFeatureFunction.AbstractBuilder<RankFeatureFunctionSaturation.Builder>
implements CopyableBuilder<RankFeatureFunctionSaturation.Builder,RankFeatureFunctionSaturation>

Builder for RankFeatureFunctionSaturation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankFeatureFunctionSaturation	build()	Builds a RankFeatureFunctionSaturation.
RankFeatureFunctionSaturation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RankFeatureFunctionSaturation.Builder	pivot(Float value)	Configurable pivot value so that the result will be less than 0.5.
protected RankFeatureFunctionSaturation.Builder	self()

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

Returns:

a new builder instance.

self

@Nonnull
protected RankFeatureFunctionSaturation.Builder self()

Specified by:

self in class RankFeatureFunction.AbstractBuilder<RankFeatureFunctionSaturation.Builder>

pivot

@Nonnull
public final RankFeatureFunctionSaturation.Builder pivot(@Nullable
 Float value)

Configurable pivot value so that the result will be less than 0.5.

API name: pivot

build

@Nonnull
public RankFeatureFunctionSaturation build()

Builds a RankFeatureFunctionSaturation.

Specified by:

build in interface ObjectBuilder<RankFeatureFunctionSaturation>

Throws:

NullPointerException - if some of the required fields are null.