Package com.azure.resourcemanager.datafactory.models

Class SqlDWSink

java.lang.Object
com.azure.resourcemanager.datafactory.models.CopySink
com.azure.resourcemanager.datafactory.models.SqlDWSink
public final class SqlDWSink extends CopySink
A copy activity SQL Data Warehouse sink.

  • Constructor Details

    • SqlDWSink

      public SqlDWSink()
      Creates an instance of SqlDWSink class.

  • Method Details

    • preCopyScript

      public Object preCopyScript()
      Get the preCopyScript property: SQL pre-copy script. Type: string (or Expression with resultType string).
      Returns:
      the preCopyScript value.

    • withPreCopyScript

      public SqlDWSink withPreCopyScript(Object preCopyScript)
      Set the preCopyScript property: SQL pre-copy script. Type: string (or Expression with resultType string).
      Parameters:
      preCopyScript - the preCopyScript value to set.
      Returns:
      the SqlDWSink object itself.

    • allowPolyBase

      public Object allowPolyBase()
      Get the allowPolyBase property: Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).
      Returns:
      the allowPolyBase value.

    • withAllowPolyBase

      public SqlDWSink withAllowPolyBase(Object allowPolyBase)
      Set the allowPolyBase property: Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).
      Parameters:
      allowPolyBase - the allowPolyBase value to set.
      Returns:
      the SqlDWSink object itself.

    • polyBaseSettings

      public PolybaseSettings polyBaseSettings()
      Get the polyBaseSettings property: Specifies PolyBase-related settings when allowPolyBase is true.
      Returns:
      the polyBaseSettings value.

    • withPolyBaseSettings

      public SqlDWSink withPolyBaseSettings(PolybaseSettings polyBaseSettings)
      Set the polyBaseSettings property: Specifies PolyBase-related settings when allowPolyBase is true.
      Parameters:
      polyBaseSettings - the polyBaseSettings value to set.
      Returns:
      the SqlDWSink object itself.

    • allowCopyCommand

      public Object allowCopyCommand()
      Get the allowCopyCommand property: Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).
      Returns:
      the allowCopyCommand value.

    • withAllowCopyCommand

      public SqlDWSink withAllowCopyCommand(Object allowCopyCommand)
      Set the allowCopyCommand property: Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).
      Parameters:
      allowCopyCommand - the allowCopyCommand value to set.
      Returns:
      the SqlDWSink object itself.

    • copyCommandSettings

      public DWCopyCommandSettings copyCommandSettings()
      Get the copyCommandSettings property: Specifies Copy Command related settings when allowCopyCommand is true.
      Returns:
      the copyCommandSettings value.

    • withCopyCommandSettings

      public SqlDWSink withCopyCommandSettings(DWCopyCommandSettings copyCommandSettings)
      Set the copyCommandSettings property: Specifies Copy Command related settings when allowCopyCommand is true.
      Parameters:
      copyCommandSettings - the copyCommandSettings value to set.
      Returns:
      the SqlDWSink object itself.

    • tableOption

      public Object tableOption()
      Get the tableOption property: The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
      Returns:
      the tableOption value.

    • withTableOption

      public SqlDWSink withTableOption(Object tableOption)
      Set the tableOption property: The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
      Parameters:
      tableOption - the tableOption value to set.
      Returns:
      the SqlDWSink object itself.

    • sqlWriterUseTableLock

      public Object sqlWriterUseTableLock()
      Get the sqlWriterUseTableLock property: Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).
      Returns:
      the sqlWriterUseTableLock value.

    • withSqlWriterUseTableLock

      public SqlDWSink withSqlWriterUseTableLock(Object sqlWriterUseTableLock)
      Set the sqlWriterUseTableLock property: Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).
      Parameters:
      sqlWriterUseTableLock - the sqlWriterUseTableLock value to set.
      Returns:
      the SqlDWSink object itself.

    • writeBehavior

      public Object writeBehavior()
      Get the writeBehavior property: Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum).
      Returns:
      the writeBehavior value.

    • withWriteBehavior

      public SqlDWSink withWriteBehavior(Object writeBehavior)
      Set the writeBehavior property: Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum).
      Parameters:
      writeBehavior - the writeBehavior value to set.
      Returns:
      the SqlDWSink object itself.

    • upsertSettings

      public SqlDWUpsertSettings upsertSettings()
      Get the upsertSettings property: SQL DW upsert settings.
      Returns:
      the upsertSettings value.

    • withUpsertSettings

      public SqlDWSink withUpsertSettings(SqlDWUpsertSettings upsertSettings)
      Set the upsertSettings property: SQL DW upsert settings.
      Parameters:
      upsertSettings - the upsertSettings value to set.
      Returns:
      the SqlDWSink object itself.

    • withWriteBatchSize

      public SqlDWSink withWriteBatchSize(Object writeBatchSize)
      Set the writeBatchSize property: Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
      Overrides:
      withWriteBatchSize in class CopySink
      Parameters:
      writeBatchSize - the writeBatchSize value to set.
      Returns:
      the CopySink object itself.

    • withWriteBatchTimeout

      public SqlDWSink withWriteBatchTimeout(Object writeBatchTimeout)
      Set the writeBatchTimeout property: Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
      Overrides:
      withWriteBatchTimeout in class CopySink
      Parameters:
      writeBatchTimeout - the writeBatchTimeout value to set.
      Returns:
      the CopySink object itself.

    • withSinkRetryCount

      public SqlDWSink withSinkRetryCount(Object sinkRetryCount)
      Set the sinkRetryCount property: Sink retry count. Type: integer (or Expression with resultType integer).
      Overrides:
      withSinkRetryCount in class CopySink
      Parameters:
      sinkRetryCount - the sinkRetryCount value to set.
      Returns:
      the CopySink object itself.

    • withSinkRetryWait

      public SqlDWSink withSinkRetryWait(Object sinkRetryWait)
      Set the sinkRetryWait property: Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
      Overrides:
      withSinkRetryWait in class CopySink
      Parameters:
      sinkRetryWait - the sinkRetryWait value to set.
      Returns:
      the CopySink object itself.

    • withMaxConcurrentConnections

      public SqlDWSink withMaxConcurrentConnections(Object maxConcurrentConnections)
      Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
      Overrides:
      withMaxConcurrentConnections in class CopySink
      Parameters:
      maxConcurrentConnections - the maxConcurrentConnections value to set.
      Returns:
      the CopySink object itself.

    • withDisableMetricsCollection

      public SqlDWSink withDisableMetricsCollection(Object disableMetricsCollection)
      Set the disableMetricsCollection property: If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
      Overrides:
      withDisableMetricsCollection in class CopySink
      Parameters:
      disableMetricsCollection - the disableMetricsCollection value to set.
      Returns:
      the CopySink object itself.

    • validate

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