SubDocument

abstract class SubDocument(field: DocSourceField, dynamic: Dynamic?) : BaseDocument, FieldOperations<Nothing>

Represents Elasticsearch sub-document.

Constructors

SubDocument

fun SubDocument(field: DocSourceField, dynamic: Dynamic? = null)

Types

UnboundSubDocument

class UnboundSubDocument<T : SubDocument>(name: String?, type: ObjectType<BaseDocSource>, params: Params, subDocumentFactory: (DocSourceField) -> T)

Functions

asc

open fun asc(mode: Sort.Mode? = null, numericType: Sort.NumericType? = null, missing: Sort.Missing? = null, unmappedType: FieldType<*, *>? = null, nested: Sort.Nested? = null): Sort

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>

desc

open fun desc(mode: Sort.Mode? = null, numericType: Sort.NumericType? = null, missing: Sort.Missing? = null, unmappedType: FieldType<*, *>? = null, nested: Sort.Nested? = null): Sort

deserializeTerm

open fun deserializeTerm(v: Any): Nothing

double

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

eq

open infix fun eq(term: Nothing?): QueryExpression

open fun eq(term: Nothing?, boost: Double? = null): QueryExpression

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>

format

open fun format(format: String? = null): FieldFormat

get

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

getAllFields

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

getBoundField

fun getBoundField(): DocSourceField

getFieldByName

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

getFieldName

open override fun getFieldName(): String

getFieldType

open override fun getFieldType(): FieldType<BaseDocSource, Nothing>

getParent

fun getParent(): FieldSet

getQualifiedFieldName

open override fun getQualifiedFieldName(): String

gt

open infix fun gt(other: Nothing?): Range<Nothing>

gte

open infix fun gte(other: Nothing?): Range<Nothing>

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>

lt

open infix fun lt(other: Nothing?): Range<Nothing>

lte

open infix fun lte(other: Nothing?): Range<Nothing>

ne

open infix fun ne(term: Nothing?): QueryExpression

open fun ne(term: Nothing?, boost: Double? = null): QueryExpression

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>

oneOf

open infix fun oneOf(terms: List<Nothing>): QueryExpression

range

open fun range(gt: Nothing? = null, gte: Nothing? = null, lt: Nothing? = null, lte: Nothing? = null, boost: Double? = null): Range<Nothing>

serializeTerm

open fun serializeTerm(v: Nothing): Any

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

options

val options: MappingOptions

Extensions

list

fun SubDocument.list(): BoundField<MutableList<DynDocSource?>, Nothing>