KSLCore/ksl.app.bundle/ConfigRecipeKind

ConfigRecipeKind

enum ConfigRecipeKind : Enum<ConfigRecipeKind> (source)

Identifies the configuration shape of a KSLConfigRecipe shipped inside a bundle.

The kind tells a consumer which deserializer to apply to the recipe's stream (for example, RunConfigurationToml for RUN and SCENARIO_BATCH, OptimizationRunConfigurationToml for OPTIMIZATION). This keeps the bundle SPI itself free of any dependency on a particular config format — the format lives in ksl.app.config.*, the SPI only labels the file.

The kinds correspond one-to-one with the four sealed variants of RunSpec and with the per-kind subdirectories under META-INF/ksl/models/<modelId>/ defined in BundleLayout.

Entries

RUN

A single RunConfiguration.

SCENARIO_BATCH

A batch of scenarios authored together.

EXPERIMENT

A designed-experiment specification over one model's controls.

OPTIMIZATION

An OptimizationRunConfiguration.

Properties

entries

val entries: EnumEntries<ConfigRecipeKind>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Functions

valueOf

fun valueOf(value: String): ConfigRecipeKind

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<ConfigRecipeKind>

Returns an array containing the constants of this enum type, in the order they're declared.