Package com.azure.analytics.synapse.artifacts.models

Class ExecutePipelineActivity

java.lang.Object

com.azure.analytics.synapse.artifacts.models.Activity

com.azure.analytics.synapse.artifacts.models.ControlActivity

com.azure.analytics.synapse.artifacts.models.ExecutePipelineActivity

public class ExecutePipelineActivity
extends ControlActivity

Execute pipeline activity.

Constructor Summary

Constructors

Constructor	Description
ExecutePipelineActivity()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getParameters()	Get the parameters property: Pipeline parameters.
PipelineReference	getPipeline()	Get the pipeline property: Pipeline reference.
Boolean	isWaitOnCompletion()	Get the waitOnCompletion property: Defines whether activity execution will wait for the dependent pipeline execution to finish.
ExecutePipelineActivity	setDependsOn(List<ActivityDependency> dependsOn)	Set the dependsOn property: Activity depends on condition.
ExecutePipelineActivity	setDescription(String description)	Set the description property: Activity description.
ExecutePipelineActivity	setName(String name)	Set the name property: Activity name.
ExecutePipelineActivity	setParameters(Map<String,Object> parameters)	Set the parameters property: Pipeline parameters.
ExecutePipelineActivity	setPipeline(PipelineReference pipeline)	Set the pipeline property: Pipeline reference.
ExecutePipelineActivity	setUserProperties(List<UserProperty> userProperties)	Set the userProperties property: Activity user properties.
ExecutePipelineActivity	setWaitOnCompletion(Boolean waitOnCompletion)	Set the waitOnCompletion property: Defines whether activity execution will wait for the dependent pipeline execution to finish.

Methods inherited from class com.azure.analytics.synapse.artifacts.models.Activity

getAdditionalProperties, getDependsOn, getDescription, getName, getUserProperties, setAdditionalProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExecutePipelineActivity

public ExecutePipelineActivity()

Method Detail

getPipeline

public PipelineReference getPipeline()

Get the pipeline property: Pipeline reference.

Returns:

the pipeline value.

setPipeline

public ExecutePipelineActivity setPipeline(PipelineReference pipeline)

Set the pipeline property: Pipeline reference.

Parameters:

pipeline - the pipeline value to set.

Returns:

the ExecutePipelineActivity object itself.

getParameters

public Map<String,Object> getParameters()

Get the parameters property: Pipeline parameters.

Returns:

the parameters value.

setParameters

public ExecutePipelineActivity setParameters(Map<String,Object> parameters)

Set the parameters property: Pipeline parameters.

Parameters:

parameters - the parameters value to set.

Returns:

the ExecutePipelineActivity object itself.

isWaitOnCompletion

public Boolean isWaitOnCompletion()

Get the waitOnCompletion property: Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.

Returns:

the waitOnCompletion value.

setWaitOnCompletion

public ExecutePipelineActivity setWaitOnCompletion(Boolean waitOnCompletion)

Set the waitOnCompletion property: Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.

Parameters:

waitOnCompletion - the waitOnCompletion value to set.

Returns:

the ExecutePipelineActivity object itself.

setName

public ExecutePipelineActivity setName(String name)

Set the name property: Activity name.

Overrides:

setName in class ControlActivity

Parameters:

name - the name value to set.

Returns:

the Activity object itself.

setDescription

public ExecutePipelineActivity setDescription(String description)

Set the description property: Activity description.

Overrides:

setDescription in class ControlActivity

Parameters:

description - the description value to set.

Returns:

the Activity object itself.

setDependsOn

public ExecutePipelineActivity setDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

setDependsOn in class ControlActivity

Parameters:

dependsOn - the dependsOn value to set.

Returns:

the Activity object itself.

setUserProperties

public ExecutePipelineActivity setUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

setUserProperties in class ControlActivity

Parameters:

userProperties - the userProperties value to set.

Returns:

the Activity object itself.