Class CopyActivity
java.lang.Object
com.azure.analytics.synapse.artifacts.models.Activity
com.azure.analytics.synapse.artifacts.models.ExecutionActivity
com.azure.analytics.synapse.artifacts.models.CopyActivity
Copy activity.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the dataIntegrationUnits property: Maximum number of data integration units that can be used to perform this data movement.Get the enableSkipIncompatibleRow property: Whether to skip incompatible row.Get the enableStaging property: Specifies whether to copy data via an interim staging.Get the inputs property: List of inputs for the activity.Get the logSettings property: Log settings customer needs provide when enabling log.Get the logStorageSettings property: (Deprecated.Get the outputs property: List of outputs for the activity.Get the parallelCopies property: Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store.Get the preserve property: Preserve rules.Get the preserveRules property: Preserve Rules.Get the redirectIncompatibleRowSettings property: Redirect incompatible row settings when EnableSkipIncompatibleRow is true.getSink()
Get the sink property: Copy activity sink.Get the skipErrorFile property: Specify the fault tolerance for data consistency.Get the source property: Copy activity source.Get the stagingSettings property: Specifies interim staging settings when EnableStaging is true.Get the translator property: Copy activity translator.Get the validateDataConsistency property: Whether to enable Data Consistency validation.setDataIntegrationUnits
(Object dataIntegrationUnits) Set the dataIntegrationUnits property: Maximum number of data integration units that can be used to perform this data movement.setDependsOn
(List<ActivityDependency> dependsOn) Set the dependsOn property: Activity depends on condition.setDescription
(String description) Set the description property: Activity description.setEnableSkipIncompatibleRow
(Object enableSkipIncompatibleRow) Set the enableSkipIncompatibleRow property: Whether to skip incompatible row.setEnableStaging
(Object enableStaging) Set the enableStaging property: Specifies whether to copy data via an interim staging.setInputs
(List<DatasetReference> inputs) Set the inputs property: List of inputs for the activity.setLinkedServiceName
(LinkedServiceReference linkedServiceName) Set the linkedServiceName property: Linked service reference.setLogSettings
(LogSettings logSettings) Set the logSettings property: Log settings customer needs provide when enabling log.setLogStorageSettings
(LogStorageSettings logStorageSettings) Set the logStorageSettings property: (Deprecated.Set the name property: Activity name.setOutputs
(List<DatasetReference> outputs) Set the outputs property: List of outputs for the activity.setParallelCopies
(Object parallelCopies) Set the parallelCopies property: Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store.setPolicy
(ActivityPolicy policy) Set the policy property: Activity policy.setPreserve
(List<Object> preserve) Set the preserve property: Preserve rules.setPreserveRules
(List<Object> preserveRules) Set the preserveRules property: Preserve Rules.setRedirectIncompatibleRowSettings
(RedirectIncompatibleRowSettings redirectIncompatibleRowSettings) Set the redirectIncompatibleRowSettings property: Redirect incompatible row settings when EnableSkipIncompatibleRow is true.Set the sink property: Copy activity sink.setSkipErrorFile
(SkipErrorFile skipErrorFile) Set the skipErrorFile property: Specify the fault tolerance for data consistency.setSource
(CopySource source) Set the source property: Copy activity source.setStagingSettings
(StagingSettings stagingSettings) Set the stagingSettings property: Specifies interim staging settings when EnableStaging is true.setTranslator
(Object translator) Set the translator property: Copy activity translator.setUserProperties
(List<UserProperty> userProperties) Set the userProperties property: Activity user properties.setValidateDataConsistency
(Object validateDataConsistency) Set the validateDataConsistency property: Whether to enable Data Consistency validation.Methods inherited from class com.azure.analytics.synapse.artifacts.models.ExecutionActivity
getLinkedServiceName, getPolicy
Methods inherited from class com.azure.analytics.synapse.artifacts.models.Activity
getAdditionalProperties, getDependsOn, getDescription, getName, getUserProperties, setAdditionalProperties
-
Constructor Details
-
CopyActivity
public CopyActivity()
-
-
Method Details
-
getInputs
Get the inputs property: List of inputs for the activity.- Returns:
- the inputs value.
-
setInputs
Set the inputs property: List of inputs for the activity.- Parameters:
inputs
- the inputs value to set.- Returns:
- the CopyActivity object itself.
-
getOutputs
Get the outputs property: List of outputs for the activity.- Returns:
- the outputs value.
-
setOutputs
Set the outputs property: List of outputs for the activity.- Parameters:
outputs
- the outputs value to set.- Returns:
- the CopyActivity object itself.
-
getSource
Get the source property: Copy activity source.- Returns:
- the source value.
-
setSource
Set the source property: Copy activity source.- Parameters:
source
- the source value to set.- Returns:
- the CopyActivity object itself.
-
getSink
Get the sink property: Copy activity sink.- Returns:
- the sink value.
-
setSink
Set the sink property: Copy activity sink.- Parameters:
sink
- the sink value to set.- Returns:
- the CopyActivity object itself.
-
getTranslator
Get the translator property: Copy activity translator. If not specified, tabular translator is used.- Returns:
- the translator value.
-
setTranslator
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.
-
getEnableStaging
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.
-
setEnableStaging
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.
-
getStagingSettings
Get the stagingSettings property: Specifies interim staging settings when EnableStaging is true.- Returns:
- the stagingSettings value.
-
setStagingSettings
Set the stagingSettings property: Specifies interim staging settings when EnableStaging is true.- Parameters:
stagingSettings
- the stagingSettings value to set.- Returns:
- the CopyActivity object itself.
-
getParallelCopies
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.
-
setParallelCopies
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.
-
getDataIntegrationUnits
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.
-
setDataIntegrationUnits
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.
-
getEnableSkipIncompatibleRow
Get the enableSkipIncompatibleRow property: Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).- Returns:
- the enableSkipIncompatibleRow value.
-
setEnableSkipIncompatibleRow
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.
-
getRedirectIncompatibleRowSettings
Get the redirectIncompatibleRowSettings property: Redirect incompatible row settings when EnableSkipIncompatibleRow is true.- Returns:
- the redirectIncompatibleRowSettings value.
-
setRedirectIncompatibleRowSettings
public CopyActivity setRedirectIncompatibleRowSettings(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.
-
getLogStorageSettings
Get the logStorageSettings property: (Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log.- Returns:
- the logStorageSettings value.
-
setLogStorageSettings
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.
-
getLogSettings
Get the logSettings property: Log settings customer needs provide when enabling log.- Returns:
- the logSettings value.
-
setLogSettings
Set the logSettings property: Log settings customer needs provide when enabling log.- Parameters:
logSettings
- the logSettings value to set.- Returns:
- the CopyActivity object itself.
-
getPreserveRules
Get the preserveRules property: Preserve Rules.- Returns:
- the preserveRules value.
-
setPreserveRules
Set the preserveRules property: Preserve Rules.- Parameters:
preserveRules
- the preserveRules value to set.- Returns:
- the CopyActivity object itself.
-
getPreserve
Get the preserve property: Preserve rules.- Returns:
- the preserve value.
-
setPreserve
Set the preserve property: Preserve rules.- Parameters:
preserve
- the preserve value to set.- Returns:
- the CopyActivity object itself.
-
getValidateDataConsistency
Get the validateDataConsistency property: Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean).- Returns:
- the validateDataConsistency value.
-
setValidateDataConsistency
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.
-
getSkipErrorFile
Get the skipErrorFile property: Specify the fault tolerance for data consistency.- Returns:
- the skipErrorFile value.
-
setSkipErrorFile
Set the skipErrorFile property: Specify the fault tolerance for data consistency.- Parameters:
skipErrorFile
- the skipErrorFile value to set.- Returns:
- the CopyActivity object itself.
-
setLinkedServiceName
Set the linkedServiceName property: Linked service reference.- Overrides:
setLinkedServiceName
in classExecutionActivity
- Parameters:
linkedServiceName
- the linkedServiceName value to set.- Returns:
- the ExecutionActivity object itself.
-
setPolicy
Set the policy property: Activity policy.- Overrides:
setPolicy
in classExecutionActivity
- Parameters:
policy
- the policy value to set.- Returns:
- the ExecutionActivity object itself.
-
setName
Set the name property: Activity name.- Overrides:
setName
in classExecutionActivity
- Parameters:
name
- the name value to set.- Returns:
- the Activity object itself.
-
setDescription
Set the description property: Activity description.- Overrides:
setDescription
in classExecutionActivity
- Parameters:
description
- the description value to set.- Returns:
- the Activity object itself.
-
setDependsOn
Set the dependsOn property: Activity depends on condition.- Overrides:
setDependsOn
in classExecutionActivity
- Parameters:
dependsOn
- the dependsOn value to set.- Returns:
- the Activity object itself.
-
setUserProperties
Set the userProperties property: Activity user properties.- Overrides:
setUserProperties
in classExecutionActivity
- Parameters:
userProperties
- the userProperties value to set.- Returns:
- the Activity object itself.
-