Class CopyActivity


public final class CopyActivity extends ExecutionActivity
Copy activity.
  • Constructor Details

    • CopyActivity

      public CopyActivity()
      Creates an instance of CopyActivity class.
  • Method Details

    • inputs

      public List<DatasetReference> inputs()
      Get the inputs property: List of inputs for the activity.
      Returns:
      the inputs value.
    • 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.
    • outputs

      public List<DatasetReference> outputs()
      Get the outputs property: List of outputs for the activity.
      Returns:
      the outputs value.
    • 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.
    • withLinkedServiceName

      public CopyActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)
      Set the linkedServiceName property: Linked service reference.
      Overrides:
      withLinkedServiceName in class ExecutionActivity
      Parameters:
      linkedServiceName - the linkedServiceName value to set.
      Returns:
      the ExecutionActivity object itself.
    • withPolicy

      public CopyActivity withPolicy(ActivityPolicy policy)
      Set the policy property: Activity policy.
      Overrides:
      withPolicy in class ExecutionActivity
      Parameters:
      policy - the policy value to set.
      Returns:
      the ExecutionActivity object itself.
    • withName

      public CopyActivity withName(String name)
      Set the name property: Activity name.
      Overrides:
      withName in class ExecutionActivity
      Parameters:
      name - the name value to set.
      Returns:
      the Activity object itself.
    • withDescription

      public CopyActivity withDescription(String description)
      Set the description property: Activity description.
      Overrides:
      withDescription in class ExecutionActivity
      Parameters:
      description - the description value to set.
      Returns:
      the Activity object itself.
    • withDependsOn

      public CopyActivity withDependsOn(List<ActivityDependency> dependsOn)
      Set the dependsOn property: Activity depends on condition.
      Overrides:
      withDependsOn in class ExecutionActivity
      Parameters:
      dependsOn - the dependsOn value to set.
      Returns:
      the Activity object itself.
    • withUserProperties

      public CopyActivity withUserProperties(List<UserProperty> userProperties)
      Set the userProperties property: Activity user properties.
      Overrides:
      withUserProperties in class ExecutionActivity
      Parameters:
      userProperties - the userProperties value to set.
      Returns:
      the Activity object itself.
    • source

      public CopySource source()
      Get the source property: Copy activity source.
      Returns:
      the source value.
    • 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.
    • sink

      public CopySink sink()
      Get the sink property: Copy activity sink.
      Returns:
      the sink value.
    • 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.
    • translator

      public Object translator()
      Get the translator property: Copy activity translator. If not specified, tabular translator is used.
      Returns:
      the translator value.
    • 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.
    • 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.
    • 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.
    • stagingSettings

      public StagingSettings stagingSettings()
      Get the stagingSettings property: Specifies interim staging settings when EnableStaging is true.
      Returns:
      the stagingSettings value.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • redirectIncompatibleRowSettings

      public RedirectIncompatibleRowSettings redirectIncompatibleRowSettings()
      Get the redirectIncompatibleRowSettings property: Redirect incompatible row settings when EnableSkipIncompatibleRow is true.
      Returns:
      the redirectIncompatibleRowSettings value.
    • 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.
    • 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.
    • 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.
    • logSettings

      public LogSettings logSettings()
      Get the logSettings property: Log settings customer needs provide when enabling log.
      Returns:
      the logSettings value.
    • 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.
    • preserveRules

      public List<Object> preserveRules()
      Get the preserveRules property: Preserve Rules.
      Returns:
      the preserveRules value.
    • 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.
    • preserve

      public List<Object> preserve()
      Get the preserve property: Preserve rules.
      Returns:
      the preserve value.
    • 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.
    • 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.
    • 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.
    • skipErrorFile

      public SkipErrorFile skipErrorFile()
      Get the skipErrorFile property: Specify the fault tolerance for data consistency.
      Returns:
      the skipErrorFile value.
    • 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.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ExecutionActivity
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.