Package org.opensearch.client.opensearch.indices

Class FielddataFrequencyFilter.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.FielddataFrequencyFilter.Builder

All Implemented Interfaces:

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

Enclosing class:

FielddataFrequencyFilter

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

Builder for FielddataFrequencyFilter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FielddataFrequencyFilter	build()	Builds a FielddataFrequencyFilter.
FielddataFrequencyFilter.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final FielddataFrequencyFilter.Builder	max(double value)	Required - The maximum frequency threshold.
final FielddataFrequencyFilter.Builder	min(double value)	Required - The minimum frequency threshold.
final FielddataFrequencyFilter.Builder	minSegmentSize(int value)	Required - The minimum segment size to apply the filter.

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

Returns:

a new builder instance.

max

@Nonnull
public final FielddataFrequencyFilter.Builder max(double value)

Required - The maximum frequency threshold.

API name: max

min

@Nonnull
public final FielddataFrequencyFilter.Builder min(double value)

Required - The minimum frequency threshold.

API name: min

minSegmentSize

@Nonnull
public final FielddataFrequencyFilter.Builder minSegmentSize(int value)

Required - The minimum segment size to apply the filter.

API name: min_segment_size

build

@Nonnull
public FielddataFrequencyFilter build()

Builds a FielddataFrequencyFilter.

Specified by:

build in interface ObjectBuilder<FielddataFrequencyFilter>

Throws:

NullPointerException - if some of the required fields are null.