CopyActivity Class

Package:
com.azure.resourcemanager.datafactory.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-datafactory:1.2.0

public final class CopyActivity
extends ExecutionActivity

Copy activity.

Constructor Summary

Constructor Description
CopyActivity()

Creates an instance of CopyActivity class.

Method Summary

Modifier and Type Method and Description
Object dataIntegrationUnits()

Get the dataIntegrationUnits property: Maximum number of data integration units that can be used to perform this data movement.
Object enableSkipIncompatibleRow()

Get the enableSkipIncompatibleRow property: Whether to skip incompatible row.
Object enableStaging()

Get the enableStaging property: Specifies whether to copy data via an interim staging.
static CopyActivity fromJson(JsonReader jsonReader)

Reads an instance of CopyActivity from the JsonReader.
List<DatasetReference> inputs()

Get the inputs property: List of inputs for the activity.
LogSettings logSettings()

Get the logSettings property: Log settings customer needs provide when enabling log.
LogStorageSettings logStorageSettings()

Get the logStorageSettings property: (Deprecated.
List<DatasetReference> outputs()

Get the outputs property: List of outputs for the activity.
Object parallelCopies()

Get the parallelCopies property: Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store.
List<Object> preserve()

Get the preserve property: Preserve rules.
List<Object> preserveRules()

Get the preserveRules property: Preserve Rules.
RedirectIncompatibleRowSettings redirectIncompatibleRowSettings()

Get the redirectIncompatibleRowSettings property: Redirect incompatible row settings when EnableSkipIncompatibleRow is true.
CopySink sink()

Get the sink property: Copy activity sink.
SkipErrorFile skipErrorFile()

Get the skipErrorFile property: Specify the fault tolerance for data consistency.
CopySource source()

Get the source property: Copy activity source.
StagingSettings stagingSettings()

Get the stagingSettings property: Specifies interim staging settings when EnableStaging is true.
JsonWriter toJson(JsonWriter jsonWriter)
Object translator()

Get the translator property: Copy activity translator.
String type()

Get the type property: Type of activity.
void validate()

Validates the instance.
Object validateDataConsistency()

Get the validateDataConsistency property: Whether to enable Data Consistency validation.
CopyActivity withDataIntegrationUnits(Object dataIntegrationUnits)

Set the dataIntegrationUnits property: Maximum number of data integration units that can be used to perform this data movement.
CopyActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.
CopyActivity withDescription(String description)

Set the description property: Activity description.
CopyActivity withEnableSkipIncompatibleRow(Object enableSkipIncompatibleRow)

Set the enableSkipIncompatibleRow property: Whether to skip incompatible row.
CopyActivity withEnableStaging(Object enableStaging)

Set the enableStaging property: Specifies whether to copy data via an interim staging.
CopyActivity withInputs(List<DatasetReference> inputs)

Set the inputs property: List of inputs for the activity.
CopyActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.
CopyActivity withLogSettings(LogSettings logSettings)

Set the logSettings property: Log settings customer needs provide when enabling log.
CopyActivity withLogStorageSettings(LogStorageSettings logStorageSettings)

Set the logStorageSettings property: (Deprecated.
CopyActivity withName(String name)

Set the name property: Activity name.
CopyActivity withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.
CopyActivity withOutputs(List<DatasetReference> outputs)

Set the outputs property: List of outputs for the activity.
CopyActivity withParallelCopies(Object parallelCopies)

Set the parallelCopies property: Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store.
CopyActivity withPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.
CopyActivity withPreserve(List<Object> preserve)

Set the preserve property: Preserve rules.
CopyActivity withPreserveRules(List<Object> preserveRules)

Set the preserveRules property: Preserve Rules.
CopyActivity withRedirectIncompatibleRowSettings(RedirectIncompatibleRowSettings redirectIncompatibleRowSettings)

Set the redirectIncompatibleRowSettings property: Redirect incompatible row settings when EnableSkipIncompatibleRow is true.
CopyActivity withSink(CopySink sink)

Set the sink property: Copy activity sink.
CopyActivity withSkipErrorFile(SkipErrorFile skipErrorFile)

Set the skipErrorFile property: Specify the fault tolerance for data consistency.
CopyActivity withSource(CopySource source)

Set the source property: Copy activity source.
CopyActivity withStagingSettings(StagingSettings stagingSettings)

Set the stagingSettings property: Specifies interim staging settings when EnableStaging is true.
CopyActivity withState(ActivityState state)

Set the state property: Activity state.
CopyActivity withTranslator(Object translator)

Set the translator property: Copy activity translator.
CopyActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.
CopyActivity withValidateDataConsistency(Object validateDataConsistency)

Set the validateDataConsistency property: Whether to enable Data Consistency validation.

Methods inherited from Activity

additionalProperties dependsOn description name onInactiveMarkAs state userProperties withAdditionalProperties

Methods inherited from ExecutionActivity

fromJson linkedServiceName policy toJson type validate withDependsOn withDescription withLinkedServiceName withName withOnInactiveMarkAs withPolicy withState withUserProperties

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CopyActivity

public CopyActivity()

Creates an instance of CopyActivity class.

Method Details

dataIntegrationUnits

public Object dataIntegrationUnits()

Get the dataIntegrationUnits property: Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.

Returns:

the dataIntegrationUnits value.

enableSkipIncompatibleRow

public Object enableSkipIncompatibleRow()

Get the enableSkipIncompatibleRow property: Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).

Returns:

the enableSkipIncompatibleRow value.

enableStaging

public Object enableStaging()

Get the enableStaging property: Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).

