Skip to main content

Module template

Module template 

Source
Expand description

v2023-09 schema model types.

Modules§

parse
Template parsing: YAML/JSON decoding and dispatch by specificationVersion.

Structs§

Action
§5 Action
AmountRequirement
§3.3.1 AmountRequirement
AttributeRequirement
§3.3.2 AttributeRequirement
BoolUserInterface
User interface definition for BOOL parameters.
ChunkIntTaskParameterDefinition
§3.4.1.5 ChunkIntTaskParameterDefinition (TASK_CHUNKING extension)
ChunksDefinition
Chunks configuration for CHUNK[INT] parameters.
Description
§7.2 Description: any unicode except Cc category, length 0..=2048
EmbeddedFile
§6 EmbeddedFile
Environment
§4 Environment
EnvironmentActions
§4.1 EnvironmentActions
EnvironmentScript
§4.1 EnvironmentScript
EnvironmentTemplate
§1.2 EnvironmentTemplate
ExtensionName
§1.1.2 ExtensionName: [A-Z_0-9]{3,128}
FileFilter
§2.7 JobPathParameterFileFilter
FlexFloat
An f64 that deserializes from YAML numbers or numeric strings (e.g. "3.14"). Preserves the original string representation when parsed from a string, which is needed for round-trip fidelity in constraint checking. Rejects NaN, Infinity, booleans, and nulls.
FlexInt
An i64 that deserializes from YAML integers, integer-valued floats (e.g. 42.0), or numeric strings (e.g. "42"). Rejects booleans, nulls, and non-integer floats.
FloatTaskParameterDefinition
§3.4.1.2 FloatTaskParameterDefinition
FloatUserInterface
User interface definition for FLOAT parameters.
HiddenOnlyUserInterface
User interface definition for LIST[LIST[INT]] parameters (HIDDEN only).
HostRequirements
§3.3 HostRequirements
IntTaskParameterDefinition
§3.4.1.1 IntTaskParameterDefinition
IntUserInterface
User interface definition for INT parameters.
JobBoolParameterDefinition
§2.9 JobBoolParameterDefinition
JobFloatParameterDefinition
§2.4 JobFloatParameterDefinition
JobIntParameterDefinition
§2.3 JobIntParameterDefinition
JobListBoolParameterDefinition
§2.15 JobListBoolParameterDefinition
JobListFloatParameterDefinition
§2.14 JobListFloatParameterDefinition
JobListIntParameterDefinition
§2.13 JobListIntParameterDefinition
JobListListIntParameterDefinition
§2.16 JobListListIntParameterDefinition
JobListPathParameterDefinition
§2.12 JobListPathParameterDefinition
JobListStringParameterDefinition
§2.11 JobListStringParameterDefinition
JobPathParameterDefinition
§2.2 JobPathParameterDefinition
JobRangeExprParameterDefinition
§2.10 JobRangeExprParameterDefinition
JobStringParameterDefinition
§2.1 JobStringParameterDefinition
JobTemplate
§1.1 JobTemplate
ListFloatUserInterface
User interface definition for LIST[FLOAT] parameters.
ListIntUserInterface
User interface definition for LIST[INT] parameters.
ListPathUserInterface
User interface definition for LIST[PATH] parameters.
ListSimpleUserInterface
User interface definition for LIST[STRING] and LIST[BOOL] parameters.
PathTaskParameterDefinition
§3.4.1.4 PathTaskParameterDefinition
PathUserInterface
User interface definition for PATH parameters.
RangeExprUserInterface
User interface definition for RANGE_EXPR parameters.
SimpleAction
SimpleAction syntax sugar (FEATURE_BUNDLE_1). Allows specifying a script interpreter directly instead of a full StepScript.
StepActions
§3.5.1 StepActions
StepDependency
§3.2 StepDependency
StepParameterSpaceDefinition
§3.4 StepParameterSpaceDefinition
StepScript
§3.5 StepScript
StepTemplate
§3 StepTemplate
StringTaskParameterDefinition
§3.4.1.3 StringTaskParameterDefinition
StringUserInterface
User interface definition for STRING parameters.

Enums§

CancelationMode
§5.3 CancelationMethod — discriminated union on mode.
FloatRange
FloatRangeItem
A float range list item: either a literal float or a format string.
IntOrFormatString
An integer value or a format string (e.g. {{Param.ChunkSize}}).
IntRange
Int range: either a list of values or a range expression string.
JobParameterDefinition
§2 JobParameterDefinition — discriminated union on type field.
RangeConstraint
StringRange
Range that can be a list or a single expression string (EXPR extension). Concrete types to avoid derive conflicts with FormatString.
TaskParameterDefinition
§3.4.1 TaskParameterDefinition — discriminated union on type.