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

Class TermsAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<TermsAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<TermsAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.TermsAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

TermsAggregation

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

Builder for TermsAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TermsAggregation	build()	Builds a TermsAggregation.
final TermsAggregation.Builder	collectMode(TermsAggregationCollectMode value)	API name: collect_mode
TermsAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TermsAggregation.Builder	exclude(Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)	API name: exclude
final TermsAggregation.Builder	exclude(TermsExclude value)	API name: exclude
final TermsAggregation.Builder	executionHint(TermsAggregationExecutionHint value)	API name: execution_hint
final TermsAggregation.Builder	field(String value)	API name: field
final TermsAggregation.Builder	format(String value)	API name: format
final TermsAggregation.Builder	include(Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)	API name: include
final TermsAggregation.Builder	include(TermsInclude value)	API name: include
final TermsAggregation.Builder	minDocCount(Integer value)	Only return values that are found in more than min_doc_count hits.
final TermsAggregation.Builder	missing(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: missing
final TermsAggregation.Builder	missing(FieldValue value)	API name: missing
final TermsAggregation.Builder	missingBucket(Boolean value)	API name: missing_bucket
final TermsAggregation.Builder	missingOrder(MissingOrder value)	API name: missing_order
final TermsAggregation.Builder	order(List<Map<String,SortOrder>> list)	API name: order
final TermsAggregation.Builder	order(Map<String,SortOrder> value, Map<String,SortOrder>... values)	API name: order
final TermsAggregation.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
final TermsAggregation.Builder	script(Script value)	API name: script
protected TermsAggregation.Builder	self()
final TermsAggregation.Builder	shardSize(Integer value)	The number of candidate terms produced by each shard.
final TermsAggregation.Builder	showTermDocCountError(Boolean value)	Set to true to return the doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard.
final TermsAggregation.Builder	size(Integer value)	The number of buckets returned out of the overall terms list.
final TermsAggregation.Builder	valueType(String value)	Coerced unmapped fields into the specified type.

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

meta, meta, name

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

Returns:

a new builder instance.

self

@Nonnull
protected TermsAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<TermsAggregation.Builder>

collectMode

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

API name: collect_mode

exclude

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

API name: exclude

exclude

@Nonnull
public final TermsAggregation.Builder exclude(Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)

API name: exclude

executionHint

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

API name: execution_hint

field

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

API name: field

format

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

API name: format

include

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

API name: include

include

@Nonnull
public final TermsAggregation.Builder include(Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)

API name: include

minDocCount

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

Only return values that are found in more than min_doc_count hits.

API name: min_doc_count

missing

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

API name: missing

missing

@Nonnull
public final TermsAggregation.Builder missing(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

API name: missing

missingBucket

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

API name: missing_bucket

missingOrder

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

API name: missing_order

order

@Nonnull
public final TermsAggregation.Builder order(List<Map<String,SortOrder>> list)

API name: order

Adds all elements of list to order.

order

@Nonnull
public final TermsAggregation.Builder order(Map<String,SortOrder> value,
 Map<String,SortOrder>... values)

API name: order

Adds one or more values to order.

script

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

API name: script

script

@Nonnull
public final TermsAggregation.Builder script(Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: script

shardSize

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

The number of candidate terms produced by each shard. By default, shard_size will be automatically estimated based on the number of shards and the size parameter.

API name: shard_size

showTermDocCountError

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

Set to true to return the doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard.

API name: show_term_doc_count_error

size

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

The number of buckets returned out of the overall terms list.

API name: size

valueType

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

Coerced unmapped fields into the specified type.

API name: value_type

build

@Nonnull
public TermsAggregation build()

Builds a TermsAggregation.

Specified by:

build in interface ObjectBuilder<TermsAggregation>

Throws:

NullPointerException - if some of the required fields are null.