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.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
,org.elasticsearch.index.query.Rewriteable<org.elasticsearch.search.aggregations.AggregationBuilder>
,org.elasticsearch.search.aggregations.BaseAggregationBuilder
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(QueryShardContext, 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>>
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality, org.elasticsearch.search.aggregations.AggregationBuilder.CommonFields
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAME
Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
config
Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
metadata
-
Constructor Summary
Constructors Constructor Description StringStatsAggregationBuilder(java.lang.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.common.xcontent.XContentBuilder
doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
boolean
equals(java.lang.Object obj)
java.lang.String
getType()
int
hashCode()
protected org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorFactory
innerBuild(org.elasticsearch.index.query.QueryShardContext queryShardContext, 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, java.util.Map<java.lang.String,java.lang.Object> metadata)
StringStatsAggregationBuilder
showDistribution(boolean showDistribution)
Compute the distribution of each character.Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
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, doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
-
Constructor Details
-
StringStatsAggregationBuilder
public StringStatsAggregationBuilder(java.lang.String name)
-
-
Method Details
-
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 classorg.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>
-
getType
public java.lang.String getType() -
doXContentBody
public org.elasticsearch.common.xcontent.XContentBuilder doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
doXContentBody
in classorg.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>
- Throws:
java.io.IOException
-
innerWriteTo
protected void innerWriteTo(org.elasticsearch.common.io.stream.StreamOutput out) throws java.io.IOException- Specified by:
innerWriteTo
in classorg.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>
- Throws:
java.io.IOException
-
bucketCardinality
public org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality bucketCardinality()- Specified by:
bucketCardinality
in classorg.elasticsearch.search.aggregations.AggregationBuilder
-
innerBuild
protected org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorFactory innerBuild(org.elasticsearch.index.query.QueryShardContext queryShardContext, org.elasticsearch.search.aggregations.support.ValuesSourceConfig config, org.elasticsearch.search.aggregations.AggregatorFactory parent, org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException- Specified by:
innerBuild
in classorg.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>
- Throws:
java.io.IOException
-
shallowCopy
protected org.elasticsearch.search.aggregations.AggregationBuilder shallowCopy(org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)- Specified by:
shallowCopy
in classorg.elasticsearch.search.aggregations.AggregationBuilder
-
hashCode
public int hashCode()- Overrides:
hashCode
in classorg.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classorg.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<StringStatsAggregationBuilder>
-