Package org.elasticsearch.client.analytics

Class StringStatsAggregationBuilder

java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>
org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>
org.elasticsearch.client.analytics.StringStatsAggregationBuilder
All Implemented Interfaces:
org.elasticsearch.common.io.stream.NamedWriteable, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.index.query.Rewriteable<org.elasticsearch.search.aggregations.AggregationBuilder>, org.elasticsearch.search.aggregations.BaseAggregationBuilder, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment
public class StringStatsAggregationBuilder extends org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>
Builds the string_stats aggregation request.

NOTE: This extends AbstractAggregationBuilder for compatibility with SearchSourceBuilder.aggregation(AggregationBuilder) but it doesn't support any "server" side things like Writeable.writeTo(StreamOutput), AggregationBuilder.rewrite(QueryRewriteContext), or AbstractAggregationBuilder.build(AggregationContext, AggregatorFactory).

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

    org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.LeafOnly<VS extends org.elasticsearch.search.aggregations.support.ValuesSource,AB extends org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<AB>>, org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.MetricsAggregationBuilder<VS extends org.elasticsearch.search.aggregations.support.ValuesSource,AB extends org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<AB>>, org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.SingleMetricAggregationBuilder<VS extends org.elasticsearch.search.aggregations.support.ValuesSource,AB extends org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<AB>>

    Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

    org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality, org.elasticsearch.search.aggregations.AggregationBuilder.CommonFields

    Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

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

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
     

    Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

    config

    Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

    metadata

    Fields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

    DEFAULT_PREALLOCATION, factoriesBuilder, name

    Fields inherited from interface org.elasticsearch.index.query.Rewriteable

    MAX_REWRITE_ROUNDS

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    StringStatsAggregationBuilder(String name)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality
    bucketCardinality()
     
    protected org.elasticsearch.search.aggregations.support.ValuesSourceType
    defaultValueSourceType()
     
    org.elasticsearch.xcontent.XContentBuilder
    doXContentBody(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    boolean
    equals(Object obj)
     
    protected org.elasticsearch.search.aggregations.support.ValuesSourceRegistry.RegistryKey<?>
    getRegistryKey()
     
    String
    getType()
     
    int
    hashCode()
     
    protected org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorFactory
    innerBuild(org.elasticsearch.search.aggregations.support.AggregationContext context, org.elasticsearch.search.aggregations.support.ValuesSourceConfig config, org.elasticsearch.search.aggregations.AggregatorFactory parent, org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactoriesBuilder)
     
    protected void
    innerWriteTo(org.elasticsearch.common.io.stream.StreamOutput out)
     
    protected org.elasticsearch.search.aggregations.AggregationBuilder
    shallowCopy(org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)
     
    StringStatsAggregationBuilder
    showDistribution(boolean showDistribution)
    Compute the distribution of each character.

    Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

    declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, userValueTypeHint, userValueTypeHint

    Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

    build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

    Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

    buildPipelineTree, bytesToPreallocate, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, rewrite, toString

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

    isFragment

  • Field Details

  • Constructor Details

    • StringStatsAggregationBuilder

      public StringStatsAggregationBuilder(String name)

  • Method Details

    • showDistribution

      public StringStatsAggregationBuilder showDistribution(boolean showDistribution)
      Compute the distribution of each character. Disabled by default.
      Returns:
      this for chaining

    • defaultValueSourceType

      protected org.elasticsearch.search.aggregations.support.ValuesSourceType defaultValueSourceType()
      Specified by:
      defaultValueSourceType in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>

    • getType

      public String getType()

    • getRegistryKey

      protected org.elasticsearch.search.aggregations.support.ValuesSourceRegistry.RegistryKey<?> getRegistryKey()
      Specified by:
      getRegistryKey in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>

    • doXContentBody

      public org.elasticsearch.xcontent.XContentBuilder doXContentBody(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      doXContentBody in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>
      Throws:
      IOException

    • innerWriteTo

      protected void innerWriteTo(org.elasticsearch.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      innerWriteTo in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>
      Throws:
      IOException

    • bucketCardinality

      public org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality bucketCardinality()
      Specified by:
      bucketCardinality in class org.elasticsearch.search.aggregations.AggregationBuilder

    • innerBuild

      protected org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorFactory innerBuild(org.elasticsearch.search.aggregations.support.AggregationContext context, org.elasticsearch.search.aggregations.support.ValuesSourceConfig config, org.elasticsearch.search.aggregations.AggregatorFactory parent, org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactoriesBuilder) throws IOException
      Specified by:
      innerBuild in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>
      Throws:
      IOException

    • shallowCopy

      protected org.elasticsearch.search.aggregations.AggregationBuilder shallowCopy(org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)
      Specified by:
      shallowCopy in class org.elasticsearch.search.aggregations.AggregationBuilder

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>