Package org.opensearch.client.opensearch.core.termvectors

Class FieldStatistics.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.termvectors.FieldStatistics.Builder

All Implemented Interfaces:

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

Enclosing class:

FieldStatistics

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

Builder for FieldStatistics.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FieldStatistics	build()	Builds a FieldStatistics.
FieldStatistics.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final FieldStatistics.Builder	docCount(int value)	Required - API name: doc_count
final FieldStatistics.Builder	sumDocFreq(long value)	Required - API name: sum_doc_freq
final FieldStatistics.Builder	sumTtf(long value)	Required - API name: sum_ttf

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

Returns:

a new builder instance.

docCount

@Nonnull
public final FieldStatistics.Builder docCount(int value)

Required - API name: doc_count

sumDocFreq

@Nonnull
public final FieldStatistics.Builder sumDocFreq(long value)

Required - API name: sum_doc_freq

sumTtf

@Nonnull
public final FieldStatistics.Builder sumTtf(long value)

Required - API name: sum_ttf

build

@Nonnull
public FieldStatistics build()

Builds a FieldStatistics.

Specified by:

build in interface ObjectBuilder<FieldStatistics>

Throws:

NullPointerException - if some of the required fields are null.