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<HistogramAggregation.Builder>

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

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

All Implemented Interfaces:

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

Enclosing class:

HistogramAggregation

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

Builder for HistogramAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HistogramAggregation	build()	Builds a HistogramAggregation.
HistogramAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final HistogramAggregation.Builder	extendedBounds(Function<ExtendedBounds.Builder<Double>,ObjectBuilder<ExtendedBounds<Double>>> fn)	API name: extended_bounds
final HistogramAggregation.Builder	extendedBounds(ExtendedBounds<Double> value)	API name: extended_bounds
final HistogramAggregation.Builder	field(String value)	API name: field
final HistogramAggregation.Builder	format(String value)	API name: format
final HistogramAggregation.Builder	hardBounds(Function<ExtendedBounds.Builder<Double>,ObjectBuilder<ExtendedBounds<Double>>> fn)	API name: hard_bounds
final HistogramAggregation.Builder	hardBounds(ExtendedBounds<Double> value)	API name: hard_bounds
final HistogramAggregation.Builder	interval(Double value)	The interval for the buckets.
final HistogramAggregation.Builder	keyed(Boolean value)	If true, returns buckets as a hash instead of an array, keyed by the bucket keys.
final HistogramAggregation.Builder	minDocCount(Integer value)	Only returns buckets that have min_doc_count number of documents.
final HistogramAggregation.Builder	missing(Double value)	The value to apply to documents that do not have a value.
final HistogramAggregation.Builder	offset(Double value)	By default, the bucket keys start with 0 and then continue in even spaced steps of interval.
final HistogramAggregation.Builder	order(Function<HistogramOrder.Builder,ObjectBuilder<HistogramOrder>> fn)	API name: order
final HistogramAggregation.Builder	order(HistogramOrder value)	API name: order
final HistogramAggregation.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
final 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, _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 HistogramAggregation.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<HistogramAggregation.Builder,HistogramAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected HistogramAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<HistogramAggregation.Builder>

extendedBounds

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

API name: extended_bounds

extendedBounds

@Nonnull
public final HistogramAggregation.Builder extendedBounds(Function<ExtendedBounds.Builder<Double>,ObjectBuilder<ExtendedBounds<Double>>> fn)

API name: extended_bounds

field

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

API name: field

format

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

API name: format

hardBounds

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

API name: hard_bounds

hardBounds

@Nonnull
public final HistogramAggregation.Builder hardBounds(Function<ExtendedBounds.Builder<Double>,ObjectBuilder<ExtendedBounds<Double>>> fn)

API name: hard_bounds

interval

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

The interval for the buckets. Must be a positive decimal.

API name: interval

keyed

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

If true, returns buckets as a hash instead of an array, keyed by the bucket keys.

API name: keyed

minDocCount

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

Only returns buckets that have min_doc_count number of documents. By default, the response will fill gaps in the histogram with empty buckets.

API name: min_doc_count

missing

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

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

API name: missing

offset

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

By default, the bucket keys start with 0 and then continue in even spaced steps of interval. The bucket boundaries can be shifted by using the offset option.

API name: offset

order

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

API name: order

order

@Nonnull
public final HistogramAggregation.Builder order(Function<HistogramOrder.Builder,ObjectBuilder<HistogramOrder>> fn)

API name: order

script

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

API name: script

script

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

API name: script

build

@Nonnull
public HistogramAggregation build()

Builds a HistogramAggregation.

Specified by:

build in interface ObjectBuilder<HistogramAggregation>

Throws:

NullPointerException - if some of the required fields are null.