java.lang.Object
com.azure.resourcemanager.datafactory.models.CopySink
com.azure.resourcemanager.datafactory.models.SqlSink

public final class SqlSink extends CopySink
A copy activity SQL sink.
  • Constructor Details

    • SqlSink

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

    • sqlWriterStoredProcedureName

      public Object sqlWriterStoredProcedureName()
      Get the sqlWriterStoredProcedureName property: SQL writer stored procedure name. Type: string (or Expression with resultType string).
      Returns:
      the sqlWriterStoredProcedureName value.
    • withSqlWriterStoredProcedureName

      public SqlSink withSqlWriterStoredProcedureName(Object sqlWriterStoredProcedureName)
      Set the sqlWriterStoredProcedureName property: SQL writer stored procedure name. Type: string (or Expression with resultType string).
      Parameters:
      sqlWriterStoredProcedureName - the sqlWriterStoredProcedureName value to set.
      Returns:
      the SqlSink object itself.
    • sqlWriterTableType

      public Object sqlWriterTableType()
      Get the sqlWriterTableType property: SQL writer table type. Type: string (or Expression with resultType string).
      Returns:
      the sqlWriterTableType value.
    • withSqlWriterTableType

      public SqlSink withSqlWriterTableType(Object sqlWriterTableType)
      Set the sqlWriterTableType property: SQL writer table type. Type: string (or Expression with resultType string).
      Parameters:
      sqlWriterTableType - the sqlWriterTableType value to set.
      Returns:
      the SqlSink object itself.
    • 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 SqlSink 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 SqlSink object itself.
    • storedProcedureParameters

      public Object storedProcedureParameters()
      Get the storedProcedureParameters property: SQL stored procedure parameters.
      Returns:
      the storedProcedureParameters value.
    • withStoredProcedureParameters

      public SqlSink withStoredProcedureParameters(Object storedProcedureParameters)
      Set the storedProcedureParameters property: SQL stored procedure parameters.
      Parameters:
      storedProcedureParameters - the storedProcedureParameters value to set.
      Returns:
      the SqlSink object itself.
    • storedProcedureTableTypeParameterName

      public Object storedProcedureTableTypeParameterName()
      Get the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).
      Returns:
      the storedProcedureTableTypeParameterName value.
    • withStoredProcedureTableTypeParameterName

      public SqlSink withStoredProcedureTableTypeParameterName(Object storedProcedureTableTypeParameterName)
      Set the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).
      Parameters:
      storedProcedureTableTypeParameterName - the storedProcedureTableTypeParameterName value to set.
      Returns:
      the SqlSink 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 SqlSink 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 SqlSink 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 SqlSink 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 SqlSink object itself.
    • writeBehavior

      public Object writeBehavior()
      Get the writeBehavior property: Write behavior when copying data into sql. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum).
      Returns:
      the writeBehavior value.
    • withWriteBehavior

      public SqlSink withWriteBehavior(Object writeBehavior)
      Set the writeBehavior property: Write behavior when copying data into sql. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum).
      Parameters:
      writeBehavior - the writeBehavior value to set.
      Returns:
      the SqlSink object itself.
    • upsertSettings

      public SqlUpsertSettings upsertSettings()
      Get the upsertSettings property: SQL upsert settings.
      Returns:
      the upsertSettings value.
    • withUpsertSettings

      public SqlSink withUpsertSettings(SqlUpsertSettings upsertSettings)
      Set the upsertSettings property: SQL upsert settings.
      Parameters:
      upsertSettings - the upsertSettings value to set.
      Returns:
      the SqlSink object itself.
    • withWriteBatchSize

      public SqlSink 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 SqlSink 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 SqlSink 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 SqlSink 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 SqlSink 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 SqlSink 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.