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

Class HistogramAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>

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

org.opensearch.client.opensearch._types.aggregations.HistogramAggregation.Builder

All Implemented Interfaces:

ObjectBuilder<HistogramAggregation>

Enclosing class:

HistogramAggregation

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

Builder for HistogramAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HistogramAggregation	build()	Builds a HistogramAggregation.
HistogramAggregation.Builder	extendedBounds(java.util.function.Function<ExtendedBounds.Builder<java.lang.Double>,ObjectBuilder<ExtendedBounds<java.lang.Double>>> fn)	API name: extended_bounds
HistogramAggregation.Builder	extendedBounds(ExtendedBounds<java.lang.Double> value)	API name: extended_bounds
HistogramAggregation.Builder	field(java.lang.String value)	API name: field
HistogramAggregation.Builder	format(java.lang.String value)	API name: format
HistogramAggregation.Builder	hardBounds(java.util.function.Function<ExtendedBounds.Builder<java.lang.Double>,ObjectBuilder<ExtendedBounds<java.lang.Double>>> fn)	API name: hard_bounds
HistogramAggregation.Builder	hardBounds(ExtendedBounds<java.lang.Double> value)	API name: hard_bounds
HistogramAggregation.Builder	interval(java.lang.Double value)	API name: interval
HistogramAggregation.Builder	keyed(java.lang.Boolean value)	API name: keyed
HistogramAggregation.Builder	minDocCount(java.lang.Integer value)	API name: min_doc_count
HistogramAggregation.Builder	missing(java.lang.Double value)	API name: missing
HistogramAggregation.Builder	offset(java.lang.Double value)	API name: offset
HistogramAggregation.Builder	order(java.util.function.Function<HistogramOrder.Builder,ObjectBuilder<HistogramOrder>> fn)	API name: order
HistogramAggregation.Builder	order(HistogramOrder value)	API name: order
HistogramAggregation.Builder	script(java.util.function.Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
HistogramAggregation.Builder	script(Script value)	API name: script
protected HistogramAggregation.Builder	self()

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, _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

extendedBounds

public final HistogramAggregation.Builder extendedBounds(@Nullable
                                                         ExtendedBounds<java.lang.Double> value)

API name: extended_bounds

extendedBounds

public final HistogramAggregation.Builder extendedBounds(java.util.function.Function<ExtendedBounds.Builder<java.lang.Double>,ObjectBuilder<ExtendedBounds<java.lang.Double>>> fn)

API name: extended_bounds

hardBounds

public final HistogramAggregation.Builder hardBounds(@Nullable
                                                     ExtendedBounds<java.lang.Double> value)

API name: hard_bounds

hardBounds

public final HistogramAggregation.Builder hardBounds(java.util.function.Function<ExtendedBounds.Builder<java.lang.Double>,ObjectBuilder<ExtendedBounds<java.lang.Double>>> fn)

API name: hard_bounds

field

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

API name: field

interval

public final HistogramAggregation.Builder interval(@Nullable
                                                   java.lang.Double value)

API name: interval

minDocCount

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

API name: min_doc_count

missing

public final HistogramAggregation.Builder missing(@Nullable
                                                  java.lang.Double value)

API name: missing

offset

public final HistogramAggregation.Builder offset(@Nullable
                                                 java.lang.Double value)

API name: offset

order

public final HistogramAggregation.Builder order(@Nullable
                                                HistogramOrder value)

API name: order

order

public final HistogramAggregation.Builder order(java.util.function.Function<HistogramOrder.Builder,ObjectBuilder<HistogramOrder>> fn)

API name: order

script

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

API name: script

script

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

API name: script

format

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

API name: format

keyed

public final HistogramAggregation.Builder keyed(@Nullable
                                                java.lang.Boolean value)

API name: keyed

self

protected HistogramAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<HistogramAggregation.Builder>

build

public HistogramAggregation build()

Builds a HistogramAggregation.

Specified by:

build in interface ObjectBuilder<HistogramAggregation>

Throws:

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