ExecuteDataFlowActivity Class

public final class ExecuteDataFlowActivity
extends ExecutionActivity

Execute data flow activity.

Constructor Summary

Constructor Description
ExecuteDataFlowActivity()

Creates an instance of ExecuteDataFlowActivity class.

Method Summary

Modifier and Type Method and Description
ExecuteDataFlowActivityTypePropertiesCompute compute()

Get the compute property: Compute properties for data flow activity.

ContinuationSettingsReference continuationSettings()

Get the continuationSettings property: Continuation settings for execute data flow activity.

Object continueOnError()

Get the continueOnError property: Continue on error setting used for data flow execution.

DataFlowReference dataFlow()

Get the dataFlow property: Data flow reference.

static ExecuteDataFlowActivity fromJson(JsonReader jsonReader)

Reads an instance of ExecuteDataFlowActivity from the JsonReader.

IntegrationRuntimeReference integrationRuntime()

Get the integrationRuntime property: The integration runtime reference.

Object runConcurrently()

Get the runConcurrently property: Concurrent run setting used for data flow execution.

Object sourceStagingConcurrency()

Get the sourceStagingConcurrency property: Specify number of parallel staging for sources applicable to the sink.

DataFlowStagingInfo staging()

Get the staging property: Staging info for execute data flow activity.

JsonWriter toJson(JsonWriter jsonWriter)
Object traceLevel()

Get the traceLevel property: Trace level setting used for data flow monitoring output.

String type()

Get the type property: Type of activity.

void validate()

Validates the instance.

ExecuteDataFlowActivity withCompute(ExecuteDataFlowActivityTypePropertiesCompute compute)

Set the compute property: Compute properties for data flow activity.

ExecuteDataFlowActivity withContinuationSettings(ContinuationSettingsReference continuationSettings)

Set the continuationSettings property: Continuation settings for execute data flow activity.

ExecuteDataFlowActivity withContinueOnError(Object continueOnError)

Set the continueOnError property: Continue on error setting used for data flow execution.

ExecuteDataFlowActivity withDataFlow(DataFlowReference dataFlow)

Set the dataFlow property: Data flow reference.

ExecuteDataFlowActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

ExecuteDataFlowActivity withDescription(String description)

Set the description property: Activity description.

ExecuteDataFlowActivity withIntegrationRuntime(IntegrationRuntimeReference integrationRuntime)

Set the integrationRuntime property: The integration runtime reference.

ExecuteDataFlowActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

ExecuteDataFlowActivity withName(String name)

Set the name property: Activity name.

ExecuteDataFlowActivity withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

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

ExecuteDataFlowActivity withPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

ExecuteDataFlowActivity withRunConcurrently(Object runConcurrently)

Set the runConcurrently property: Concurrent run setting used for data flow execution.

ExecuteDataFlowActivity withSourceStagingConcurrency(Object sourceStagingConcurrency)

Set the sourceStagingConcurrency property: Specify number of parallel staging for sources applicable to the sink.

ExecuteDataFlowActivity withStaging(DataFlowStagingInfo staging)

Set the staging property: Staging info for execute data flow activity.

ExecuteDataFlowActivity withState(ActivityState state)

Set the state property: Activity state.

ExecuteDataFlowActivity withTraceLevel(Object traceLevel)

Set the traceLevel property: Trace level setting used for data flow monitoring output.

ExecuteDataFlowActivity 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

ExecuteDataFlowActivity

public ExecuteDataFlowActivity()

Creates an instance of ExecuteDataFlowActivity class.

Method Details

compute

public ExecuteDataFlowActivityTypePropertiesCompute compute()

Get the compute property: Compute properties for data flow activity.

Returns:

the compute value.

continuationSettings

public ContinuationSettingsReference continuationSettings()

Get the continuationSettings property: Continuation settings for execute data flow activity.

Returns:

the continuationSettings value.

continueOnError

public Object continueOnError()

Get the continueOnError property: Continue on error setting used for data flow execution. Enables processing to continue if a sink fails. Type: boolean (or Expression with resultType boolean).

Returns:

the continueOnError value.

dataFlow

public DataFlowReference dataFlow()

Get the dataFlow property: Data flow reference.

Returns:

the dataFlow value.

fromJson

public static ExecuteDataFlowActivity fromJson(JsonReader jsonReader)

Reads an instance of ExecuteDataFlowActivity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

integrationRuntime

public IntegrationRuntimeReference integrationRuntime()

Get the integrationRuntime property: The integration runtime reference.

Returns:

the integrationRuntime value.

runConcurrently

public Object runConcurrently()

Get the runConcurrently property: Concurrent run setting used for data flow execution. Allows sinks with the same save order to be processed concurrently. Type: boolean (or Expression with resultType boolean).

Returns:

the runConcurrently value.

sourceStagingConcurrency

