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