UntilActivity Class
- java.
lang. Object - com.
azure. analytics. synapse. artifacts. models. Activity - com.
azure. analytics. synapse. artifacts. models. ControlActivity - com.
azure. analytics. synapse. artifacts. models. UntilActivity
- com.
- com.
- com.
public class UntilActivity
extends ControlActivity
This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.
Constructor Summary
| Constructor | Description |
|---|---|
| UntilActivity() |
Creates an instance of Until |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
static
Until |
fromJson(JsonReader jsonReader)
Reads an instance of Until |
| List<Activity> |
getActivities()
Get the activities property: List of activities to execute. |
| Expression |
getExpression()
Get the expression property: An expression that would evaluate to Boolean. |
| Object |
getTimeout()
Get the timeout property: Specifies the timeout for the activity to run. |
| String |
getType()
Get the type property: Type of activity. |
|
Until |
setActivities(List<Activity> activities)
Set the activities property: List of activities to execute. |
|
Until |
setDependsOn(List<ActivityDependency> dependsOn)
Set the depends |
|
Until |
setDescription(String description)
Set the description property: Activity description. |
|
Until |
setExpression(Expression expression)
Set the expression property: An expression that would evaluate to Boolean. |
|
Until |
setName(String name)
Set the name property: Activity name. |
|
Until |
setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)
Set the on |
|
Until |
setState(ActivityState state)
Set the state property: Activity state. |
|
Until |
setTimeout(Object timeout)
Set the timeout property: Specifies the timeout for the activity to run. |
|
Until |
setUserProperties(List<UserProperty> userProperties)
Set the user |
|
Json |
toJson(JsonWriter jsonWriter) |
Methods inherited from Activity
Methods inherited from ControlActivity
Methods inherited from java.lang.Object
Constructor Details
UntilActivity
public UntilActivity()
Creates an instance of UntilActivity class.
Method Details
fromJson
public static UntilActivity fromJson(JsonReader jsonReader)
Reads an instance of UntilActivity from the JsonReader.
Parameters:
Returns:
Throws:
getActivities
public List<Activity> getActivities()
Get the activities property: List of activities to execute.
Returns:
getExpression
public Expression getExpression()
Get the expression property: An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true.
Returns:
getTimeout
public Object getTimeout()
Get the timeout property: Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
Returns:
getType
public String getType()
Get the type property: Type of activity.
Overrides:
UntilActivity.getType()Returns:
setActivities
public UntilActivity setActivities(List<Activity> activities)
Set the activities property: List of activities to execute.
Parameters:
Returns:
setDependsOn
public UntilActivity setDependsOn(List<ActivityDependency> dependsOn)
Set the dependsOn property: Activity depends on condition.
Overrides:
UntilActivity.setDependsOn(List<ActivityDependency> dependsOn)Parameters:
setDescription
public UntilActivity setDescription(String description)
Set the description property: Activity description.
Overrides:
UntilActivity.setDescription(String description)Parameters:
setExpression
public UntilActivity setExpression(Expression expression)
Set the expression property: An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true.
Parameters:
Returns:
setName
public UntilActivity setName(String name)
Set the name property: Activity name.
Overrides:
UntilActivity.setName(String name)Parameters:
setOnInactiveMarkAs
public UntilActivity setOnInactiveMarkAs(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:
UntilActivity.setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)Parameters:
setState
public UntilActivity setState(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:
UntilActivity.setState(ActivityState state)Parameters:
setTimeout
public UntilActivity setTimeout(Object timeout)
Set the timeout property: Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
Parameters:
Returns:
setUserProperties
public UntilActivity setUserProperties(List<UserProperty> userProperties)
Set the userProperties property: Activity user properties.
Overrides:
UntilActivity.setUserProperties(List<UserProperty> userProperties)Parameters:
toJson
public JsonWriter toJson(JsonWriter jsonWriter)
Overrides:
UntilActivity.toJson(JsonWriter jsonWriter)Parameters:
Throws:
