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

Class RuntimeField.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<RuntimeField.Builder>

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

All Implemented Interfaces:

WithJson<RuntimeField.Builder>, ObjectBuilder<RuntimeField>

Enclosing class:

RuntimeField

public static class RuntimeField.Builder
extends WithJsonObjectBuilderBase<RuntimeField.Builder>
implements ObjectBuilder<RuntimeField>

Builder for RuntimeField.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RuntimeField	build()	Builds a RuntimeField.
final RuntimeField.Builder	fetchFields(RuntimeFieldFetchFields value, RuntimeFieldFetchFields... values)	For type lookup
final RuntimeField.Builder	fetchFields(Function<RuntimeFieldFetchFields.Builder,ObjectBuilder<RuntimeFieldFetchFields>> fn)	For type lookup
final RuntimeField.Builder	fetchFields(List<RuntimeFieldFetchFields> list)	For type lookup
final RuntimeField.Builder	fields(String key, CompositeSubField value)	For type composite
final RuntimeField.Builder	fields(String key, Function<CompositeSubField.Builder,ObjectBuilder<CompositeSubField>> fn)	For type composite
final RuntimeField.Builder	fields(Map<String,CompositeSubField> map)	For type composite
final RuntimeField.Builder	format(String value)	A custom format for date type runtime fields.
final RuntimeField.Builder	inputField(String value)	For type lookup
final RuntimeField.Builder	onScriptError(OnScriptError value)	API name: on_script_error
final RuntimeField.Builder	script(Script value)	Painless script executed at query time.
final RuntimeField.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	Painless script executed at query time.
protected RuntimeField.Builder	self()
final RuntimeField.Builder	targetField(String value)	For type lookup
final RuntimeField.Builder	targetIndex(String value)	For type lookup
final RuntimeField.Builder	type(RuntimeFieldType value)	Required - Field type, which can be: boolean, composite, date, double, geo_point, ip,keyword, long, or lookup.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

fields

public final RuntimeField.Builder fields(Map<String,CompositeSubField> map)

For type composite

API name: fields

Adds all entries of map to fields.

fields

public final RuntimeField.Builder fields(String key,
 CompositeSubField value)

For type composite

API name: fields

Adds an entry to fields.

fields

public final RuntimeField.Builder fields(String key,
 Function<CompositeSubField.Builder,ObjectBuilder<CompositeSubField>> fn)

For type composite

API name: fields

Adds an entry to fields using a builder lambda.

fetchFields

public final RuntimeField.Builder fetchFields(List<RuntimeFieldFetchFields> list)

For type lookup

API name: fetch_fields

Adds all elements of list to fetchFields.

fetchFields

public final RuntimeField.Builder fetchFields(RuntimeFieldFetchFields value,
 RuntimeFieldFetchFields... values)

For type lookup

API name: fetch_fields

Adds one or more values to fetchFields.

fetchFields

public final RuntimeField.Builder fetchFields(Function<RuntimeFieldFetchFields.Builder,ObjectBuilder<RuntimeFieldFetchFields>> fn)

For type lookup

API name: fetch_fields

Adds a value to fetchFields using a builder lambda.

format

public final RuntimeField.Builder format(@Nullable
 String value)

A custom format for date type runtime fields.

API name: format

inputField

public final RuntimeField.Builder inputField(@Nullable
 String value)

For type lookup

API name: input_field

targetField

public final RuntimeField.Builder targetField(@Nullable
 String value)

For type lookup

API name: target_field

targetIndex

public final RuntimeField.Builder targetIndex(@Nullable
 String value)

For type lookup

API name: target_index

script

public final RuntimeField.Builder script(@Nullable
 Script value)

Painless script executed at query time.

API name: script

script

public final RuntimeField.Builder script(Function<Script.Builder,ObjectBuilder<Script>> fn)

Painless script executed at query time.

API name: script

onScriptError

public final RuntimeField.Builder onScriptError(@Nullable
 OnScriptError value)

API name: on_script_error

type

public final RuntimeField.Builder type(RuntimeFieldType value)

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

API name: type

self

protected RuntimeField.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<RuntimeField.Builder>

build

public RuntimeField build()

Builds a RuntimeField.

Specified by:

build in interface ObjectBuilder<RuntimeField>

Throws:

NullPointerException - if some of the required fields are null.