public Object sourceStagingConcurrency()

Get the sourceStagingConcurrency property: Specify number of parallel staging for sources applicable to the sink. Type: integer (or Expression with resultType integer).

Returns:

the sourceStagingConcurrency value.

staging

public DataFlowStagingInfo staging()

Get the staging property: Staging info for execute data flow activity.

Returns:

the staging value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ExecuteDataFlowActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

traceLevel

public Object traceLevel()

Get the traceLevel property: Trace level setting used for data flow monitoring output. Supported values are: 'coarse', 'fine', and 'none'. Type: string (or Expression with resultType string).

Returns:

the traceLevel value.

type

public String type()

Get the type property: Type of activity.

Overrides:

ExecuteDataFlowActivity.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

ExecuteDataFlowActivity.validate()

withCompute

public ExecuteDataFlowActivity withCompute(ExecuteDataFlowActivityTypePropertiesCompute compute)

Set the compute property: Compute properties for data flow activity.

Parameters:

compute - the compute value to set.

Returns:

the ExecuteDataFlowActivity object itself.

withContinuationSettings

public ExecuteDataFlowActivity withContinuationSettings(ContinuationSettingsReference continuationSettings)

Set the continuationSettings property: Continuation settings for execute data flow activity.

Parameters:

continuationSettings - the continuationSettings value to set.

Returns:

the ExecuteDataFlowActivity object itself.

withContinueOnError

public ExecuteDataFlowActivity withContinueOnError(Object continueOnError)

Set the continueOnError property: Continue on error setting used for data flow execution. Enables processing to continue if a sink fails. Type: boolean (or Expression with resultType boolean).

Parameters:

continueOnError - the continueOnError value to set.

Returns:

the ExecuteDataFlowActivity object itself.

withDataFlow

public ExecuteDataFlowActivity withDataFlow(DataFlowReference dataFlow)

Set the dataFlow property: Data flow reference.

Parameters:

dataFlow - the dataFlow value to set.

Returns:

the ExecuteDataFlowActivity object itself.

withDependsOn

public ExecuteDataFlowActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

ExecuteDataFlowActivity.withDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

withDescription

public ExecuteDataFlowActivity withDescription(String description)

Set the description property: Activity description.

Overrides:

ExecuteDataFlowActivity.withDescription(String description)

Parameters:

description

withIntegrationRuntime

public ExecuteDataFlowActivity withIntegrationRuntime(IntegrationRuntimeReference integrationRuntime)

Set the integrationRuntime property: The integration runtime reference.

Parameters:

integrationRuntime - the integrationRuntime value to set.

Returns:

the ExecuteDataFlowActivity object itself.

withLinkedServiceName

public ExecuteDataFlowActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

ExecuteDataFlowActivity.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withName

public ExecuteDataFlowActivity withName(String name)

Set the name property: Activity name.

Overrides:

ExecuteDataFlowActivity.withName(String name)

Parameters:

name

withOnInactiveMarkAs

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

ExecuteDataFlowActivity.withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

withPolicy

public ExecuteDataFlowActivity withPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Overrides:

ExecuteDataFlowActivity.withPolicy(ActivityPolicy policy)

Parameters:

policy

withRunConcurrently

public ExecuteDataFlowActivity withRunConcurrently(Object runConcurrently)

Set the runConcurrently property: Concurrent run setting used for data flow execution. Allows sinks with the same save order to be processed concurrently. Type: boolean (or Expression with resultType boolean).

Parameters:

runConcurrently - the runConcurrently value to set.

Returns:

the ExecuteDataFlowActivity object itself.

withSourceStagingConcurrency

public ExecuteDataFlowActivity withSourceStagingConcurrency(Object sourceStagingConcurrency)

Set the sourceStagingConcurrency property: Specify number of parallel staging for sources applicable to the sink. Type: integer (or Expression with resultType integer).

Parameters:

sourceStagingConcurrency - the sourceStagingConcurrency value to set.

Returns:

the ExecuteDataFlowActivity object itself.

withStaging

public ExecuteDataFlowActivity withStaging(DataFlowStagingInfo staging)

Set the staging property: Staging info for execute data flow activity.

Parameters:

staging - the staging value to set.

Returns:

the ExecuteDataFlowActivity object itself.

withState

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

ExecuteDataFlowActivity.withState(ActivityState state)

Parameters:

state

withTraceLevel

public ExecuteDataFlowActivity withTraceLevel(Object traceLevel)

Set the traceLevel property: Trace level setting used for data flow monitoring output. Supported values are: 'coarse', 'fine', and 'none'. Type: string (or Expression with resultType string).

Parameters:

traceLevel - the traceLevel value to set.

Returns:

the ExecuteDataFlowActivity object itself.

withUserProperties

public ExecuteDataFlowActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

ExecuteDataFlowActivity.withUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

Applies to