Skip to main content

BlueprintValidationResult

Namespace: Meshmakers.Octo.Runtime.Contracts.Blueprints

Result of validating a blueprint

public class BlueprintValidationResult

Inheritance Object → BlueprintValidationResult

Properties​

IsValid​

Indicates if the blueprint is valid and can be applied

public bool IsValid { get; private set; }

Property Value​

Boolean

BlueprintId​

The blueprint that was validated

public BlueprintId BlueprintId { get; private set; }

Property Value​

BlueprintId

MissingCkModels​

List of CK models that are required but not available

public List<CkModelIdVersionRange> MissingCkModels { get; private set; }

Property Value​

List<CkModelIdVersionRange>

MissingBlueprints​

List of composed blueprints that are required but not available

public List<BlueprintIdVersionRange> MissingBlueprints { get; private set; }

Property Value​

List<BlueprintIdVersionRange>

MissingSeedDataFiles​

List of seed data files that are referenced but not found

public List<string> MissingSeedDataFiles { get; private set; }

Property Value​

List<String>

OperationResult​

Operation result containing validation messages

public OperationResult OperationResult { get; private set; }

Property Value​

OperationResult

Methods​

Valid(BlueprintId, OperationResult)​

Creates a valid result

public static BlueprintValidationResult Valid(BlueprintId blueprintId, OperationResult operationResult)

Parameters​

blueprintId BlueprintId
The blueprint id

operationResult OperationResult
Operation result with messages

Returns​

BlueprintValidationResult
A valid result

Invalid(BlueprintId, List<CkModelIdVersionRange>, List<BlueprintIdVersionRange>, List<String>, OperationResult)​

Creates an invalid result

public static BlueprintValidationResult Invalid(BlueprintId blueprintId, List<CkModelIdVersionRange> missingCkModels, List<BlueprintIdVersionRange> missingBlueprints, List<string> missingSeedDataFiles, OperationResult operationResult)

Parameters​

blueprintId BlueprintId
The blueprint id

missingCkModels List<CkModelIdVersionRange>
List of missing CK models

missingBlueprints List<BlueprintIdVersionRange>
List of missing blueprints

missingSeedDataFiles List<String>
List of missing seed data files

operationResult OperationResult
Operation result with error messages

Returns​

BlueprintValidationResult
An invalid result