ValidationActivity Class

public final class ValidationActivity
extends ControlActivity

This activity verifies that an external resource exists.

Constructor Summary

Constructor Description
ValidationActivity()

Creates an instance of ValidationActivity class.

Method Summary

Modifier and Type Method and Description
Object childItems()

Get the childItems property: Can be used if dataset points to a folder.

DatasetReference dataset()

Get the dataset property: Validation activity dataset reference.

static ValidationActivity fromJson(JsonReader jsonReader)

Reads an instance of ValidationActivity from the JsonReader.

Object minimumSize()

Get the minimumSize property: Can be used if dataset points to a file.

Object sleep()

Get the sleep property: A delay in seconds between validation attempts.

Object timeout()

Get the timeout property: Specifies the timeout for the activity to run.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Type of activity.

void validate()

Validates the instance.

ValidationActivity withChildItems(Object childItems)

Set the childItems property: Can be used if dataset points to a folder.

ValidationActivity withDataset(DatasetReference dataset)

Set the dataset property: Validation activity dataset reference.

ValidationActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

ValidationActivity withDescription(String description)

Set the description property: Activity description.

ValidationActivity withMinimumSize(Object minimumSize)

Set the minimumSize property: Can be used if dataset points to a file.

ValidationActivity withName(String name)

Set the name property: Activity name.

ValidationActivity withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

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

ValidationActivity withSleep(Object sleep)

Set the sleep property: A delay in seconds between validation attempts.

ValidationActivity withState(ActivityState state)

Set the state property: Activity state.

ValidationActivity withTimeout(Object timeout)

Set the timeout property: Specifies the timeout for the activity to run.

ValidationActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Methods inherited from Activity

Methods inherited from ControlActivity

Methods inherited from java.lang.Object

Constructor Details

ValidationActivity

public ValidationActivity()

Creates an instance of ValidationActivity class.

Method Details

childItems

public Object childItems()

Get the childItems property: Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean).

Returns:

the childItems value.

dataset

public DatasetReference dataset()

Get the dataset property: Validation activity dataset reference.

Returns:

the dataset value.

fromJson

public static ValidationActivity fromJson(JsonReader jsonReader)

Reads an instance of ValidationActivity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ValidationActivity 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.

minimumSize

public Object minimumSize()

Get the minimumSize property: Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer).

Returns:

the minimumSize value.

sleep

public Object sleep()

Get the sleep property: A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer).

Returns:

the sleep value.

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:

the timeout value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ValidationActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Type of activity.

Overrides:

ValidationActivity.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

ValidationActivity.validate()

withChildItems

public ValidationActivity withChildItems(Object childItems)

Set the childItems property: Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean).

Parameters:

childItems - the childItems value to set.

Returns:

the ValidationActivity object itself.

withDataset

public ValidationActivity withDataset(DatasetReference dataset)

Set the dataset property: Validation activity dataset reference.

Parameters:

dataset - the dataset value to set.

Returns:

the ValidationActivity object itself.

withDependsOn

public ValidationActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

ValidationActivity.withDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

withDescription

public ValidationActivity withDescription(String description)

Set the description property: Activity description.

Overrides:

ValidationActivity.withDescription(String description)

Parameters:

description

withMinimumSize

public ValidationActivity withMinimumSize(Object minimumSize)

Set the minimumSize property: Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer).

Parameters:

minimumSize - the minimumSize value to set.

Returns:

the ValidationActivity object itself.

withName

public ValidationActivity withName(String name)

Set the name property: Activity name.

Overrides:

ValidationActivity.withName(String name)

Parameters:

name

withOnInactiveMarkAs

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

ValidationActivity.withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

withSleep

public ValidationActivity withSleep(Object sleep)

Set the sleep property: A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer).

Parameters:

sleep - the sleep value to set.

Returns:

the ValidationActivity object itself.

withState

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

ValidationActivity.withState(ActivityState state)

Parameters:

state

withTimeout

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

timeout - the timeout value to set.

Returns:

the ValidationActivity object itself.

withUserProperties

public ValidationActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

ValidationActivity.withUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

Applies to