ExecuteSsisPackageActivity Class

Package:

com.azure.resourcemanager.datafactory.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-datafactory:1.2.0

• java.lang.Object
• • com.azure.resourcemanager.datafactory.models.Activity
  • • com.azure.resourcemanager.datafactory.models.ExecutionActivity
    • • com.azure.resourcemanager.datafactory.models.ExecuteSsisPackageActivity

public final class ExecuteSsisPackageActivity
extends ExecutionActivity

Execute SSIS package activity.

Constructor Summary

Constructor	Description
ExecuteSsisPackageActivity()	Creates an instance of ExecuteSsisPackageActivity class.

Method Summary

Modifier and Type	Method and Description
IntegrationRuntimeReference	connectVia() Get the connectVia property: The integration runtime reference.
Object	environmentPath() Get the environmentPath property: The environment path to execute the SSIS package.
SsisExecutionCredential	executionCredential() Get the executionCredential property: The package execution credential.
static ExecuteSsisPackageActivity	fromJson(JsonReader jsonReader) Reads an instance of ExecuteSsisPackageActivity from the JsonReader.
Object	loggingLevel() Get the loggingLevel property: The logging level of SSIS package execution.
SsisLogLocation	logLocation() Get the logLocation property: SSIS package execution log location.
Map<String,Map<String,SsisExecutionParameter>>	packageConnectionManagers() Get the packageConnectionManagers property: The package level connection managers to execute the SSIS package.
SsisPackageLocation	packageLocation() Get the packageLocation property: SSIS package location.
Map<String,SsisExecutionParameter>	packageParameters() Get the packageParameters property: The package level parameters to execute the SSIS package.
Map<String,Map<String,SsisExecutionParameter>>	projectConnectionManagers() Get the projectConnectionManagers property: The project level connection managers to execute the SSIS package.
Map<String,SsisExecutionParameter>	projectParameters() Get the projectParameters property: The project level parameters to execute the SSIS package.
Map<String,SsisPropertyOverride>	propertyOverrides() Get the propertyOverrides property: The property overrides to execute the SSIS package.
Object	runtime() Get the runtime property: Specifies the runtime to execute SSIS package.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: Type of activity.
void	validate() Validates the instance.
ExecuteSsisPackageActivity	withConnectVia(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.
ExecuteSsisPackageActivity	withDependsOn(List<ActivityDependency> dependsOn) Set the dependsOn property: Activity depends on condition.
ExecuteSsisPackageActivity	withDescription(String description) Set the description property: Activity description.
ExecuteSsisPackageActivity	withEnvironmentPath(Object environmentPath) Set the environmentPath property: The environment path to execute the SSIS package.
ExecuteSsisPackageActivity	withExecutionCredential(SsisExecutionCredential executionCredential) Set the executionCredential property: The package execution credential.
ExecuteSsisPackageActivity	withLinkedServiceName(LinkedServiceReference linkedServiceName) Set the linkedServiceName property: Linked service reference.
ExecuteSsisPackageActivity	withLoggingLevel(Object loggingLevel) Set the loggingLevel property: The logging level of SSIS package execution.
ExecuteSsisPackageActivity	withLogLocation(SsisLogLocation logLocation) Set the logLocation property: SSIS package execution log location.
ExecuteSsisPackageActivity	withName(String name) Set the name property: Activity name.
ExecuteSsisPackageActivity	withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs) Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.
ExecuteSsisPackageActivity	withPackageConnectionManagers(Map<String,Map<String,SsisExecutionParameter>> packageConnectionManagers) Set the packageConnectionManagers property: The package level connection managers to execute the SSIS package.
ExecuteSsisPackageActivity	withPackageLocation(SsisPackageLocation packageLocation) Set the packageLocation property: SSIS package location.
ExecuteSsisPackageActivity	withPackageParameters(Map<String,SsisExecutionParameter> packageParameters) Set the packageParameters property: The package level parameters to execute the SSIS package.
ExecuteSsisPackageActivity	withPolicy(ActivityPolicy policy) Set the policy property: Activity policy.
ExecuteSsisPackageActivity	withProjectConnectionManagers(Map<String,Map<String,SsisExecutionParameter>> projectConnectionManagers) Set the projectConnectionManagers property: The project level connection managers to execute the SSIS package.
ExecuteSsisPackageActivity	withProjectParameters(Map<String,SsisExecutionParameter> projectParameters) Set the projectParameters property: The project level parameters to execute the SSIS package.
ExecuteSsisPackageActivity	withPropertyOverrides(Map<String,SsisPropertyOverride> propertyOverrides) Set the propertyOverrides property: The property overrides to execute the SSIS package.
ExecuteSsisPackageActivity	withRuntime(Object runtime) Set the runtime property: Specifies the runtime to execute SSIS package.
ExecuteSsisPackageActivity	withState(ActivityState state) Set the state property: Activity state.
ExecuteSsisPackageActivity	withUserProperties(List<UserProperty> userProperties) Set the userProperties property: Activity user properties.

