SalesforceSink (Azure SDK for Java Reference Documentation)
Leah Mitchell
Published Feb 16, 2026
public final class SalesforceSinkextends CopySink
A copy activity Salesforce sink.
Constructor Summary
Constructor Detail
SalesforceSink
public SalesforceSink()
Method Detail
writeBehavior
public SalesforceSinkWriteBehavior writeBehavior()
Get the writeBehavior property: The write behavior for the operation. Default is Insert.
- Returns:
- the writeBehavior value.
withWriteBehavior
public SalesforceSink withWriteBehavior(SalesforceSinkWriteBehavior writeBehavior)
Set the writeBehavior property: The write behavior for the operation. Default is Insert.
- Parameters:
writeBehavior- the writeBehavior value to set.- Returns:
- the SalesforceSink object itself.
externalIdFieldName
public Object externalIdFieldName()
Get the externalIdFieldName property: The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string).
- Returns:
- the externalIdFieldName value.
withExternalIdFieldName
public SalesforceSink withExternalIdFieldName(Object externalIdFieldName)
Set the externalIdFieldName property: The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string).
- Parameters:
externalIdFieldName- the externalIdFieldName value to set.- Returns:
- the SalesforceSink object itself.
ignoreNullValues
public Object ignoreNullValues()
Get the ignoreNullValues property: The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).
- Returns:
- the ignoreNullValues value.
withIgnoreNullValues
public SalesforceSink withIgnoreNullValues(Object ignoreNullValues)
Set the ignoreNullValues property: The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).
- Parameters:
ignoreNullValues- the ignoreNullValues value to set.- Returns:
- the SalesforceSink object itself.
withWriteBatchSize
public SalesforceSink withWriteBatchSize(Object writeBatchSize)
Set the writeBatchSize property: Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
- Overrides:
withWriteBatchSizein classCopySink- Parameters:
writeBatchSize- the writeBatchSize value to set.- Returns:
- the CopySink object itself.
withWriteBatchTimeout
public SalesforceSink 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:
withWriteBatchTimeoutin classCopySink- Parameters:
writeBatchTimeout- the writeBatchTimeout value to set.- Returns:
- the CopySink object itself.
withSinkRetryCount
public SalesforceSink withSinkRetryCount(Object sinkRetryCount)
Set the sinkRetryCount property: Sink retry count. Type: integer (or Expression with resultType integer).
- Overrides:
withSinkRetryCountin classCopySink- Parameters:
sinkRetryCount- the sinkRetryCount value to set.- Returns:
- the CopySink object itself.
withSinkRetryWait
public SalesforceSink 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:
withSinkRetryWaitin classCopySink- Parameters:
sinkRetryWait- the sinkRetryWait value to set.- Returns:
- the CopySink object itself.
withMaxConcurrentConnections
public SalesforceSink 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:
withMaxConcurrentConnectionsin classCopySink- Parameters:
maxConcurrentConnections- the maxConcurrentConnections value to set.- Returns:
- the CopySink object itself.
withDisableMetricsCollection
public SalesforceSink 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:
withDisableMetricsCollectionin classCopySink- Parameters:
disableMetricsCollection- the disableMetricsCollection value to set.- Returns:
- the CopySink object itself.