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

Class StringTerms

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

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

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

org.opensearch.search.aggregations.bucket.terms.InternalMappedTerms<StringTerms,StringTerms.Bucket>

org.opensearch.search.aggregations.bucket.terms.StringTerms

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 StringTerms
extends InternalMappedTerms<StringTerms,StringTerms.Bucket>

Result of the TermsAggregator when the field is a String.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringTerms.Bucket	Bucket for string terms

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.InternalMappedTerms

bucketMap, buckets, docCountError, format, otherDocCount, shardSize, showTermDocCountError

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
StringTerms(String name, BucketOrder reduceOrder, BucketOrder order, Map<String,Object> metadata, DocValueFormat format, int shardSize, boolean showTermDocCountError, long otherDocCount, List<StringTerms.Bucket> buckets, long docCountError, TermsAggregator.BucketCountThresholds bucketCountThresholds)
StringTerms(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected StringTerms	create(String name, List<StringTerms.Bucket> buckets, BucketOrder reduceOrder, long docCountError, long otherDocCount)
StringTerms	create(List<StringTerms.Bucket> buckets)	Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
StringTerms.Bucket	createBucket(InternalAggregations aggregations, StringTerms.Bucket prototype)	Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
protected StringTerms.Bucket[]	createBucketsArray(int size)	Create an array to hold some buckets.
String	getWriteableName()

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

doXContentBody, equals, getBucketByKey, getBuckets, getDocCountError, getShardSize, getSumOfOtherDocCounts, hashCode, setDocCountError, writeTermTypeInfoTo

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

doWriteTo, doXContentCommon, reduce, 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, getType, isMapped, 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, getType

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

StringTerms

public StringTerms(String name,
 BucketOrder reduceOrder,
 BucketOrder order,
 Map<String,Object> metadata,
 DocValueFormat format,
 int shardSize,
 boolean showTermDocCountError,
 long otherDocCount,
 List<StringTerms.Bucket> buckets,
 long docCountError,
 TermsAggregator.BucketCountThresholds bucketCountThresholds)

StringTerms

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

Read from a stream.

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

create

public StringTerms create(List<StringTerms.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<StringTerms,StringTerms.Bucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public StringTerms.Bucket createBucket(InternalAggregations aggregations,
 StringTerms.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<StringTerms,StringTerms.Bucket>

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

create

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

Specified by:

create in class InternalTerms<StringTerms,StringTerms.Bucket>

createBucketsArray

protected StringTerms.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<StringTerms,StringTerms.Bucket>