Package org.opensearch.search.aggregations.bucket.composite

Class HistogramValuesSourceBuilder

java.lang.Object

org.opensearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

org.opensearch.search.aggregations.bucket.composite.HistogramValuesSourceBuilder

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment

public class HistogramValuesSourceBuilder
extends CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

A CompositeValuesSourceBuilder that builds a HistogramValuesSource from another numeric values source using the provided interval.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HistogramValuesSourceBuilder.HistogramCompositeSupplier	Composite histogram supplier

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder

name

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	HistogramValuesSourceBuilder(String name)
protected	HistogramValuesSourceBuilder(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected void	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
protected ValuesSourceType	getDefaultValuesSourceType()
int	hashCode()
protected CompositeValuesSourceConfig	innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config)	Creates a CompositeValuesSourceConfig for this source.
protected void	innerWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
double	interval()	Returns the interval that is set on this source
HistogramValuesSourceBuilder	interval(double interval)	Sets the interval on this source.
static void	register(ValuesSourceRegistry.Builder builder)
String	type()

Methods inherited from class org.opensearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder

build, field, field, format, format, missingBucket, missingBucket, missingOrder, missingOrder, missingOrder, name, order, order, order, script, script, timeZone, toXContent, userValuetypeHint, userValuetypeHint, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Constructor Details

HistogramValuesSourceBuilder

public HistogramValuesSourceBuilder(String name)

HistogramValuesSourceBuilder

protected HistogramValuesSourceBuilder(org.opensearch.core.common.io.stream.StreamInput in)
                                throws IOException

Throws:

IOException

Method Details

register

public static void register(ValuesSourceRegistry.Builder builder)

innerWriteTo

protected void innerWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                     throws IOException

Specified by:

innerWriteTo in class CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

Throws:

IOException

doXContentBody

protected void doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                       throws IOException

Specified by:

doXContentBody in class CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

type

public String type()

Specified by:

type in class CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

interval

public double interval()

Returns the interval that is set on this source

interval

public HistogramValuesSourceBuilder interval(double interval)

Sets the interval on this source.

getDefaultValuesSourceType

protected ValuesSourceType getDefaultValuesSourceType()

Specified by:

getDefaultValuesSourceType in class CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

innerBuild

protected CompositeValuesSourceConfig innerBuild(QueryShardContext queryShardContext,
 ValuesSourceConfig config)
                                          throws IOException

Description copied from class: CompositeValuesSourceBuilder

Creates a CompositeValuesSourceConfig for this source.

Specified by:

innerBuild in class CompositeValuesSourceBuilder<HistogramValuesSourceBuilder>

Parameters:

queryShardContext - The shard context for this source.

config - The ValuesSourceConfig for this source.

Throws:

IOException