Returns:

the enableStaging value.

fromJson

public static CopyActivity fromJson(JsonReader jsonReader)

Reads an instance of CopyActivity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

inputs

public List<DatasetReference> inputs()

Get the inputs property: List of inputs for the activity.

Returns:

the inputs value.

logSettings

public LogSettings logSettings()

Get the logSettings property: Log settings customer needs provide when enabling log.

Returns:

the logSettings value.

logStorageSettings

public LogStorageSettings logStorageSettings()

Get the logStorageSettings property: (Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log.

Returns:

the logStorageSettings value.

outputs

public List<DatasetReference> outputs()

Get the outputs property: List of outputs for the activity.

Returns:

the outputs value.

parallelCopies

public Object parallelCopies()

Get the parallelCopies property: Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0.

Returns:

the parallelCopies value.

preserve

public List<Object> preserve()

Get the preserve property: Preserve rules.

Returns:

the preserve value.

preserveRules

public List<Object> preserveRules()

Get the preserveRules property: Preserve Rules.

Returns:

the preserveRules value.

redirectIncompatibleRowSettings

public RedirectIncompatibleRowSettings redirectIncompatibleRowSettings()

Get the redirectIncompatibleRowSettings property: Redirect incompatible row settings when EnableSkipIncompatibleRow is true.

Returns:

the redirectIncompatibleRowSettings value.

sink

public CopySink sink()

Get the sink property: Copy activity sink.

Returns:

the sink value.

skipErrorFile

public SkipErrorFile skipErrorFile()

Get the skipErrorFile property: Specify the fault tolerance for data consistency.

Returns:

the skipErrorFile value.

source

public CopySource source()

Get the source property: Copy activity source.

Returns:

the source value.

stagingSettings

public StagingSettings stagingSettings()

Get the stagingSettings property: Specifies interim staging settings when EnableStaging is true.

Returns:

the stagingSettings value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

CopyActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

translator

public Object translator()

Get the translator property: Copy activity translator. If not specified, tabular translator is used.

Returns:

the translator value.

type

public String type()

Get the type property: Type of activity.

Overrides:

CopyActivity.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

CopyActivity.validate()

validateDataConsistency

public Object validateDataConsistency()

Get the validateDataConsistency property: Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean).

Returns:

the validateDataConsistency value.

withDataIntegrationUnits

public CopyActivity withDataIntegrationUnits(Object dataIntegrationUnits)

Set the dataIntegrationUnits property: Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.

Parameters:

dataIntegrationUnits - the dataIntegrationUnits value to set.

Returns:

the CopyActivity object itself.

withDependsOn

public CopyActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

CopyActivity.withDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

withDescription

public CopyActivity withDescription(String description)

Set the description property: Activity description.

Overrides:

CopyActivity.withDescription(String description)

Parameters:

description

withEnableSkipIncompatibleRow

public CopyActivity withEnableSkipIncompatibleRow(Object enableSkipIncompatibleRow)

Set the enableSkipIncompatibleRow property: Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).

Parameters:

enableSkipIncompatibleRow - the enableSkipIncompatibleRow value to set.

