org.elasticsearch.search.aggregations.bucket.sampler

Class SamplerParser

java.lang.Object

org.elasticsearch.search.aggregations.bucket.sampler.SamplerParser

All Implemented Interfaces:

Aggregator.Parser

public class SamplerParser
extends Object
implements Aggregator.Parser

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SHARD_SAMPLE_SIZE
static boolean	DEFAULT_USE_GLOBAL_ORDINALS
static ParseField	EXECUTION_HINT_FIELD
static int	MAX_DOCS_PER_VALUE_DEFAULT
static ParseField	MAX_DOCS_PER_VALUE_FIELD
static ParseField	SHARD_SIZE_FIELD

Constructor Summary

Constructors

Constructor and Description
SamplerParser()

Method Summary

Methods

Modifier and Type	Method and Description
AggregatorFactory	parse(String aggregationName, XContentParser parser, SearchContext context) Returns the aggregator factory with which this parser is associated, may return null indicating the aggregation should be skipped (e.g.
String	type()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SHARD_SAMPLE_SIZE

public static final int DEFAULT_SHARD_SAMPLE_SIZE

See Also:

Constant Field Values

SHARD_SIZE_FIELD

public static final ParseField SHARD_SIZE_FIELD

MAX_DOCS_PER_VALUE_FIELD

public static final ParseField MAX_DOCS_PER_VALUE_FIELD

EXECUTION_HINT_FIELD

public static final ParseField EXECUTION_HINT_FIELD

DEFAULT_USE_GLOBAL_ORDINALS

public static final boolean DEFAULT_USE_GLOBAL_ORDINALS

See Also:

Constant Field Values

MAX_DOCS_PER_VALUE_DEFAULT

public static final int MAX_DOCS_PER_VALUE_DEFAULT

See Also:

Constant Field Values

Constructor Detail

SamplerParser

public SamplerParser()

Method Detail

type

public String type()

Specified by:

type in interface Aggregator.Parser

Returns:

The aggregation type this parser is associated with.

parse

public AggregatorFactory parse(String aggregationName,
                      XContentParser parser,
                      SearchContext context)
                        throws IOException

Description copied from interface: Aggregator.Parser

Returns the aggregator factory with which this parser is associated, may return null indicating the aggregation should be skipped (e.g. when trying to aggregate on unmapped fields).

Specified by:

parse in interface Aggregator.Parser

Parameters:

aggregationName - The name of the aggregation

parser - The xcontent parser

context - The search context

Returns:

The resolved aggregator factory or null in case the aggregation should be skipped

Throws:

IOException - When parsing fails