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

Class RangeAggregation.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<RangeAggregation.Builder>

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

All Implemented Interfaces:

WithJson<RangeAggregation.Builder>, ObjectBuilder<RangeAggregation>

Enclosing class:

RangeAggregation

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

Builder for RangeAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RangeAggregation	build()	Builds a RangeAggregation.
final RangeAggregation.Builder	field(String value)	The date field whose values are use to build ranges.
final RangeAggregation.Builder	format(String value)	API name: format
final RangeAggregation.Builder	keyed(Boolean value)	Set to true to associate a unique string key with each bucket and return the ranges as a hash rather than an array.
final RangeAggregation.Builder	missing(Integer value)	The value to apply to documents that do not have a value.
final RangeAggregation.Builder	ranges(AggregationRange value, AggregationRange... values)	An array of ranges used to bucket documents.
final RangeAggregation.Builder	ranges(Function<AggregationRange.Builder,ObjectBuilder<AggregationRange>> fn)	An array of ranges used to bucket documents.
final RangeAggregation.Builder	ranges(List<AggregationRange> list)	An array of ranges used to bucket documents.
final RangeAggregation.Builder	script(Script value)	API name: script
final RangeAggregation.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
protected RangeAggregation.Builder	self()

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

field

public final RangeAggregation.Builder field(@Nullable
 String value)

The date field whose values are use to build ranges.

API name: field

missing

public final RangeAggregation.Builder missing(@Nullable
 Integer value)

The value to apply to documents that do not have a value. By default, documents without a value are ignored.

API name: missing

ranges

public final RangeAggregation.Builder ranges(List<AggregationRange> list)

An array of ranges used to bucket documents.

API name: ranges

Adds all elements of list to ranges.

ranges

public final RangeAggregation.Builder ranges(AggregationRange value,
 AggregationRange... values)

An array of ranges used to bucket documents.

API name: ranges

Adds one or more values to ranges.

ranges

public final RangeAggregation.Builder ranges(Function<AggregationRange.Builder,ObjectBuilder<AggregationRange>> fn)

An array of ranges used to bucket documents.

API name: ranges

Adds a value to ranges using a builder lambda.

script

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

API name: script

script

public final RangeAggregation.Builder script(Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: script

keyed

public final RangeAggregation.Builder keyed(@Nullable
 Boolean value)

Set to true to associate a unique string key with each bucket and return the ranges as a hash rather than an array.

API name: keyed

format

public final RangeAggregation.Builder format(@Nullable
 String value)

API name: format

self

protected RangeAggregation.Builder self()

Specified by:

self in class BucketAggregationBase.AbstractBuilder<RangeAggregation.Builder>

build

public RangeAggregation build()

Builds a RangeAggregation.

Specified by:

build in interface ObjectBuilder<RangeAggregation>

Throws:

NullPointerException - if some of the required fields are null.