Package version:

Interface ScriptActivity

Script activity type.

interface ScriptActivity {
    dependsOn?: ActivityDependency[];
    description?: string;
    linkedServiceName?: LinkedServiceReference;
    logSettings?: ScriptActivityTypePropertiesLogSettings;
    name: string;
    onInactiveMarkAs?: string;
    policy?: ActivityPolicy;
    returnMultistatementResult?: any;
    scriptBlockExecutionTimeout?: any;
    scripts?: ScriptActivityScriptBlock[];
    state?: string;
    type: "Script";
    userProperties?: UserProperty[];
}

Hierarchy (view full)

Properties

dependsOn? description? linkedServiceName? logSettings? name onInactiveMarkAs? policy? returnMultistatementResult? scriptBlockExecutionTimeout? scripts? state? type userProperties?

Properties

OptionaldependsOn

dependsOn?: ActivityDependency[]

Activity depends on condition.

Optionaldescription

description?: string

Activity description.

OptionallinkedServiceName

linkedServiceName?: LinkedServiceReference

Linked service reference.

OptionallogSettings

logSettings?: ScriptActivityTypePropertiesLogSettings

Log settings of script activity.

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.

OptionalreturnMultistatementResult

returnMultistatementResult?: any

Enable to retrieve result sets from multiple SQL statements and the number of rows affected by the DML statement. Supported connector: SnowflakeV2. Type: boolean (or Expression with resultType boolean).

OptionalscriptBlockExecutionTimeout

scriptBlockExecutionTimeout?: any

ScriptBlock execution timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optionalscripts

scripts?: ScriptActivityScriptBlock[]

Array of script blocks. Type: array.

Optionalstate

state?: string

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

type

type

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

OptionaluserProperties

userProperties?: UserProperty[]

Activity user properties.

Settings

Member Visibility