Package org.opensearch.search.aggregations.bucket.range

Class ParsedRange.ParsedBucket

java.lang.Object

org.opensearch.search.aggregations.ParsedMultiBucketAggregation.ParsedBucket

org.opensearch.search.aggregations.bucket.range.ParsedRange.ParsedBucket

All Implemented Interfaces:

org.opensearch.common.xcontent.ToXContent, MultiBucketsAggregation.Bucket, Range.Bucket, HasAggregations

Direct Known Subclasses:

ParsedDateRange.ParsedBucket, ParsedGeoDistance.ParsedBucket

Enclosing class:

ParsedRange

public static class ParsedRange.ParsedBucket
extends ParsedMultiBucketAggregation.ParsedBucket
implements Range.Bucket

Parsed bucket for a range

Opensearch.internal:

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected double	from
protected String	fromAsString
protected String	key
protected double	to
protected String	toAsString

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsedBucket()

Method Summary

Modifier and Type	Method	Description
Object	getFrom()
String	getFromAsString()
String	getKey()
String	getKeyAsString()
Object	getTo()
String	getToAsString()
protected static <B extends ParsedRange.ParsedBucket> B	parseRangeBucketXContent(org.opensearch.common.xcontent.XContentParser parser, Supplier<B> bucketSupplier, boolean keyed)
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)

Methods inherited from class org.opensearch.search.aggregations.ParsedMultiBucketAggregation.ParsedBucket

getAggregations, getDocCount, isKeyed, keyToXContent, parseXContent, setAggregations, setDocCount, setKeyAsString, setKeyed

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket

getAggregations, getDocCount

Methods inherited from interface org.opensearch.common.xcontent.ToXContent

isFragment

Field Details

key

protected String key

from

protected double from

fromAsString

protected String fromAsString

to

protected double to

toAsString

protected String toAsString

Constructor Details

ParsedBucket

public ParsedBucket()

Method Details

getKey

public String getKey()

Specified by:

getKey in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket

getKeyAsString

public String getKeyAsString()

Specified by:

getKeyAsString in interface MultiBucketsAggregation.Bucket

Overrides:

getKeyAsString in class ParsedMultiBucketAggregation.ParsedBucket

Returns:

The key associated with the bucket as a string

getFrom

public Object getFrom()

Specified by:

getFrom in interface Range.Bucket

Returns:

The lower bound of the range

getFromAsString

public String getFromAsString()

Specified by:

getFromAsString in interface Range.Bucket

Returns:

The string value for the lower bound of the range

getTo

public Object getTo()

Specified by:

getTo in interface Range.Bucket

Returns:

The upper bound of the range (excluding)

getToAsString

public String getToAsString()

Specified by:

getToAsString in interface Range.Bucket

Returns:

The string value for the upper bound of the range (excluding)

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                                                          throws IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Overrides:

toXContent in class ParsedMultiBucketAggregation.ParsedBucket

Throws:

IOException

parseRangeBucketXContent

protected static <B extends ParsedRange.ParsedBucket>
B parseRangeBucketXContent(org.opensearch.common.xcontent.XContentParser parser,
 Supplier<B> bucketSupplier,
 boolean keyed)
                    throws IOException

Throws:

IOException