MetaFields

Metadata fields: https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html

Constructors

MetaFields

Types

BaseMetaField

abstract class BaseMetaField<V, B : MappingField<V>>(name: String, type: FieldType<V, V>, params: Params, boundFieldFactory: (String, Params, MetaFields) -> B) : FieldSet.Field<V, V>

BoundFieldNamesField

class BoundFieldNamesField(name: String, params: Params, parent: MetaFields) : BoundField<String, String>

BoundRoutingField

class BoundRoutingField(name: String, params: Params, parent: MetaFields) : BoundField<String, String>

BoundSizeField

class BoundSizeField(name: String, params: Params, parent: MetaFields) : BoundField<Long, Long>

BoundSourceField

class BoundSourceField(name: String, params: Params, parent: MetaFields) : BoundField<String, String>

FieldNamesField

class FieldNamesField(enabled: Boolean?) : MetaFields.BaseMetaField<String, MetaFields.BoundFieldNamesField>

MetaField

open class MetaField<V>(name: String, type: FieldType<V, V>, params: Params) : MetaFields.BaseMetaField<V, BoundField<V, V>>

RoutingField

class RoutingField(required: Boolean?) : MetaFields.BaseMetaField<String, MetaFields.BoundRoutingField>

SizeField

class SizeField(enabled: Boolean?) : MetaFields.BaseMetaField<Long, MetaFields.BoundSizeField>

SourceField

class SourceField(enabled: Boolean?, includes: List<String>?, excludes: List<String>?) : MetaFields.BaseMetaField<String, MetaFields.BoundSourceField>

Functions

boolean

fun boolean(name: String? = null, docValues: Boolean? = null, index: Boolean? = null, store: Boolean? = null, params: Params? = null): FieldSet.Field<Boolean, Boolean>

byte

fun byte(name: String? = null, docValues: Boolean? = null, index: Boolean? = null, store: Boolean? = null, params: Params? = null): FieldSet.Field<Byte, Byte>

double

fun double(name: String? = null, docValues: Boolean? = null, index: Boolean? = null, store: Boolean? = null, params: Params? = null): FieldSet.Field<Double, Double>

field

fun <V, T> field(type: FieldType<V, T>, docValues: Boolean? = null, index: Boolean? = null, store: Boolean? = null, params: Params? = null): FieldSet.Field<V, T>

fun <V, T> field(name: String?, type: FieldType<V, T>, docValues: Boolean? = null, index: Boolean? = null, store: Boolean? = null, params: Params? = null): FieldSet.Field<V, T>

float

fun float(name: String? = null, docValues: Boolean? = null, index: Boolean? = null, store: Boolean? = null, params: Params? = null): FieldSet.Field<Float, Float>

get

operator fun get(name: String): MappingField<*>?

getAllFields

fun getAllFields(): Collection<MappingField<*>>

getFieldByName

inline fun <T> getFieldByName(name: String): MappingField<T>

getFieldName

open override fun getFieldName(): String

getQualifiedFieldName

open override fun getQualifiedFieldName(): String

int

fun int(name: String? = null, docValues: Boolean? = null, index: Boolean? = null, store: Boolean? = null, params: Params? = null): FieldSet.Field<Int, Int>

join

fun join(name: String? = null, relations: Map<String, List<String>>, eagerGlobalOrdinals: Boolean? = null): FieldSet.JoinField

keyword

fun keyword(name: String? = null, normalizer: String? = null, docValues: Boolean? = null, index: Boolean? = null, store: Boolean? = null, params: Params? = null): FieldSet.Field<String, String>

long

fun long(name: String? = null, docValues: Boolean? = null, index: Boolean? = null, store: Boolean? = null, params: Params? = null): FieldSet.Field<Long, Long>

nested

fun <T : SubDocument> nested(factory: (DocSourceField) -> T, dynamic: Dynamic? = null, params: Params = Params()): SubDocument.UnboundSubDocument<T>

fun <T : SubDocument> nested(name: String?, factory: (DocSourceField) -> T, dynamic: Dynamic? = null, params: Params = Params()): SubDocument.UnboundSubDocument<T>

obj

fun <T : SubDocument> obj(factory: (DocSourceField) -> T, enabled: Boolean? = null, dynamic: Dynamic? = null, params: Params = Params()): SubDocument.UnboundSubDocument<T>

fun <T : SubDocument> obj(name: String?, factory: (DocSourceField) -> T, enabled: Boolean? = null, dynamic: Dynamic? = null, params: Params = Params()): SubDocument.UnboundSubDocument<T>

object

fun <T : SubDocument> object(factory: (DocSourceField) -> T, enabled: Boolean? = null, dynamic: Dynamic? = null, params: Params = Params()): SubDocument.UnboundSubDocument<T>

fun <T : SubDocument> object(name: String?, factory: (DocSourceField) -> T, enabled: Boolean? = null, dynamic: Dynamic? = null, params: Params = Params()): SubDocument.UnboundSubDocument<T>

short

fun short(name: String? = null, docValues: Boolean? = null, index: Boolean? = null, store: Boolean? = null, params: Params? = null): FieldSet.Field<Short, Short>

subFields

fun <V, F : SubFields<V>> FieldSet.Field<V, V>.subFields(factory: (BoundField<V, V>) -> F): SubFields.UnboundSubFields<V, F>

text

fun text(name: String? = null, index: Boolean? = null, indexOptions: String? = null, store: Boolean? = null, norms: Boolean? = null, boost: Double? = null, analyzer: String? = null, searchAnalyzer: String? = null, params: Params? = null): FieldSet.Field<String, String>

toValue

open override fun toValue(): String

Properties

fieldNames

open val fieldNames: <ERROR CLASS>

val id: <ERROR CLASS>

ignored

val ignored: <ERROR CLASS>

index

val index: <ERROR CLASS>

routing

open val routing: <ERROR CLASS>

size

open val size: <ERROR CLASS>

source

open val source: <ERROR CLASS>

type

val type: <ERROR CLASS>