Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.support

Class MultiValuesSourceFieldConfig

java.lang.Object

org.elasticsearch.search.aggregations.support.MultiValuesSourceFieldConfig

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class MultiValuesSourceFieldConfig
extends Object
implements Writeable, ToXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiValuesSourceFieldConfig.Builder

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	FILTER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MultiValuesSourceFieldConfig(String fieldName, Object missing, Script script, ZoneId timeZone, QueryBuilder filter, ValueType userValueTypeHint, String format, IncludeExclude includeExclude)
	MultiValuesSourceFieldConfig(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getFieldName()
QueryBuilder	getFilter()
String	getFormat()
IncludeExclude	getIncludeExclude()
Object	getMissing()
Script	getScript()
ZoneId	getTimeZone()
ValueType	getUserValueTypeHint()
int	hashCode()
static <C> ObjectParser<MultiValuesSourceFieldConfig.Builder,C>	parserBuilder(boolean scriptable, boolean timezoneAware, boolean filtered, boolean heterogeneous, boolean supportsIncludesExcludes)	Creates a parser capable of parsing value sources in different context
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

FILTER

public static final ParseField FILTER

Constructor Details

MultiValuesSourceFieldConfig

protected MultiValuesSourceFieldConfig(String fieldName,
 Object missing,
 Script script,
 ZoneId timeZone,
 QueryBuilder filter,
 ValueType userValueTypeHint,
 String format,
 IncludeExclude includeExclude)

MultiValuesSourceFieldConfig

public MultiValuesSourceFieldConfig(StreamInput in)
                             throws IOException

Throws:

IOException

Method Details

parserBuilder

public static <C>
ObjectParser<MultiValuesSourceFieldConfig.Builder,C> parserBuilder(boolean scriptable,
 boolean timezoneAware,
 boolean filtered,
 boolean heterogeneous,
 boolean supportsIncludesExcludes)

Creates a parser capable of parsing value sources in different context

Type Parameters:

C - - parser context

Parameters:

scriptable - - allows specifying script in addition to a field as a values source

timezoneAware - - allows specifying timezone

filtered - - allows specifying filters on the values

heterogeneous - - allows specifying value-source specific format and user value type hint

supportsIncludesExcludes - - allows specifying includes and excludes

Returns:

configured parser

getMissing

public Object getMissing()

getScript

public Script getScript()

getTimeZone

public ZoneId getTimeZone()

getFieldName

public String getFieldName()

getFilter

public QueryBuilder getFilter()

getUserValueTypeHint

public ValueType getUserValueTypeHint()

getFormat

public String getFormat()

getIncludeExclude

public IncludeExclude getIncludeExclude()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object