ScriptedMetricParser

java.lang.Object
- org.elasticsearch.search.aggregations.metrics.scripted.ScriptedMetricParser

All Implemented Interfaces:: Aggregator.Parser

public class ScriptedMetricParser
extends Object
implements Aggregator.Parser

Field Summary

Fields

Modifier and Type	Field and Description
`static String`	`COMBINE_SCRIPT`
`static String`	`INIT_SCRIPT`
`static ParseField`	`LANG_FIELD`
`static String`	`MAP_SCRIPT`
`static ParseField`	`PARAMS_FIELD`
`static ParseField`	`REDUCE_PARAMS_FIELD`
`static String`	`REDUCE_SCRIPT`

Constructor Summary

Constructors

Constructor and Description
`ScriptedMetricParser()`

Method Summary

All Methods

Instance Methods

Concrete 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
  - INIT_SCRIPT
```
public static final String INIT_SCRIPT
```
    See Also:
    
    Constant Field Values
  - MAP_SCRIPT
```
public static final String MAP_SCRIPT
```
    See Also:
    
    Constant Field Values
  - COMBINE_SCRIPT
```
public static final String COMBINE_SCRIPT
```
    See Also:
    
    Constant Field Values
  - REDUCE_SCRIPT
```
public static final String REDUCE_SCRIPT
```
    See Also:
    
    Constant Field Values
  - PARAMS_FIELD
```
public static final ParseField PARAMS_FIELD
```
  - REDUCE_PARAMS_FIELD
```
public static final ParseField REDUCE_PARAMS_FIELD
```
  - LANG_FIELD
```
public static final ParseField LANG_FIELD
```
- Constructor Detail
  - ScriptedMetricParser
```
public ScriptedMetricParser()
```
- 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

Class ScriptedMetricParser

Field Summary

Fields

Constructor Summary

Constructors

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INIT_SCRIPT

MAP_SCRIPT

COMBINE_SCRIPT

REDUCE_SCRIPT

PARAMS_FIELD

REDUCE_PARAMS_FIELD

LANG_FIELD

Constructor Detail

ScriptedMetricParser

Method Detail

type

parse