UntilActivity Class
- java.
lang. Object - com.
azure. resourcemanager. datafactory. models. Activity - com.
azure. resourcemanager. datafactory. models. ControlActivity - com.
azure. resourcemanager. datafactory. models. UntilActivity
- com.
- com.
- com.
public final 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 |
|---|---|
| List<Activity> |
activities()
Get the activities property: List of activities to execute. |
| Expression |
expression()
Get the expression property: An expression that would evaluate to Boolean. |
|
static
Until |
fromJson(JsonReader jsonReader)
Reads an instance of Until |
| Object |
timeout()
Get the timeout property: Specifies the timeout for the activity to run. |
|
Json |
toJson(JsonWriter jsonWriter) |
| String |
type()
Get the type property: Type of activity. |
| void |
validate()
Validates the instance. |
|
Until |
withActivities(List<Activity> activities)
Set the activities property: List of activities to execute. |
|
Until |
withDependsOn(List<ActivityDependency> dependsOn)
Set the depends |
|
Until |
withDescription(String description)
Set the description property: Activity description. |
|
Until |
withExpression(Expression expression)
Set the expression property: An expression that would evaluate to Boolean. |
|
Until |
withName(String name)
Set the name property: Activity name. |
|
Until |
withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)
Set the on |
|
Until |
withState(ActivityState state)
Set the state property: Activity state. |
|
Until |
withTimeout(Object timeout)
Set the timeout property: Specifies the timeout for the activity to run. |
|
Until |
withUserProperties(List<UserProperty> userProperties)
Set the user |
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
activities
public List<Activity> activities()
Get the activities property: List of activities to execute.
Returns:
expression
public Expression expression()
Get the expression property: An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true.
Returns:
fromJson
public static UntilActivity fromJson(JsonReader jsonReader)
Reads an instance of UntilActivity from the JsonReader.
Parameters:
Returns:
Throws:
timeout
public Object timeout()
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])).
Returns:
toJson
public JsonWriter toJson(JsonWriter jsonWriter)
Overrides:
UntilActivity.toJson(JsonWriter jsonWriter)Parameters:
Throws:
type
public String type()
Get the type property: Type of activity.
Overrides:
UntilActivity.type()Returns:
validate
public void validate()
Validates the instance.
Overrides:
UntilActivity.validate()withActivities
public UntilActivity withActivities(List<Activity> activities)
Set the activities property: List of activities to execute.
Parameters:
Returns:
withDependsOn
public UntilActivity withDependsOn(List<ActivityDependency> dependsOn)
Set the dependsOn property: Activity depends on condition.
Overrides:
UntilActivity.withDependsOn(List<ActivityDependency> dependsOn)Parameters:
withDescription
public UntilActivity withDescription(String description)
Set the description property: Activity description.
Overrides:
UntilActivity.withDescription(String description)Parameters:
withExpression
public UntilActivity withExpression(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:
withName
public UntilActivity withName(String name)
Set the name property: Activity name.
Overrides:
UntilActivity.withName(String name)Parameters:
withOnInactiveMarkAs
public UntilActivity withOnInactiveMarkAs(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.withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)Parameters:
withState
public UntilActivity withState(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.withState(ActivityState state)Parameters:
withTimeout
public UntilActivity withTimeout(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])).
Parameters:
Returns:
withUserProperties
public UntilActivity withUserProperties(List<UserProperty> userProperties)
Set the userProperties property: Activity user properties.
Overrides:
UntilActivity.withUserProperties(List<UserProperty> userProperties)Parameters:
