Class AzureMLExecutePipelineActivity


public final class AzureMLExecutePipelineActivity extends ExecutionActivity
Azure ML Execute Pipeline activity.
  • Constructor Details

    • AzureMLExecutePipelineActivity

      public AzureMLExecutePipelineActivity()
  • Method Details

    • withLinkedServiceName

      public AzureMLExecutePipelineActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)
      Set the linkedServiceName property: Linked service reference.
      Overrides:
      withLinkedServiceName in class ExecutionActivity
      Parameters:
      linkedServiceName - the linkedServiceName value to set.
      Returns:
      the ExecutionActivity object itself.
    • withPolicy

      public AzureMLExecutePipelineActivity withPolicy(ActivityPolicy policy)
      Set the policy property: Activity policy.
      Overrides:
      withPolicy in class ExecutionActivity
      Parameters:
      policy - the policy value to set.
      Returns:
      the ExecutionActivity object itself.
    • withName

      public AzureMLExecutePipelineActivity withName(String name)
      Set the name property: Activity name.
      Overrides:
      withName in class ExecutionActivity
      Parameters:
      name - the name value to set.
      Returns:
      the Activity object itself.
    • withDescription

      public AzureMLExecutePipelineActivity withDescription(String description)
      Set the description property: Activity description.
      Overrides:
      withDescription in class ExecutionActivity
      Parameters:
      description - the description value to set.
      Returns:
      the Activity object itself.
    • withDependsOn

      public AzureMLExecutePipelineActivity withDependsOn(List<ActivityDependency> dependsOn)
      Set the dependsOn property: Activity depends on condition.
      Overrides:
      withDependsOn in class ExecutionActivity
      Parameters:
      dependsOn - the dependsOn value to set.
      Returns:
      the Activity object itself.
    • withUserProperties

      public AzureMLExecutePipelineActivity withUserProperties(List<UserProperty> userProperties)
      Set the userProperties property: Activity user properties.
      Overrides:
      withUserProperties in class ExecutionActivity
      Parameters:
      userProperties - the userProperties value to set.
      Returns:
      the Activity object itself.
    • mlPipelineId

      public Object mlPipelineId()
      Get the mlPipelineId property: ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).
      Returns:
      the mlPipelineId value.
    • withMlPipelineId

      public AzureMLExecutePipelineActivity withMlPipelineId(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.
    • mlPipelineEndpointId

      public Object mlPipelineEndpointId()
      Get the mlPipelineEndpointId property: ID of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).
      Returns:
      the mlPipelineEndpointId value.
    • withMlPipelineEndpointId

      public AzureMLExecutePipelineActivity withMlPipelineEndpointId(Object mlPipelineEndpointId)
      Set the mlPipelineEndpointId property: ID of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).
      Parameters:
      mlPipelineEndpointId - the mlPipelineEndpointId value to set.
      Returns:
      the AzureMLExecutePipelineActivity object itself.
    • version

      public Object version()
      Get the version property: Version of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).
      Returns:
      the version value.
    • withVersion

      public AzureMLExecutePipelineActivity withVersion(Object version)
      Set the version property: Version of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).
      Parameters:
      version - the version value to set.
      Returns:
      the AzureMLExecutePipelineActivity object itself.
    • experimentName

      public Object experimentName()
      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.
    • withExperimentName

      public AzureMLExecutePipelineActivity withExperimentName(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.
    • mlPipelineParameters

      public Object mlPipelineParameters()
      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.
    • withMlPipelineParameters

      public AzureMLExecutePipelineActivity withMlPipelineParameters(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.
    • dataPathAssignments

      public Object dataPathAssignments()
      Get the dataPathAssignments property: Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).
      Returns:
      the dataPathAssignments value.
    • withDataPathAssignments

      public AzureMLExecutePipelineActivity withDataPathAssignments(Object dataPathAssignments)
      Set the dataPathAssignments property: Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).
      Parameters:
      dataPathAssignments - the dataPathAssignments value to set.
      Returns:
      the AzureMLExecutePipelineActivity object itself.
    • mlParentRunId

      public Object mlParentRunId()
      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.
    • withMlParentRunId

      public AzureMLExecutePipelineActivity withMlParentRunId(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.
    • continueOnStepFailure

      public Object continueOnStepFailure()
      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.
    • withContinueOnStepFailure

      public AzureMLExecutePipelineActivity withContinueOnStepFailure(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.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ExecutionActivity
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.