Methods inherited from Activity

additionalProperties dependsOn description name onInactiveMarkAs state userProperties withAdditionalProperties

Methods inherited from ExecutionActivity

fromJson linkedServiceName policy toJson type validate withDependsOn withDescription withLinkedServiceName withName withOnInactiveMarkAs withPolicy withState withUserProperties

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ExecuteSsisPackageActivity

public ExecuteSsisPackageActivity()

Creates an instance of ExecuteSsisPackageActivity class.

Method Details

connectVia

public IntegrationRuntimeReference connectVia()

Get the connectVia property: The integration runtime reference.

Returns:

the connectVia value.

environmentPath

public Object environmentPath()

Get the environmentPath property: The environment path to execute the SSIS package. Type: string (or Expression with resultType string).

Returns:

the environmentPath value.

executionCredential

public SsisExecutionCredential executionCredential()

Get the executionCredential property: The package execution credential.

Returns:

the executionCredential value.

fromJson

public static ExecuteSsisPackageActivity fromJson(JsonReader jsonReader)

Reads an instance of ExecuteSsisPackageActivity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ExecuteSsisPackageActivity if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

loggingLevel

public Object loggingLevel()

Get the loggingLevel property: The logging level of SSIS package execution. Type: string (or Expression with resultType string).

Returns:

the loggingLevel value.

logLocation

public SsisLogLocation logLocation()

Get the logLocation property: SSIS package execution log location.

Returns:

the logLocation value.

packageConnectionManagers

public Map<String,Map<String,SsisExecutionParameter>> packageConnectionManagers()

Get the packageConnectionManagers property: The package level connection managers to execute the SSIS package.

Returns:

the packageConnectionManagers value.

packageLocation

public SsisPackageLocation packageLocation()

Get the packageLocation property: SSIS package location.

Returns:

the packageLocation value.

packageParameters

public Map<String,SsisExecutionParameter> packageParameters()

Get the packageParameters property: The package level parameters to execute the SSIS package.

Returns:

the packageParameters value.

projectConnectionManagers

public Map<String,Map<String,SsisExecutionParameter>> projectConnectionManagers()

Get the projectConnectionManagers property: The project level connection managers to execute the SSIS package.

Returns:

the projectConnectionManagers value.

projectParameters

public Map<String,SsisExecutionParameter> projectParameters()

Get the projectParameters property: The project level parameters to execute the SSIS package.

Returns:

the projectParameters value.

propertyOverrides

public Map<String,SsisPropertyOverride> propertyOverrides()

Get the propertyOverrides property: The property overrides to execute the SSIS package.

Returns:

the propertyOverrides value.

runtime

public Object runtime()

Get the runtime property: Specifies the runtime to execute SSIS package. The value should be "x86" or "x64". Type: string (or Expression with resultType string).

Returns:

the runtime value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ExecuteSsisPackageActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: Type of activity.

Overrides:

ExecuteSsisPackageActivity.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

ExecuteSsisPackageActivity.validate()

withConnectVia

public ExecuteSsisPackageActivity withConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Parameters:

connectVia - the connectVia value to set.

Returns:

the ExecuteSsisPackageActivity object itself.

withDependsOn

public ExecuteSsisPackageActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

ExecuteSsisPackageActivity.withDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

withDescription

public ExecuteSsisPackageActivity withDescription(String description)

Set the description property: Activity description.

Overrides:

ExecuteSsisPackageActivity.withDescription(String description)

Parameters:

description

withEnvironmentPath

public ExecuteSsisPackageActivity withEnvironmentPath(Object environmentPath)

Set the environmentPath property: The environment path to execute the SSIS package. Type: string (or Expression with resultType string).

Parameters:

