Type Alias DataSet

type DataSet = {
    additionalSchemas?: Schema[];
    appTypeOverride?: string;
    createdBy?: string;
    createdByConnectionId?: string;
    createdTime?: string;
    dataAssetInfo: DataAssetInfo;
    description?: string;
    id?: string;
    lastModifiedBy?: string;
    lastModifiedTime?: string;
    name?: string;
    operational?: Operational;
    ownerId?: string;
    properties?: Record<string, unknown>;
    qri: string;
    schema?: Schema;
    secureQri: string;
    spaceId?: string;
    tags?: string[];
    technicalDescription?: string;
    technicalName: string;
    tenantId?: string;
    type?: string;
    version?: number;
}
Index

Properties

additionalSchemas? appTypeOverride? createdBy? createdByConnectionId? createdTime? dataAssetInfo description? id? lastModifiedBy? lastModifiedTime? name? operational? ownerId? properties? qri schema? secureQri spaceId? tags? technicalDescription? technicalName tenantId? type? version?

Properties

additionalSchemas?: Schema[]

Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema

appTypeOverride?: string

Optional override of DataAsset appType.

createdBy?: string

The value is automatically set by the application. User defined value is ignored.

createdByConnectionId?: string

The connectionId that created the Dataset. Optional.

createdTime?: string

The value is automatically set by the application. User defined value is ignored.

dataAssetInfo: DataAssetInfo
description?: string
id?: string

Only required when updating the resource. Must be null for new resources.

lastModifiedBy?: string

The value is automatically set by the application. User defined value is ignored.

lastModifiedTime?: string

The value is automatically set by the application. User defined value is ignored.

name?: string
operational?: Operational
ownerId?: string

The value is automatically set by the application.

properties?: Record<string, unknown>

A Map of name-value pairs.

qri: string

NOTE: this will be deprecated after migration to secureQri. Required user defined field. All the parts in the format must be separated by ':'. The first part denotes the resourceType, followed by dataStoreType and tenant guid. The spaceGuid or userGuid is to be populated based on if the dataset is in shared or private space and finally the full file name. This field is auto populated for the dataSet generated for qix-datafiles.

schema?: Schema

Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema

secureQri: string
spaceId?: string
tags?: string[]
technicalDescription?: string
technicalName: string
tenantId?: string

The value is automatically set by the application. User defined value is ignored.

type?: string
version?: number

Only required when updating the resource. Must be null for new resources.

Settings

Member Visibility

On This Page

Properties