Package org.opensearch.search.aggregations.bucket.terms

Class UnmappedTerms

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.search.aggregations.InternalMultiBucketAggregation<UnmappedTerms,UnmappedTerms.Bucket>

org.opensearch.search.aggregations.bucket.terms.InternalTerms<UnmappedTerms,UnmappedTerms.Bucket>

org.opensearch.search.aggregations.bucket.terms.UnmappedTerms

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Aggregation, MultiBucketsAggregation, Terms

public class UnmappedTerms
extends InternalTerms<UnmappedTerms,UnmappedTerms.Bucket>

Result of the TermsAggregator when the field is unmapped.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	UnmappedTerms.Bucket	Concrete type that can't be built because Java needs a concrete type so InternalTerms.Bucket can have a self type but UnmappedTerms doesn't ever need to build it because it never returns any buckets.

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.bucket.terms.InternalTerms

InternalTerms.AbstractInternalBucket

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.InternalMultiBucketAggregation

InternalMultiBucketAggregation.InternalBucket

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.InternalAggregation

InternalAggregation.ReduceContext, InternalAggregation.ReduceContextBuilder

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.Aggregation

Aggregation.CommonFields

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

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class org.opensearch.search.aggregations.bucket.terms.InternalTerms

bucketCountThresholds, DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME, minDocCount, order, reduceOrder, requiredSize, SUM_OF_OTHER_DOC_COUNTS

Fields inherited from class org.opensearch.search.aggregations.InternalAggregation

metadata, name

Fields inherited from interface org.opensearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
UnmappedTerms(String name, BucketOrder order, TermsAggregator.BucketCountThresholds bucketCountThresholds, Map<String,Object> metadata)
UnmappedTerms(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected UnmappedTerms	create(String name, List<UnmappedTerms.Bucket> buckets, BucketOrder reduceOrder, long docCountError, long otherDocCount)
UnmappedTerms	create(List<UnmappedTerms.Bucket> buckets)	Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
UnmappedTerms.Bucket	createBucket(InternalAggregations aggregations, UnmappedTerms.Bucket prototype)	Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
protected UnmappedTerms.Bucket[]	createBucketsArray(int size)	Create an array to hold some buckets.
final org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
UnmappedTerms.Bucket	getBucketByKey(String term)	Get the bucket for the given term, or null if there is no such bucket.
List<UnmappedTerms.Bucket>	getBuckets()	Return the sorted list of the buckets in this terms aggregation.
long	getDocCountError()	Get an upper bound of the error on document counts in this aggregation.
protected int	getShardSize()
long	getSumOfOtherDocCounts()	Return the sum of the document counts of all buckets that did not make it to the top buckets.
String	getType()
String	getWriteableName()
boolean	isMapped()	Return true if this aggregation is mapped, and can lead a reduction.
InternalAggregation	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
protected void	setDocCountError(long docCountError)
protected void	writeTermTypeInfoTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.search.aggregations.bucket.terms.InternalTerms

doWriteTo, doXContentCommon, equals, hashCode, reduceBucket

Methods inherited from class org.opensearch.search.aggregations.InternalMultiBucketAggregation

copyWithRewritenBuckets, countInnerBucket, countInnerBucket, forEachBucket, getProperty, mustReduceOnSingleInternalAgg, reducePipelines

Methods inherited from class org.opensearch.search.aggregations.InternalAggregation

getMetadata, getName, getProperty, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, sortValue, sortValue, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.search.aggregations.Aggregation

getMetadata, getName

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

toXContent

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

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

UnmappedTerms

public UnmappedTerms(String name,
 BucketOrder order,
 TermsAggregator.BucketCountThresholds bucketCountThresholds,
 Map<String,Object> metadata)

UnmappedTerms

public UnmappedTerms(org.opensearch.core.common.io.stream.StreamInput in)
              throws IOException

Read from a stream.

Throws:

IOException

Method Details

writeTermTypeInfoTo

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

Specified by:

writeTermTypeInfoTo in class InternalTerms<UnmappedTerms,UnmappedTerms.Bucket>

Throws:

IOException

getWriteableName

public String getWriteableName()

getType

public String getType()

Specified by:

getType in interface Aggregation

Overrides:

getType in class InternalAggregation

Returns:

a string representing the type of the aggregation. This type is added to the aggregation name in the response, so that it can later be used by clients to determine type of the aggregation and parse it into the proper object.

create

public UnmappedTerms create(List<UnmappedTerms.Bucket> buckets)

Description copied from class: InternalMultiBucketAggregation

Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.

Specified by:

create in class InternalMultiBucketAggregation<UnmappedTerms,UnmappedTerms.Bucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public UnmappedTerms.Bucket createBucket(InternalAggregations aggregations,
 UnmappedTerms.Bucket prototype)

Description copied from class: InternalMultiBucketAggregation

Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.

Specified by:

createBucket in class InternalMultiBucketAggregation<UnmappedTerms,UnmappedTerms.Bucket>

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

create

protected UnmappedTerms create(String name,
 List<UnmappedTerms.Bucket> buckets,
 BucketOrder reduceOrder,
 long docCountError,
 long otherDocCount)

Specified by:

create in class InternalTerms<UnmappedTerms,UnmappedTerms.Bucket>

reduce

public InternalAggregation reduce(List<InternalAggregation> aggregations,
 InternalAggregation.ReduceContext reduceContext)

Description copied from class: InternalAggregation

Reduces the given aggregations to a single one and returns it. In most cases, the assumption will be the all given aggregations are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing instance (typically the first in the given list) to save on redundant object construction.

Overrides:

reduce in class InternalTerms<UnmappedTerms,UnmappedTerms.Bucket>

See Also:

• InternalAggregation.mustReduceOnSingleInternalAgg()

isMapped

public boolean isMapped()

Description copied from class: InternalAggregation

Return true if this aggregation is mapped, and can lead a reduction. If this agg returns false, it should return itself if asked to lead a reduction

Overrides:

isMapped in class InternalAggregation

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException

setDocCountError

protected void setDocCountError(long docCountError)

Specified by:

setDocCountError in class InternalTerms<UnmappedTerms,UnmappedTerms.Bucket>

getShardSize

protected int getShardSize()

Specified by:

getShardSize in class InternalTerms<UnmappedTerms,UnmappedTerms.Bucket>

getDocCountError

public long getDocCountError()

Description copied from interface: Terms

Get an upper bound of the error on document counts in this aggregation.

getSumOfOtherDocCounts

public long getSumOfOtherDocCounts()

Description copied from interface: Terms

Return the sum of the document counts of all buckets that did not make it to the top buckets.

getBuckets

public List<UnmappedTerms.Bucket> getBuckets()

Description copied from interface: Terms

Return the sorted list of the buckets in this terms aggregation.

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in interface Terms

Specified by:

getBuckets in class InternalTerms<UnmappedTerms,UnmappedTerms.Bucket>

Returns:

The buckets of this aggregation.

getBucketByKey

public UnmappedTerms.Bucket getBucketByKey(String term)

Description copied from interface: Terms

Get the bucket for the given term, or null if there is no such bucket.

Specified by:

getBucketByKey in interface Terms

Specified by:

getBucketByKey in class InternalTerms<UnmappedTerms,UnmappedTerms.Bucket>

createBucketsArray

protected UnmappedTerms.Bucket[] createBucketsArray(int size)

Description copied from class: InternalTerms

Create an array to hold some buckets. Used in collecting the results.

Specified by:

createBucketsArray in class InternalTerms<UnmappedTerms,UnmappedTerms.Bucket>