environmentPath - the environmentPath value to set.

Returns:

the ExecuteSsisPackageActivity object itself.

withExecutionCredential

public ExecuteSsisPackageActivity withExecutionCredential(SsisExecutionCredential executionCredential)

Set the executionCredential property: The package execution credential.

Parameters:

executionCredential - the executionCredential value to set.

Returns:

the ExecuteSsisPackageActivity object itself.

withLinkedServiceName

public ExecuteSsisPackageActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

ExecuteSsisPackageActivity.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withLoggingLevel

public ExecuteSsisPackageActivity withLoggingLevel(Object loggingLevel)

Set the loggingLevel property: The logging level of SSIS package execution. Type: string (or Expression with resultType string).

Parameters:

loggingLevel - the loggingLevel value to set.

Returns:

the ExecuteSsisPackageActivity object itself.

withLogLocation

public ExecuteSsisPackageActivity withLogLocation(SsisLogLocation logLocation)

Set the logLocation property: SSIS package execution log location.

Parameters:

logLocation - the logLocation value to set.

Returns:

the ExecuteSsisPackageActivity object itself.

withName

public ExecuteSsisPackageActivity withName(String name)

Set the name property: Activity name.

Overrides:

ExecuteSsisPackageActivity.withName(String name)

Parameters:

name

withOnInactiveMarkAs

public ExecuteSsisPackageActivity withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Set the onInactiveMarkAs property: 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.

Overrides:

ExecuteSsisPackageActivity.withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

withPackageConnectionManagers

public ExecuteSsisPackageActivity withPackageConnectionManagers(Map<String,Map<String,SsisExecutionParameter>> packageConnectionManagers)

Set the packageConnectionManagers property: The package level connection managers to execute the SSIS package.

Parameters:

packageConnectionManagers - the packageConnectionManagers value to set.

Returns:

the ExecuteSsisPackageActivity object itself.

withPackageLocation

public ExecuteSsisPackageActivity withPackageLocation(SsisPackageLocation packageLocation)

Set the packageLocation property: SSIS package location.

Parameters:

packageLocation - the packageLocation value to set.

Returns:

the ExecuteSsisPackageActivity object itself.

withPackageParameters

public ExecuteSsisPackageActivity withPackageParameters(Map<String,SsisExecutionParameter> packageParameters)

Set the packageParameters property: The package level parameters to execute the SSIS package.

Parameters:

packageParameters - the packageParameters value to set.

Returns:

the ExecuteSsisPackageActivity object itself.

withPolicy

public ExecuteSsisPackageActivity withPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Overrides:

ExecuteSsisPackageActivity.withPolicy(ActivityPolicy policy)

Parameters:

policy

withProjectConnectionManagers

public ExecuteSsisPackageActivity withProjectConnectionManagers(Map<String,Map<String,SsisExecutionParameter>> projectConnectionManagers)

Set the projectConnectionManagers property: The project level connection managers to execute the SSIS package.

Parameters:

projectConnectionManagers - the projectConnectionManagers value to set.

Returns:

the ExecuteSsisPackageActivity object itself.

withProjectParameters

public ExecuteSsisPackageActivity withProjectParameters(Map<String,SsisExecutionParameter> projectParameters)

Set the projectParameters property: The project level parameters to execute the SSIS package.

Parameters:

projectParameters - the projectParameters value to set.

Returns:

the ExecuteSsisPackageActivity object itself.

withPropertyOverrides

public ExecuteSsisPackageActivity withPropertyOverrides(Map<String,SsisPropertyOverride> propertyOverrides)

Set the propertyOverrides property: The property overrides to execute the SSIS package.

Parameters:

propertyOverrides - the propertyOverrides value to set.

Returns:

the ExecuteSsisPackageActivity object itself.

withRuntime

public ExecuteSsisPackageActivity withRuntime(Object runtime)

Set the runtime property: Specifies the runtime to execute SSIS package. The value should be "x86" or "x64". Type: string (or Expression with resultType string).

Parameters:

runtime - the runtime value to set.

Returns:

the ExecuteSsisPackageActivity object itself.

withState

public ExecuteSsisPackageActivity withState(ActivityState state)

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

Overrides:

ExecuteSsisPackageActivity.withState(ActivityState state)

Parameters:

state

withUserProperties

public ExecuteSsisPackageActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

ExecuteSsisPackageActivity.withUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties