Interface MLMappingDocument

A unit is a container of elements, it can not contain other units.

interface MLMappingDocument {
    $CreationOptions?: unknown;
    $ID: string;
    $Type: "MLMappings$MLMappingDocument";
    $UnitID?: string;
    documentation: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    mlModelFileName: string;
    mlModelMappings: null | MLModelMappings;
    mlModelMetadata: MLModelMetadata[];
    name: string;
    addMLModelMetadata(): Promise<MLModelMetadata>;
    getMLModelMetadata(name: string): undefined | MLModelMetadata;
}

Hierarchy (View Summary)

Document
- MLMappingDocument

Index

Properties

$CreationOptions? $ID $Type $UnitID? documentation excluded exportLevel mlModelFileName mlModelMappings mlModelMetadata name

Methods

addMLModelMetadata getMLModelMetadata

Properties

`Optional`$CreationOptions

$CreationOptions?: unknown

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "MLMappings$MLMappingDocument"

The type of the element.

`Optional`$UnitID

$UnitID?: string

documentation

documentation: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

mlModelFileName

mlModelFileName: string

mlModelMappings

mlModelMappings: null | MLModelMappings

mlModelMetadata

mlModelMetadata: MLModelMetadata[]

name

name: string

Methods

addMLModelMetadata

addMLModelMetadata(): Promise<MLModelMetadata>
Returns Promise<MLModelMetadata>

getMLModelMetadata

getMLModelMetadata(name: string): undefined | MLModelMetadata
Parameters
- name: string
Returns undefined | MLModelMetadata