Package version:

Interface HDInsightHiveActivity

HDInsight Hive activity type.

interface HDInsightHiveActivity {
    arguments?: any[];
    defines?: {
        [propertyName: string]: any;
    };
    dependsOn?: ActivityDependency[];
    description?: string;
    getDebugInfo?: string;
    linkedServiceName?: LinkedServiceReference;
    name: string;
    onInactiveMarkAs?: string;
    policy?: ActivityPolicy;
    queryTimeout?: number;
    scriptLinkedService?: LinkedServiceReference;
    scriptPath?: any;
    state?: string;
    storageLinkedServices?: LinkedServiceReference[];
    type: "HDInsightHive";
    userProperties?: UserProperty[];
    variables?: {
        [propertyName: string]: any;
    };
}

Hierarchy (view full)

Properties

arguments? defines? dependsOn? description? getDebugInfo? linkedServiceName? name onInactiveMarkAs? policy? queryTimeout? scriptLinkedService? scriptPath? state? storageLinkedServices? type userProperties? variables?

Properties

Optionalarguments

arguments?: any[]

User specified arguments to HDInsightActivity.

Optionaldefines

defines?: {
    [propertyName: string]: any;
}

Allows user to specify defines for Hive job request.

OptionaldependsOn

dependsOn?: ActivityDependency[]

Activity depends on condition.

Optionaldescription

description?: string

Activity description.

OptionalgetDebugInfo

getDebugInfo?: string

Debug info option.

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.

OptionalqueryTimeout

queryTimeout?: number

Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package)

OptionalscriptLinkedService

scriptLinkedService?: LinkedServiceReference

Script linked service reference.

OptionalscriptPath

scriptPath?: any

Script path. Type: string (or Expression with resultType string).

Optionalstate

state?: string

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

OptionalstorageLinkedServices

storageLinkedServices?: LinkedServiceReference[]

Storage linked service references.

type

type

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

OptionaluserProperties

userProperties?: UserProperty[]

Activity user properties.

Optionalvariables

variables?: {
    [propertyName: string]: any;
}

User specified arguments under hivevar namespace.

Settings

Member Visibility