Package org.opensearch.client.opensearch._types.aggregations

Class StringStatsAggregate.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregateBase.AbstractBuilder<StringStatsAggregate.Builder>

org.opensearch.client.opensearch._types.aggregations.StringStatsAggregate.Builder

All Implemented Interfaces:

ObjectBuilder<StringStatsAggregate>

Enclosing class:

StringStatsAggregate

public static class StringStatsAggregate.Builder
extends AggregateBase.AbstractBuilder<StringStatsAggregate.Builder>
implements ObjectBuilder<StringStatsAggregate>

Builder for StringStatsAggregate.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StringStatsAggregate.Builder	avgLength(double value)	Required - API name: avg_length
StringStatsAggregate.Builder	avgLengthAsString(java.lang.String value)	API name: avg_length_as_string
StringStatsAggregate	build()	Builds a StringStatsAggregate.
StringStatsAggregate.Builder	count(long value)	Required - API name: count
StringStatsAggregate.Builder	distribution(java.lang.String value)	API name: distribution
StringStatsAggregate.Builder	entropy(double value)	Required - API name: entropy
StringStatsAggregate.Builder	maxLength(int value)	Required - API name: max_length
StringStatsAggregate.Builder	maxLengthAsString(java.lang.String value)	API name: max_length_as_string
StringStatsAggregate.Builder	minLength(int value)	Required - API name: min_length
StringStatsAggregate.Builder	minLengthAsString(java.lang.String value)	API name: min_length_as_string
protected StringStatsAggregate.Builder	self()

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregateBase.AbstractBuilder

meta, meta

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

count

public final StringStatsAggregate.Builder count(long value)

Required - API name: count

minLength

public final StringStatsAggregate.Builder minLength(int value)

Required - API name: min_length

Defaults to 0 if parsed from a JSON null value.

maxLength

public final StringStatsAggregate.Builder maxLength(int value)

Required - API name: max_length

Defaults to 0 if parsed from a JSON null value.

avgLength

public final StringStatsAggregate.Builder avgLength(double value)

Required - API name: avg_length

Defaults to 0 if parsed from a JSON null value.

entropy

public final StringStatsAggregate.Builder entropy(double value)

Required - API name: entropy

Defaults to 0 if parsed from a JSON null value.

distribution

public final StringStatsAggregate.Builder distribution(@Nullable
                                                       java.lang.String value)

API name: distribution

minLengthAsString

public final StringStatsAggregate.Builder minLengthAsString(@Nullable
                                                            java.lang.String value)

API name: min_length_as_string

maxLengthAsString

public final StringStatsAggregate.Builder maxLengthAsString(@Nullable
                                                            java.lang.String value)

API name: max_length_as_string

avgLengthAsString

public final StringStatsAggregate.Builder avgLengthAsString(@Nullable
                                                            java.lang.String value)

API name: avg_length_as_string

self

protected StringStatsAggregate.Builder self()

Specified by:

self in class AggregateBase.AbstractBuilder<StringStatsAggregate.Builder>

build

public StringStatsAggregate build()

Builds a StringStatsAggregate.

Specified by:

build in interface ObjectBuilder<StringStatsAggregate>

Throws:

java.lang.NullPointerException - if some of the required fields are null.