WaitActivity Class

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

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Type of activity.

void validate()

Validates the instance.

Object waitTimeInSeconds()

Get the waitTimeInSeconds property: Duration in seconds.

WaitActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

WaitActivity withDescription(String description)

Set the description property: Activity description.

WaitActivity withName(String name)

Set the name property: Activity name.

WaitActivity withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.

WaitActivity withState(ActivityState state)

Set the state property: Activity state.

WaitActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

WaitActivity withWaitTimeInSeconds(Object waitTimeInSeconds)

Set the waitTimeInSeconds property: Duration in seconds.

Methods inherited from Activity

Methods inherited from ControlActivity

Methods inherited from java.lang.Object

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

WaitActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Type of activity.

Overrides:

WaitActivity.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

WaitActivity.validate()

waitTimeInSeconds

public Object waitTimeInSeconds()

Get the waitTimeInSeconds property: Duration in seconds. Type: integer (or Expression with resultType integer).

Returns:

the waitTimeInSeconds value.

withDependsOn

public WaitActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

WaitActivity.withDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

withDescription

public WaitActivity withDescription(String description)

Set the description property: Activity description.

Overrides:

WaitActivity.withDescription(String description)

Parameters:

description

withName

public WaitActivity withName(String name)

Set the name property: Activity name.

Overrides:

WaitActivity.withName(String name)

Parameters:

name

withOnInactiveMarkAs

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

WaitActivity.withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

withState

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

WaitActivity.withState(ActivityState state)

Parameters:

state

withUserProperties

public WaitActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

WaitActivity.withUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

withWaitTimeInSeconds

public WaitActivity withWaitTimeInSeconds(Object waitTimeInSeconds)

Set the waitTimeInSeconds property: Duration in seconds. Type: integer (or Expression with resultType integer).

Parameters:

waitTimeInSeconds - the waitTimeInSeconds value to set.

Returns:

the WaitActivity object itself.

Applies to