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

Class TermsAggregation.Builder

java.lang.Object

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:

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.Builder	addExclude(java.lang.String value)	Add a value to exclude(List), creating the list if needed.
TermsAggregation	build()	Builds a TermsAggregation.
TermsAggregation.Builder	collectMode(TermsAggregationCollectMode value)	API name: collect_mode
TermsAggregation.Builder	exclude(java.lang.String... value)	API name: exclude
TermsAggregation.Builder	exclude(java.util.List<java.lang.String> value)	API name: exclude
TermsAggregation.Builder	executionHint(TermsAggregationExecutionHint value)	API name: execution_hint
TermsAggregation.Builder	field(java.lang.String value)	API name: field
TermsAggregation.Builder	include(jakarta.json.JsonValue value)	API name: include
TermsAggregation.Builder	minDocCount(java.lang.Integer value)	API name: min_doc_count
TermsAggregation.Builder	missing(java.lang.String value)	API name: missing
TermsAggregation.Builder	missingBucket(java.lang.Boolean value)	API name: missing_bucket
TermsAggregation.Builder	order(jakarta.json.JsonValue value)	API name: order
TermsAggregation.Builder	script(jakarta.json.JsonValue value)	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.BucketAggregationBase.AbstractBuilder

aggregations, aggregations, putAggregations, putAggregations

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

meta, name, putMeta

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

collectMode

public TermsAggregation.Builder collectMode(@Nullable
TermsAggregationCollectMode value)

API name: collect_mode

exclude

public TermsAggregation.Builder exclude(@Nullable
java.util.List<java.lang.String> value)

API name: exclude

exclude

public TermsAggregation.Builder exclude(java.lang.String... value)

API name: exclude

addExclude

public TermsAggregation.Builder addExclude(java.lang.String value)

Add a value to exclude(List), creating the list if needed.

executionHint

public TermsAggregation.Builder executionHint(@Nullable
TermsAggregationExecutionHint value)

API name: execution_hint

field

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

API name: field

include

public TermsAggregation.Builder include(@Nullable
jakarta.json.JsonValue value)

API name: include

minDocCount

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

API name: min_doc_count

missing

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

API name: missing

missingBucket

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

API name: missing_bucket

valueType

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

API name: value_type

order

public TermsAggregation.Builder order(@Nullable
jakarta.json.JsonValue value)

API name: order

script

public TermsAggregation.Builder script(@Nullable
jakarta.json.JsonValue value)

API name: script

shardSize

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

API name: shard_size

showTermDocCountError

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

API name: show_term_doc_count_error

size

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

API name: size

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.