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

Class FailActivity

java.lang.Object
com.azure.analytics.synapse.artifacts.models.Activity
com.azure.analytics.synapse.artifacts.models.ControlActivity
com.azure.analytics.synapse.artifacts.models.FailActivity
public class FailActivity extends ControlActivity
This activity will fail within its own scope and output a custom error message and error code. The error message and code can provided either as a string literal or as an expression that can be evaluated to a string at runtime. The activity scope can be the whole pipeline or a control activity (e.g. foreach, switch, until), if the fail activity is contained in it.

  • Constructor Details

    • FailActivity

      public FailActivity()
      Creates an instance of FailActivity class.

  • Method Details

    • getMessage

      public Object getMessage()
      Get the message property: The error message that surfaced in the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).
      Returns:
      the message value.

    • setMessage

      public FailActivity setMessage(Object message)
      Set the message property: The error message that surfaced in the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).
      Parameters:
      message - the message value to set.
      Returns:
      the FailActivity object itself.

    • getErrorCode

      public Object getErrorCode()
      Get the errorCode property: The error code that categorizes the error type of the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).
      Returns:
      the errorCode value.

    • setErrorCode

      public FailActivity setErrorCode(Object errorCode)
      Set the errorCode property: The error code that categorizes the error type of the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).
      Parameters:
      errorCode - the errorCode value to set.
      Returns:
      the FailActivity object itself.

    • setName

      public FailActivity 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 FailActivity 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 FailActivity 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 FailActivity 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.