Interface DataSet

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

interface DataSet {
    $CreationOptions?: unknown;
    $ID: string;
    $Type: "DataSets$DataSet";
    $UnitID?: string;
    dataSetAccess: DataSetAccess;
    documentation: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    name: string;
    parameters: DataSetParameter[];
    source: DataSetSource;
    addDataSetParameter(): Promise<DataSetParameter>;
    getDataSetParameter(name: string): undefined | DataSetParameter;
}

Hierarchy (View Summary)

Document
- DataSet

Index

Properties

$CreationOptions? $ID $Type $UnitID? dataSetAccess documentation excluded exportLevel name parameters source

Methods

addDataSetParameter getDataSetParameter

Properties

`Optional`$CreationOptions

$CreationOptions?: unknown

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "DataSets$DataSet"

The type of the element.

`Optional`$UnitID

$UnitID?: string

dataSetAccess

dataSetAccess: DataSetAccess

documentation

documentation: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

name

name: string

parameters

parameters: DataSetParameter[]

source

source: DataSetSource

Methods

addDataSetParameter

addDataSetParameter(): Promise<DataSetParameter>
Returns Promise<DataSetParameter>

getDataSetParameter

getDataSetParameter(name: string): undefined | DataSetParameter
Parameters
- name: string
Returns undefined | DataSetParameter