Class AzureSqlSink
- java.lang.Object
-
- com.azure.resourcemanager.datafactory.models.CopySink
-
- com.azure.resourcemanager.datafactory.models.AzureSqlSink
-
public final class AzureSqlSink extends CopySink
A copy activity Azure SQL sink.
-
-
Constructor Summary
Constructors Constructor Description AzureSqlSink()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
preCopyScript()
Get the preCopyScript property: SQL pre-copy script.Object
sqlWriterStoredProcedureName()
Get the sqlWriterStoredProcedureName property: SQL writer stored procedure name.Object
sqlWriterTableType()
Get the sqlWriterTableType property: SQL writer table type.Object
sqlWriterUseTableLock()
Get the sqlWriterUseTableLock property: Whether to use table lock during bulk copy.Map<String,StoredProcedureParameter>
storedProcedureParameters()
Get the storedProcedureParameters property: SQL stored procedure parameters.Object
storedProcedureTableTypeParameterName()
Get the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type.Object
tableOption()
Get the tableOption property: The option to handle sink table, such as autoCreate.SqlUpsertSettings
upsertSettings()
Get the upsertSettings property: SQL upsert settings.void
validate()
Validates the instance.AzureSqlSink
withDisableMetricsCollection(Object disableMetricsCollection)
Set the disableMetricsCollection property: If true, disable data store metrics collection.AzureSqlSink
withMaxConcurrentConnections(Object maxConcurrentConnections)
Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store.AzureSqlSink
withPreCopyScript(Object preCopyScript)
Set the preCopyScript property: SQL pre-copy script.AzureSqlSink
withSinkRetryCount(Object sinkRetryCount)
Set the sinkRetryCount property: Sink retry count.AzureSqlSink
withSinkRetryWait(Object sinkRetryWait)
Set the sinkRetryWait property: Sink retry wait.AzureSqlSink
withSqlWriterStoredProcedureName(Object sqlWriterStoredProcedureName)
Set the sqlWriterStoredProcedureName property: SQL writer stored procedure name.AzureSqlSink
withSqlWriterTableType(Object sqlWriterTableType)
Set the sqlWriterTableType property: SQL writer table type.AzureSqlSink
withSqlWriterUseTableLock(Object sqlWriterUseTableLock)
Set the sqlWriterUseTableLock property: Whether to use table lock during bulk copy.AzureSqlSink
withStoredProcedureParameters(Map<String,StoredProcedureParameter> storedProcedureParameters)
Set the storedProcedureParameters property: SQL stored procedure parameters.AzureSqlSink
withStoredProcedureTableTypeParameterName(Object storedProcedureTableTypeParameterName)
Set the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type.AzureSqlSink
withTableOption(Object tableOption)
Set the tableOption property: The option to handle sink table, such as autoCreate.AzureSqlSink
withUpsertSettings(SqlUpsertSettings upsertSettings)
Set the upsertSettings property: SQL upsert settings.AzureSqlSink
withWriteBatchSize(Object writeBatchSize)
Set the writeBatchSize property: Write batch size.AzureSqlSink
withWriteBatchTimeout(Object writeBatchTimeout)
Set the writeBatchTimeout property: Write batch timeout.AzureSqlSink
withWriteBehavior(Object writeBehavior)
Set the writeBehavior property: Write behavior when copying data into Azure SQL.Object
writeBehavior()
Get the writeBehavior property: Write behavior when copying data into Azure SQL.-
Methods inherited from class com.azure.resourcemanager.datafactory.models.CopySink
additionalProperties, disableMetricsCollection, maxConcurrentConnections, sinkRetryCount, sinkRetryWait, withAdditionalProperties, writeBatchSize, writeBatchTimeout
-
-
-
-
Method Detail
-
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 AzureSqlSink 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 AzureSqlSink 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 AzureSqlSink 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 AzureSqlSink 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 AzureSqlSink 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 AzureSqlSink object itself.
-
storedProcedureParameters
public Map<String,StoredProcedureParameter> storedProcedureParameters()
Get the storedProcedureParameters property: SQL stored procedure parameters.- Returns:
- the storedProcedureParameters value.
-
withStoredProcedureParameters
public AzureSqlSink withStoredProcedureParameters(Map<String,StoredProcedureParameter> storedProcedureParameters)
Set the storedProcedureParameters property: SQL stored procedure parameters.- Parameters:
storedProcedureParameters
- the storedProcedureParameters value to set.- Returns:
- the AzureSqlSink 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 AzureSqlSink 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 AzureSqlSink 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 AzureSqlSink 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 AzureSqlSink 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 AzureSqlSink 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 AzureSqlSink object itself.
-
writeBehavior
public Object writeBehavior()
Get the writeBehavior property: Write behavior when copying data into Azure SQL. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum).- Returns:
- the writeBehavior value.
-
withWriteBehavior
public AzureSqlSink withWriteBehavior(Object writeBehavior)
Set the writeBehavior property: Write behavior when copying data into Azure SQL. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum).- Parameters:
writeBehavior
- the writeBehavior value to set.- Returns:
- the AzureSqlSink object itself.
-
upsertSettings
public SqlUpsertSettings upsertSettings()
Get the upsertSettings property: SQL upsert settings.- Returns:
- the upsertSettings value.
-
withUpsertSettings
public AzureSqlSink withUpsertSettings(SqlUpsertSettings upsertSettings)
Set the upsertSettings property: SQL upsert settings.- Parameters:
upsertSettings
- the upsertSettings value to set.- Returns:
- the AzureSqlSink object itself.
-
withWriteBatchSize
public AzureSqlSink withWriteBatchSize(Object writeBatchSize)
Set the writeBatchSize property: Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.- Overrides:
withWriteBatchSize
in classCopySink
- Parameters:
writeBatchSize
- the writeBatchSize value to set.- Returns:
- the CopySink object itself.
-
withWriteBatchTimeout
public AzureSqlSink 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 classCopySink
- Parameters:
writeBatchTimeout
- the writeBatchTimeout value to set.- Returns:
- the CopySink object itself.
-
withSinkRetryCount
public AzureSqlSink withSinkRetryCount(Object sinkRetryCount)
Set the sinkRetryCount property: Sink retry count. Type: integer (or Expression with resultType integer).- Overrides:
withSinkRetryCount
in classCopySink
- Parameters:
sinkRetryCount
- the sinkRetryCount value to set.- Returns:
- the CopySink object itself.
-
withSinkRetryWait
public AzureSqlSink 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 classCopySink
- Parameters:
sinkRetryWait
- the sinkRetryWait value to set.- Returns:
- the CopySink object itself.
-
withMaxConcurrentConnections
public AzureSqlSink 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 classCopySink
- Parameters:
maxConcurrentConnections
- the maxConcurrentConnections value to set.- Returns:
- the CopySink object itself.
-
withDisableMetricsCollection
public AzureSqlSink 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 classCopySink
- Parameters:
disableMetricsCollection
- the disableMetricsCollection value to set.- Returns:
- the CopySink object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classCopySink
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-