Package co.elastic.clients.elasticsearch._types.aggregations

Class TermsAggregation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase.AbstractBuilder<TermsAggregation.Builder>

co.elastic.clients.elasticsearch._types.aggregations.TermsAggregation.Builder

All Implemented Interfaces:

WithJson<TermsAggregation.Builder>, ObjectBuilder<TermsAggregation>

Enclosing class:

TermsAggregation

public static class TermsAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<TermsAggregation.Builder>
implements ObjectBuilder<TermsAggregation>

Builder for TermsAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TermsAggregation	build()	Builds a TermsAggregation.
TermsAggregation.Builder	collectMode(TermsAggregationCollectMode value)	API name: collect_mode
TermsAggregation.Builder	exclude(TermsExclude value)	API name: exclude
TermsAggregation.Builder	exclude(java.util.function.Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)	API name: exclude
TermsAggregation.Builder	executionHint(TermsAggregationExecutionHint value)	API name: execution_hint
TermsAggregation.Builder	field(java.lang.String value)	API name: field
TermsAggregation.Builder	format(java.lang.String value)	API name: format
TermsAggregation.Builder	include(TermsInclude value)	API name: include
TermsAggregation.Builder	include(java.util.function.Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)	API name: include
TermsAggregation.Builder	minDocCount(java.lang.Integer value)	API name: min_doc_count
TermsAggregation.Builder	missing(boolean value)	API name: missing
TermsAggregation.Builder	missing(double value)	API name: missing
TermsAggregation.Builder	missing(long value)	API name: missing
TermsAggregation.Builder	missing(FieldValue value)	API name: missing
TermsAggregation.Builder	missing(java.lang.String value)	API name: missing
TermsAggregation.Builder	missing(java.util.function.Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: missing
TermsAggregation.Builder	missingBucket(java.lang.Boolean value)	API name: missing_bucket
TermsAggregation.Builder	missingOrder(MissingOrder value)	API name: missing_order
TermsAggregation.Builder	order(java.util.List<java.util.Map<java.lang.String,SortOrder>> list)	API name: order
TermsAggregation.Builder	order(java.util.Map<java.lang.String,SortOrder> value, java.util.Map<java.lang.String,SortOrder>... values)	API name: order
TermsAggregation.Builder	script(Script value)	API name: script
TermsAggregation.Builder	script(java.util.function.Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
protected TermsAggregation.Builder	self()
TermsAggregation.Builder	shardSize(java.lang.Integer value)	API name: shard_size
TermsAggregation.Builder	showTermDocCountError(java.lang.Boolean value)	API name: show_term_doc_count_error
TermsAggregation.Builder	size(java.lang.Integer value)	API name: size
TermsAggregation.Builder	valueType(java.lang.String value)	API name: value_type

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder

meta, meta, name

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

collectMode

public final TermsAggregation.Builder collectMode(@Nullable
TermsAggregationCollectMode value)

API name: collect_mode

exclude

public final TermsAggregation.Builder exclude(@Nullable
TermsExclude value)

API name: exclude

exclude

public final TermsAggregation.Builder exclude(java.util.function.Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)

API name: exclude

executionHint

public final TermsAggregation.Builder executionHint(@Nullable
TermsAggregationExecutionHint value)

API name: execution_hint

field

public final TermsAggregation.Builder field(@Nullable
java.lang.String value)

API name: field

include

public final TermsAggregation.Builder include(@Nullable
TermsInclude value)

API name: include

include

public final TermsAggregation.Builder include(java.util.function.Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)

API name: include

minDocCount

public final TermsAggregation.Builder minDocCount(@Nullable
java.lang.Integer value)

API name: min_doc_count

missing

public final TermsAggregation.Builder missing(@Nullable
FieldValue value)

API name: missing

missing

public final TermsAggregation.Builder missing(java.util.function.Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

API name: missing

missing

public final TermsAggregation.Builder missing(java.lang.String value)

API name: missing

missing

public final TermsAggregation.Builder missing(long value)

API name: missing

missing

public final TermsAggregation.Builder missing(double value)

API name: missing

missing

public final TermsAggregation.Builder missing(boolean value)

API name: missing

missingOrder

public final TermsAggregation.Builder missingOrder(@Nullable
MissingOrder value)

API name: missing_order

missingBucket

public final TermsAggregation.Builder missingBucket(@Nullable
java.lang.Boolean value)

API name: missing_bucket

valueType

public final TermsAggregation.Builder valueType(@Nullable
java.lang.String value)

API name: value_type

order

public final TermsAggregation.Builder order(java.util.List<java.util.Map<java.lang.String,SortOrder>> list)

API name: order

Adds all elements of list to order.

order

public final TermsAggregation.Builder order(java.util.Map<java.lang.String,SortOrder> value,
java.util.Map<java.lang.String,SortOrder>... values)

API name: order

Adds one or more values to order.

script

public final TermsAggregation.Builder script(@Nullable
Script value)

API name: script

script

public final TermsAggregation.Builder script(java.util.function.Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: script

shardSize

public final TermsAggregation.Builder shardSize(@Nullable
java.lang.Integer value)

API name: shard_size

showTermDocCountError

public final TermsAggregation.Builder showTermDocCountError(@Nullable
java.lang.Boolean value)

API name: show_term_doc_count_error

size

public final TermsAggregation.Builder size(@Nullable
java.lang.Integer value)

API name: size

format

public final TermsAggregation.Builder format(@Nullable
java.lang.String value)

API name: format

self

protected TermsAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<TermsAggregation.Builder>

build

public TermsAggregation build()

Builds a TermsAggregation.

Specified by:

build in interface ObjectBuilder<TermsAggregation>

Throws:

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