Skip to main content

BlueprintMetaRootDto

Namespace: Meshmakers.Octo.ConstructionKit.Contracts.BlueprintCatalogs.DataTransferObjects

Represents the content of the blueprint metadata file

public class BlueprintMetaRootDto : BlueprintPropertiesDto

Inheritance Object → BlueprintPropertiesDto → BlueprintMetaRootDto

Fields​

BlueprintMetaSchemaUri​

The URI of the schema for the blueprint meta.

public static string BlueprintMetaSchemaUri;

Properties​

SchemaUri​

The URI of the schema for the blueprint meta used for serialization.

public string SchemaUri { get; }

Property Value​

String

CkModelDependencies​

Gets or sets the CK model dependencies of the blueprint.

public List<CkModelIdVersionRange> CkModelDependencies { get; set; }

Property Value​

List<CkModelIdVersionRange>

BlueprintDependencies​

Gets or sets the blueprint dependencies. When this blueprint is installed, the listed blueprints are resolved transitively, topo-sorted and installed first as separate installations (each marked as a dependency on the runtime installation record).

public List<BlueprintIdVersionRange> BlueprintDependencies { get; set; }

Property Value​

List<BlueprintIdVersionRange>

SeedDataPath​

Gets or sets the path to the seed data file (relative to blueprint root). Single-file form; use BlueprintMetaRootDto.SeedDataPaths to split a large seed across several files.

public string SeedDataPath { get; set; }

Property Value​

String

SeedDataPaths​

Gets or sets the paths to the seed data files (relative to blueprint root). Lets a large seed be split across several files and folders (e.g. one pipeline plus its data flow per file). Every listed file is loaded and merged into a single runtime model before the import runs, so associations may reference entities declared in any other listed file — the order of the list does not affect the result. It only fixes the order in which duplicate rtIds are reported. When both this and BlueprintMetaRootDto.SeedDataPath are set the single path is loaded first and the list follows; duplicate paths are collapsed. Use BlueprintSeedData.ResolvePaths(BlueprintMetaRootDto) to obtain the effective list.

public List<string> SeedDataPaths { get; set; }

Property Value​

List<String>

Migrations​

Gets or sets the migration scripts from previous versions.

public List<BlueprintMigrationReferenceDto> Migrations { get; set; }

Property Value​

List<BlueprintMigrationReferenceDto>

Requires​

Gets or sets the optional preconditions evaluated before this blueprint is applied. Each key is the name of a blueprint variable (e.g. octo.environment, octo.isSystemTenant) and the value is the list of acceptable values. The blueprint is skipped when the resolved variable is missing from the tenant context or does not match any of the listed values. YAML accepts both scalar and sequence shapes per value — RequiresMapConverter normalises scalars to a single-element list during deserialisation.

public RequiresMap Requires { get; set; }

Property Value​

RequiresMap

BlueprintId​

Gets or sets the blueprint id.

public BlueprintId BlueprintId { get; set; }

Property Value​

BlueprintId

Description​

An optional description of the blueprint

public string Description { get; set; }

Property Value​

String

Constructors​

BlueprintMetaRootDto()​

Creates a new instance of the BlueprintMetaRootDto class.

public BlueprintMetaRootDto()