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

Class HistogramAggregation.Builder

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.Aggregation.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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

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.Number>,ObjectBuilder<ExtendedBounds<java.lang.Number>>> fn)	API name: extended_bounds
HistogramAggregation.Builder	extendedBounds(ExtendedBounds<java.lang.Number> 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.Number>,ObjectBuilder<ExtendedBounds<java.lang.Number>>> fn)	API name: hard_bounds
HistogramAggregation.Builder	hardBounds(ExtendedBounds<java.lang.Number> value)	API name: hard_bounds
HistogramAggregation.Builder	interval(java.lang.Number value)	API name: interval
HistogramAggregation.Builder	minDocCount(java.lang.Number value)	API name: min_doc_count
HistogramAggregation.Builder	missing(java.lang.Number value)	API name: missing
HistogramAggregation.Builder	offset(java.lang.Number 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(jakarta.json.JsonValue value)	API name: script
protected HistogramAggregation.Builder	self()

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

aggregations, aggregations, putAggregations, putAggregations

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.Aggregation.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

extendedBounds

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

API name: extended_bounds

extendedBounds

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

API name: extended_bounds

hardBounds

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

API name: hard_bounds

hardBounds

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

API name: hard_bounds

field

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

API name: field

interval

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

API name: interval

minDocCount

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

API name: min_doc_count

missing

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

API name: missing

offset

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

API name: offset

order

public HistogramAggregation.Builder order(@Nullable HistogramOrder value)

API name: order

order

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

API name: order

script

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

API name: script

format

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

API name: format

self

protected HistogramAggregation.Builder self()

Specified by:

self in class Aggregation.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.