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

Class AzureMLExecutePipelineActivity

java.lang.Object

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

com.azure.analytics.synapse.artifacts.models.ExecutionActivity

com.azure.analytics.synapse.artifacts.models.AzureMLExecutePipelineActivity

public class AzureMLExecutePipelineActivity
extends ExecutionActivity

Azure ML Execute Pipeline activity.

Constructor Summary

Constructors

Constructor	Description
AzureMLExecutePipelineActivity()

Method Summary

Modifier and Type	Method	Description
Object	getContinueOnStepFailure()	Get the continueOnStepFailure property: Whether to continue execution of other steps in the PipelineRun if a step fails.
Object	getExperimentName()	Get the experimentName property: Run history experiment name of the pipeline run.
Object	getMlParentRunId()	Get the mlParentRunId property: The parent Azure ML Service pipeline run id.
Object	getMlPipelineId()	Get the mlPipelineId property: ID of the published Azure ML pipeline.
Object	getMlPipelineParameters()	Get the mlPipelineParameters property: Key,Value pairs to be passed to the published Azure ML pipeline endpoint.
AzureMLExecutePipelineActivity	setContinueOnStepFailure(Object continueOnStepFailure)	Set the continueOnStepFailure property: Whether to continue execution of other steps in the PipelineRun if a step fails.
AzureMLExecutePipelineActivity	setDependsOn(List<ActivityDependency> dependsOn)	Set the dependsOn property: Activity depends on condition.
AzureMLExecutePipelineActivity	setDescription(String description)	Set the description property: Activity description.
AzureMLExecutePipelineActivity	setExperimentName(Object experimentName)	Set the experimentName property: Run history experiment name of the pipeline run.
AzureMLExecutePipelineActivity	setLinkedServiceName(LinkedServiceReference linkedServiceName)	Set the linkedServiceName property: Linked service reference.
AzureMLExecutePipelineActivity	setMlParentRunId(Object mlParentRunId)	Set the mlParentRunId property: The parent Azure ML Service pipeline run id.
AzureMLExecutePipelineActivity	setMlPipelineId(Object mlPipelineId)	Set the mlPipelineId property: ID of the published Azure ML pipeline.
AzureMLExecutePipelineActivity	setMlPipelineParameters(Object mlPipelineParameters)	Set the mlPipelineParameters property: Key,Value pairs to be passed to the published Azure ML pipeline endpoint.
AzureMLExecutePipelineActivity	setName(String name)	Set the name property: Activity name.
AzureMLExecutePipelineActivity	setPolicy(ActivityPolicy policy)	Set the policy property: Activity policy.
AzureMLExecutePipelineActivity	setUserProperties(List<UserProperty> userProperties)	Set the userProperties property: Activity user properties.

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

getLinkedServiceName, getPolicy

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

AzureMLExecutePipelineActivity

public AzureMLExecutePipelineActivity()

Method Detail

getMlPipelineId

public Object getMlPipelineId()

Get the mlPipelineId property: ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).

Returns:

the mlPipelineId value.

setMlPipelineId

public AzureMLExecutePipelineActivity setMlPipelineId(Object mlPipelineId)

Set the mlPipelineId property: ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).

Parameters:

mlPipelineId - the mlPipelineId value to set.

Returns:

the AzureMLExecutePipelineActivity object itself.

getExperimentName

public Object getExperimentName()

Get the experimentName property: Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).

Returns:

the experimentName value.

setExperimentName

public AzureMLExecutePipelineActivity setExperimentName(Object experimentName)

Set the experimentName property: Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).

Parameters:

experimentName - the experimentName value to set.

Returns:

the AzureMLExecutePipelineActivity object itself.

getMlPipelineParameters

public Object getMlPipelineParameters()

Get the mlPipelineParameters property: Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).

Returns:

the mlPipelineParameters value.

setMlPipelineParameters

public AzureMLExecutePipelineActivity setMlPipelineParameters(Object mlPipelineParameters)

Set the mlPipelineParameters property: Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).

Parameters:

mlPipelineParameters - the mlPipelineParameters value to set.

Returns:

the AzureMLExecutePipelineActivity object itself.

getMlParentRunId

public Object getMlParentRunId()

Get the mlParentRunId property: The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).

Returns:

the mlParentRunId value.

setMlParentRunId

public AzureMLExecutePipelineActivity setMlParentRunId(Object mlParentRunId)

Set the mlParentRunId property: The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).

Parameters:

mlParentRunId - the mlParentRunId value to set.

Returns:

the AzureMLExecutePipelineActivity object itself.

getContinueOnStepFailure

public Object getContinueOnStepFailure()

Get the continueOnStepFailure property: Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).

Returns:

the continueOnStepFailure value.

setContinueOnStepFailure

public AzureMLExecutePipelineActivity setContinueOnStepFailure(Object continueOnStepFailure)

Set the continueOnStepFailure property: Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).

Parameters:

continueOnStepFailure - the continueOnStepFailure value to set.

Returns:

the AzureMLExecutePipelineActivity object itself.

setLinkedServiceName

public AzureMLExecutePipelineActivity setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

setLinkedServiceName in class ExecutionActivity

Parameters:

linkedServiceName - the linkedServiceName value to set.

Returns:

the ExecutionActivity object itself.

setPolicy

public AzureMLExecutePipelineActivity setPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Overrides:

setPolicy in class ExecutionActivity

Parameters:

policy - the policy value to set.

Returns:

the ExecutionActivity object itself.

setName

public AzureMLExecutePipelineActivity setName(String name)

Set the name property: Activity name.

Overrides:

setName in class ExecutionActivity

Parameters:

name - the name value to set.

Returns:

the Activity object itself.

setDescription

public AzureMLExecutePipelineActivity setDescription(String description)

Set the description property: Activity description.

Overrides:

setDescription in class ExecutionActivity

Parameters:

description - the description value to set.

Returns:

the Activity object itself.

setDependsOn

public AzureMLExecutePipelineActivity setDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

setDependsOn in class ExecutionActivity

Parameters:

dependsOn - the dependsOn value to set.

Returns:

the Activity object itself.

setUserProperties

public AzureMLExecutePipelineActivity setUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

setUserProperties in class ExecutionActivity

Parameters:

userProperties - the userProperties value to set.

Returns:

the Activity object itself.