SqlServerStoredProcedureActivity Class

public final class SqlServerStoredProcedureActivity
extends ExecutionActivity

SQL stored procedure activity type.

Constructor Summary

Constructor Description
SqlServerStoredProcedureActivity()

Creates an instance of SqlServerStoredProcedureActivity class.

Method Summary

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

Reads an instance of SqlServerStoredProcedureActivity from the JsonReader.

Object storedProcedureName()

Get the storedProcedureName property: Stored procedure name.

Object storedProcedureParameters()

Get the storedProcedureParameters property: Value and type setting for stored procedure parameters.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Type of activity.

void validate()

Validates the instance.

SqlServerStoredProcedureActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

SqlServerStoredProcedureActivity withDescription(String description)

Set the description property: Activity description.

SqlServerStoredProcedureActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

SqlServerStoredProcedureActivity withName(String name)

Set the name property: Activity name.

SqlServerStoredProcedureActivity withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

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

SqlServerStoredProcedureActivity withPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

SqlServerStoredProcedureActivity withState(ActivityState state)

Set the state property: Activity state.

SqlServerStoredProcedureActivity withStoredProcedureName(Object storedProcedureName)

Set the storedProcedureName property: Stored procedure name.

SqlServerStoredProcedureActivity withStoredProcedureParameters(Object storedProcedureParameters)

Set the storedProcedureParameters property: Value and type setting for stored procedure parameters.

SqlServerStoredProcedureActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Methods inherited from Activity

Methods inherited from ExecutionActivity

Methods inherited from java.lang.Object

Constructor Details

SqlServerStoredProcedureActivity

public SqlServerStoredProcedureActivity()

Creates an instance of SqlServerStoredProcedureActivity class.

Method Details

fromJson

public static SqlServerStoredProcedureActivity fromJson(JsonReader jsonReader)

Reads an instance of SqlServerStoredProcedureActivity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

storedProcedureName

public Object storedProcedureName()

Get the storedProcedureName property: Stored procedure name. Type: string (or Expression with resultType string).

Returns:

the storedProcedureName value.

storedProcedureParameters

public Object storedProcedureParameters()

Get the storedProcedureParameters property: Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".

Returns:

the storedProcedureParameters value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SqlServerStoredProcedureActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Type of activity.

Overrides:

SqlServerStoredProcedureActivity.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

SqlServerStoredProcedureActivity.validate()

withDependsOn

public SqlServerStoredProcedureActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

SqlServerStoredProcedureActivity.withDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

withDescription

public SqlServerStoredProcedureActivity withDescription(String description)

Set the description property: Activity description.

Overrides:

SqlServerStoredProcedureActivity.withDescription(String description)

Parameters:

description

withLinkedServiceName

public SqlServerStoredProcedureActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

SqlServerStoredProcedureActivity.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withName

public SqlServerStoredProcedureActivity withName(String name)

Set the name property: Activity name.

Overrides:

SqlServerStoredProcedureActivity.withName(String name)

Parameters:

name

withOnInactiveMarkAs

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

SqlServerStoredProcedureActivity.withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

withPolicy

public SqlServerStoredProcedureActivity withPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Overrides:

SqlServerStoredProcedureActivity.withPolicy(ActivityPolicy policy)

Parameters:

policy

withState

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

SqlServerStoredProcedureActivity.withState(ActivityState state)

Parameters:

state

withStoredProcedureName

public SqlServerStoredProcedureActivity withStoredProcedureName(Object storedProcedureName)

Set the storedProcedureName property: Stored procedure name. Type: string (or Expression with resultType string).

Parameters:

storedProcedureName - the storedProcedureName value to set.

Returns:

the SqlServerStoredProcedureActivity object itself.

withStoredProcedureParameters

public SqlServerStoredProcedureActivity withStoredProcedureParameters(Object storedProcedureParameters)

Set the storedProcedureParameters property: Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".

Parameters:

storedProcedureParameters - the storedProcedureParameters value to set.

Returns:

the SqlServerStoredProcedureActivity object itself.

withUserProperties

public SqlServerStoredProcedureActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

SqlServerStoredProcedureActivity.withUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

Applies to