Class SalesforceSink
java.lang.Object
com.azure.resourcemanager.datafactory.models.CopySink
com.azure.resourcemanager.datafactory.models.SalesforceSink
A copy activity Salesforce sink.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the externalIdFieldName property: The name of the external ID field for upsert operation.Get the ignoreNullValues property: The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation.void
validate()
Validates the instance.withDisableMetricsCollection
(Object disableMetricsCollection) Set the disableMetricsCollection property: If true, disable data store metrics collection.withExternalIdFieldName
(Object externalIdFieldName) Set the externalIdFieldName property: The name of the external ID field for upsert operation.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.withMaxConcurrentConnections
(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store.withSinkRetryCount
(Object sinkRetryCount) Set the sinkRetryCount property: Sink retry count.withSinkRetryWait
(Object sinkRetryWait) Set the sinkRetryWait property: Sink retry wait.withWriteBatchSize
(Object writeBatchSize) Set the writeBatchSize property: Write batch size.withWriteBatchTimeout
(Object writeBatchTimeout) Set the writeBatchTimeout property: Write batch timeout.withWriteBehavior
(SalesforceSinkWriteBehavior writeBehavior) Set the writeBehavior property: The write behavior for the operation.Get the writeBehavior property: The write behavior for the operation.Methods inherited from class com.azure.resourcemanager.datafactory.models.CopySink
additionalProperties, disableMetricsCollection, maxConcurrentConnections, sinkRetryCount, sinkRetryWait, withAdditionalProperties, writeBatchSize, writeBatchTimeout
-
Constructor Details
-
SalesforceSink
public SalesforceSink()Creates an instance of SalesforceSink class.
-
-
Method Details
-
writeBehavior
Get the writeBehavior property: The write behavior for the operation. Default is Insert.- Returns:
- the writeBehavior value.
-
withWriteBehavior
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
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
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
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
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
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
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
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
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
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
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.
-