Package version:

Interface GetMetadataActivity

Activity to get metadata of dataset

interface GetMetadataActivity {
    dataset: DatasetReference;
    dependsOn?: ActivityDependency[];
    description?: string;
    fieldList?: any[];
    formatSettings?: FormatReadSettingsUnion;
    linkedServiceName?: LinkedServiceReference;
    name: string;
    onInactiveMarkAs?: string;
    policy?: ActivityPolicy;
    state?: string;
    storeSettings?: StoreReadSettingsUnion;
    type: "GetMetadata";
    userProperties?: UserProperty[];
}

Hierarchy (view full)

Properties

dataset dependsOn? description? fieldList? formatSettings? linkedServiceName? name onInactiveMarkAs? policy? state? storeSettings? type userProperties?

Properties

dataset

dataset: DatasetReference

GetMetadata activity dataset reference.

OptionaldependsOn

dependsOn?: ActivityDependency[]

Activity depends on condition.

Optionaldescription

description?: string

Activity description.

OptionalfieldList

fieldList?: any[]

Fields of metadata to get from dataset.

OptionalformatSettings

formatSettings?: FormatReadSettingsUnion

GetMetadata activity format settings.

OptionallinkedServiceName

linkedServiceName?: LinkedServiceReference

Linked service reference.

name

name: string

Activity name.

OptionalonInactiveMarkAs

onInactiveMarkAs?: string

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

Optionalpolicy

policy?: ActivityPolicy

Activity policy.

Optionalstate

state?: string

Activity state. This is an optional property and if not provided, the state will be Active by default.

OptionalstoreSettings

storeSettings?: StoreReadSettingsUnion

GetMetadata activity store settings.

type

type

Polymorphic discriminator, which specifies the different types this object can be

OptionaluserProperties

userProperties?: UserProperty[]

Activity user properties.

Settings

Member Visibility