Embedded Values Property

A property that contains values from a selected DataModel. See DataModels for more details on how to define DataModels.

• Kotlin Definition: EmbeddedValuesDefinition<DM> where DM is the embedded DataModel
• Kotlin Value: Values<DM> where DM is the embedded DataModel
• Maryk Yaml Definition: Embed

Usage options

• Value
• Map value

Validation Options

• required - default true
• final - default false

Other options

• default - the default value to be used if value was not set.
• dataModel - Refers to DataModel to be embedded

Examples

Example of an Embedded Values property definition for use within a Model

val address by embed(
    index = 1u,
    required = false,
    final = true,
    dataModel = { Address }
)

Example of a separate Embedded Values property definition

val def = EmbeddedValuesDefinition(
    required = false,
    final = true,
    dataModel = { Address }
)

Setting Values (builder DSL)

Embedded values are regular Values<DM> instances. The typical pattern is to build the embedded values with the embedded data model’s create { } and assign it with with.

// Property on a DataModel
val address by embed(
    index = 1u,
    required = false,
    dataModel = { Address }
)

// Setting an embedded value using the builder DSL
val user = User.create {
    address with {
        street with "Main St"
        postalCode with "1234AB"
        // set other fields as needed
    }
}

// Alternative: construct the embedded values beforehand
val addr = Address.create {
    street with "Main St"
    postalCode with "1234AB"
}
val user2 = User.create {
    address with addr
}

Transport Byte representation

Uses the embedded-message encoding. The nested model determines the property indexes and wire types within the payload.