WaitActivity Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

public class WaitActivity
extends ControlActivity

This activity suspends pipeline execution for the specified interval.

Constructor Summary

Constructor Description
WaitActivity()

Creates an instance of WaitActivity class.

Method Summary

Modifier and Type Method and Description
static WaitActivity fromJson(JsonReader jsonReader)

Reads an instance of WaitActivity from the JsonReader.
String getType()

Get the type property: Type of activity.
Object getWaitTimeInSeconds()

Get the waitTimeInSeconds property: Duration in seconds.
WaitActivity setDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.
WaitActivity setDescription(String description)

Set the description property: Activity description.
WaitActivity setName(String name)

Set the name property: Activity name.
WaitActivity setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.
WaitActivity setState(ActivityState state)

Set the state property: Activity state.
WaitActivity setUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.
WaitActivity setWaitTimeInSeconds(Object waitTimeInSeconds)

Set the waitTimeInSeconds property: Duration in seconds.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from Activity

getAdditionalProperties getDependsOn getDescription getName getOnInactiveMarkAs getState getUserProperties setAdditionalProperties

Methods inherited from ControlActivity

fromJson getType setDependsOn setDescription setName setOnInactiveMarkAs setState setUserProperties toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

WaitActivity

public WaitActivity()

Creates an instance of WaitActivity class.

Method Details

fromJson

public static WaitActivity fromJson(JsonReader jsonReader)

Reads an instance of WaitActivity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of WaitActivity if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getType

public String getType()

Get the type property: Type of activity.

Overrides:

WaitActivity.getType()

Returns:

the type value.

getWaitTimeInSeconds

public Object getWaitTimeInSeconds()

Get the waitTimeInSeconds property: Duration in seconds.

Returns:

the waitTimeInSeconds value.

setDependsOn

public WaitActivity setDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

WaitActivity.setDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

setDescription

public WaitActivity setDescription(String description)

Set the description property: Activity description.

Overrides:

WaitActivity.setDescription(String description)

Parameters:

description

setName

public WaitActivity setName(String name)

Set the name property: Activity name.

Overrides:

WaitActivity.setName(String name)

Parameters:

name

setOnInactiveMarkAs

public WaitActivity 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:

WaitActivity.setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

setState

public WaitActivity 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:

WaitActivity.setState(ActivityState state)

Parameters:

state

setUserProperties

public WaitActivity setUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

WaitActivity.setUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

setWaitTimeInSeconds

public WaitActivity setWaitTimeInSeconds(Object waitTimeInSeconds)

Set the waitTimeInSeconds property: Duration in seconds.

Parameters:

waitTimeInSeconds - the waitTimeInSeconds value to set.

Returns:

the WaitActivity object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

WaitActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to