elasticmagic/dev.evo.elasticmagic.doc/MetaFields

MetaFields

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

Constructors

Types

abstract class BaseMetaField<V, B : MappingField<V>>(name: String, type: FieldType<V, V>, params: 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? = null) : MetaFields.BaseMetaField<String, MetaFields.BoundFieldNamesField>

MetaField

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

RoutingField

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

SizeField

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

SourceField

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

Functions

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

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>

subFields

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

toValue

open override fun toValue(): String

Properties

fieldNames

open val fieldNames: MetaFields.BoundFieldNamesField

val id: BoundField<String, String>

ignored

val ignored: BoundField<String, String>

index

val index: BoundField<String, String>

routing

open val routing: MetaFields.BoundRoutingField

size

open val size: MetaFields.BoundSizeField

source

open val source: MetaFields.BoundSourceField

type

val type: BoundField<String, String>