Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class CompositeRuntimeField

java.lang.Object

org.elasticsearch.index.mapper.CompositeRuntimeField

All Implemented Interfaces:

RuntimeField, ToXContent, ToXContentFragment

public class CompositeRuntimeField
extends Object
implements RuntimeField

A runtime field of type object. Defines a script at the top level, which emits multiple sub-fields. The sub-fields are declared within the object in order to be made available to the field_caps and search API.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.RuntimeField

RuntimeField.Builder, RuntimeField.Parser

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final RuntimeField.Parser	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
Stream<MappedFieldType>	asMappedFieldTypes()	Exposes the MappedFieldTypes backing this runtime field, used to execute queries, run aggs etc.
String	name()	Exposes the name of the runtime field
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

PARSER

public static final RuntimeField.Parser PARSER

Method Details

name

public String name()

Description copied from interface: RuntimeField

Exposes the name of the runtime field

Specified by:

name in interface RuntimeField

Returns:

name of the field

asMappedFieldTypes

public Stream<MappedFieldType> asMappedFieldTypes()

Description copied from interface: RuntimeField

Exposes the MappedFieldTypes backing this runtime field, used to execute queries, run aggs etc.

Specified by:

asMappedFieldTypes in interface RuntimeField

Returns:

the MappedFieldTypes backing this runtime field

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException