Package co.elastic.clients.elasticsearch._types.mapping

Class RuntimeField

java.lang.Object

co.elastic.clients.elasticsearch._types.mapping.RuntimeField

All Implemented Interfaces:

DynamicTemplateVariant, JsonpSerializable

@JsonpDeserializable
public class RuntimeField
extends Object
implements DynamicTemplateVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RuntimeField.Builder	Builder for RuntimeField.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<RuntimeField>	_DESERIALIZER	Json deserializer for RuntimeField

Method Summary

Modifier and Type	Method	Description
DynamicTemplate.Kind	_dynamicTemplateKind()	DynamicTemplate variant kind.
final List<RuntimeFieldFetchFields>	fetchFields()	For type lookup
final Map<String,CompositeSubField>	fields()	For type composite
final String	format()	A custom format for date type runtime fields.
final String	inputField()	For type lookup
static RuntimeField	of(Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)
final Script	script()	Painless script executed at query time.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRuntimeFieldDeserializer(ObjectDeserializer<RuntimeField.Builder> op)
final String	targetField()	For type lookup
final String	targetIndex()	For type lookup
String	toString()
final RuntimeFieldType	type()	Required - Field type, which can be: boolean, composite, date, double, geo_point, ip,keyword, long, or lookup.

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.mapping.DynamicTemplateVariant

_toDynamicTemplate

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RuntimeField> _DESERIALIZER

Json deserializer for RuntimeField

Method Details

of

public static RuntimeField of(Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)

_dynamicTemplateKind

public DynamicTemplate.Kind _dynamicTemplateKind()

DynamicTemplate variant kind.

Specified by:

_dynamicTemplateKind in interface DynamicTemplateVariant

fields

public final Map<String,CompositeSubField> fields()

For type composite

API name: fields

fetchFields

public final List<RuntimeFieldFetchFields> fetchFields()

For type lookup

API name: fetch_fields

format

@Nullable
public final String format()

A custom format for date type runtime fields.

API name: format

inputField

@Nullable
public final String inputField()

For type lookup

API name: input_field

targetField

@Nullable
public final String targetField()

For type lookup

API name: target_field

targetIndex

@Nullable
public final String targetIndex()

For type lookup

API name: target_index

script

@Nullable
public final Script script()

Painless script executed at query time.

API name: script

type

public final RuntimeFieldType type()

Required - Field type, which can be: boolean, composite, date, double, geo_point, ip,keyword, long, or lookup.

API name: type

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupRuntimeFieldDeserializer

protected static void setupRuntimeFieldDeserializer(ObjectDeserializer<RuntimeField.Builder> op)