Returns:

the CopyActivity object itself.

withEnableStaging

public CopyActivity withEnableStaging(Object enableStaging)

Set the enableStaging property: Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).

Parameters:

enableStaging - the enableStaging value to set.

Returns:

the CopyActivity object itself.

withInputs

public CopyActivity withInputs(List<DatasetReference> inputs)

Set the inputs property: List of inputs for the activity.

Parameters:

inputs - the inputs value to set.

Returns:

the CopyActivity object itself.

withLinkedServiceName

public CopyActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

CopyActivity.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withLogSettings

public CopyActivity withLogSettings(LogSettings logSettings)

Set the logSettings property: Log settings customer needs provide when enabling log.

Parameters:

logSettings - the logSettings value to set.

Returns:

the CopyActivity object itself.

withLogStorageSettings

public CopyActivity withLogStorageSettings(LogStorageSettings logStorageSettings)

Set the logStorageSettings property: (Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log.

Parameters:

logStorageSettings - the logStorageSettings value to set.

Returns:

the CopyActivity object itself.

withName

public CopyActivity withName(String name)

Set the name property: Activity name.

Overrides:

CopyActivity.withName(String name)

Parameters:

name

withOnInactiveMarkAs

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

CopyActivity.withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

withOutputs

public CopyActivity withOutputs(List<DatasetReference> outputs)

Set the outputs property: List of outputs for the activity.

Parameters:

outputs - the outputs value to set.

Returns:

the CopyActivity object itself.

withParallelCopies

public CopyActivity withParallelCopies(Object parallelCopies)

Set the parallelCopies property: Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0.

Parameters:

parallelCopies - the parallelCopies value to set.

Returns:

the CopyActivity object itself.

withPolicy

public CopyActivity withPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Overrides:

CopyActivity.withPolicy(ActivityPolicy policy)

Parameters:

policy

withPreserve

public CopyActivity withPreserve(List<Object> preserve)

Set the preserve property: Preserve rules.

Parameters:

preserve - the preserve value to set.

Returns:

the CopyActivity object itself.

withPreserveRules

public CopyActivity withPreserveRules(List<Object> preserveRules)

Set the preserveRules property: Preserve Rules.

Parameters:

preserveRules - the preserveRules value to set.

Returns:

the CopyActivity object itself.

withRedirectIncompatibleRowSettings

public CopyActivity withRedirectIncompatibleRowSettings(RedirectIncompatibleRowSettings redirectIncompatibleRowSettings)

Set the redirectIncompatibleRowSettings property: Redirect incompatible row settings when EnableSkipIncompatibleRow is true.

Parameters:

redirectIncompatibleRowSettings - the redirectIncompatibleRowSettings value to set.

Returns:

the CopyActivity object itself.

withSink

public CopyActivity withSink(CopySink sink)

Set the sink property: Copy activity sink.

Parameters:

sink - the sink value to set.

Returns:

the CopyActivity object itself.

withSkipErrorFile

public CopyActivity withSkipErrorFile(SkipErrorFile skipErrorFile)

Set the skipErrorFile property: Specify the fault tolerance for data consistency.

Parameters:

skipErrorFile - the skipErrorFile value to set.

Returns:

the CopyActivity object itself.

withSource

public CopyActivity withSource(CopySource source)

Set the source property: Copy activity source.

Parameters:

source - the source value to set.

Returns:

the CopyActivity object itself.

withStagingSettings

public CopyActivity withStagingSettings(StagingSettings stagingSettings)

Set the stagingSettings property: Specifies interim staging settings when EnableStaging is true.

Parameters:

stagingSettings - the stagingSettings value to set.

Returns:

the CopyActivity object itself.

withState

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

CopyActivity.withState(ActivityState state)

Parameters:

state

withTranslator

public CopyActivity withTranslator(Object translator)

Set the translator property: Copy activity translator. If not specified, tabular translator is used.

Parameters:

translator - the translator value to set.

Returns:

the CopyActivity object itself.

withUserProperties

public CopyActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

CopyActivity.withUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

withValidateDataConsistency

public CopyActivity withValidateDataConsistency(Object validateDataConsistency)

Set the validateDataConsistency property: Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean).

Parameters:

validateDataConsistency - the validateDataConsistency value to set.

Returns:

the CopyActivity object itself.

Applies to