![JAR search and dependency download from the Maven repository](/logo.png)
com.pulumi.awsnative.appflow.kotlin.inputs.FlowSalesforceSourcePropertiesArgs.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.appflow.kotlin.inputs
import com.pulumi.awsnative.appflow.inputs.FlowSalesforceSourcePropertiesArgs.builder
import com.pulumi.awsnative.appflow.kotlin.enums.FlowDataTransferApi
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiNullFieldException
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
*
* @property dataTransferApi Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce.
* - **AUTOMATIC** - The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.
* Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.
* By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.
* - **BULKV2** - Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.
* Note that Bulk API 2.0 does not transfer Salesforce compound fields.
* - **REST_SYNC** - Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error.
* @property enableDynamicFieldUpdate The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
* @property includeDeletedRecords Indicates whether Amazon AppFlow includes deleted files in the flow run.
* @property object The object specified in the Salesforce flow source.
*/
public data class FlowSalesforceSourcePropertiesArgs(
public val dataTransferApi: Output? = null,
public val enableDynamicFieldUpdate: Output? = null,
public val includeDeletedRecords: Output? = null,
public val `object`: Output,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.appflow.inputs.FlowSalesforceSourcePropertiesArgs =
com.pulumi.awsnative.appflow.inputs.FlowSalesforceSourcePropertiesArgs.builder()
.dataTransferApi(dataTransferApi?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.enableDynamicFieldUpdate(enableDynamicFieldUpdate?.applyValue({ args0 -> args0 }))
.includeDeletedRecords(includeDeletedRecords?.applyValue({ args0 -> args0 }))
.`object`(`object`.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [FlowSalesforceSourcePropertiesArgs].
*/
@PulumiTagMarker
public class FlowSalesforceSourcePropertiesArgsBuilder internal constructor() {
private var dataTransferApi: Output? = null
private var enableDynamicFieldUpdate: Output? = null
private var includeDeletedRecords: Output? = null
private var `object`: Output? = null
/**
* @param value Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce.
* - **AUTOMATIC** - The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.
* Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.
* By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.
* - **BULKV2** - Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.
* Note that Bulk API 2.0 does not transfer Salesforce compound fields.
* - **REST_SYNC** - Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error.
*/
@JvmName("dxekffmmgndsircq")
public suspend fun dataTransferApi(`value`: Output) {
this.dataTransferApi = value
}
/**
* @param value The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
*/
@JvmName("abcuucupnktqpfqa")
public suspend fun enableDynamicFieldUpdate(`value`: Output) {
this.enableDynamicFieldUpdate = value
}
/**
* @param value Indicates whether Amazon AppFlow includes deleted files in the flow run.
*/
@JvmName("oreyutlunpkqrwlf")
public suspend fun includeDeletedRecords(`value`: Output) {
this.includeDeletedRecords = value
}
/**
* @param value The object specified in the Salesforce flow source.
*/
@JvmName("qlfcsobnoqcmsjjk")
public suspend fun `object`(`value`: Output) {
this.`object` = value
}
/**
* @param value Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce.
* - **AUTOMATIC** - The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.
* Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.
* By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.
* - **BULKV2** - Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.
* Note that Bulk API 2.0 does not transfer Salesforce compound fields.
* - **REST_SYNC** - Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error.
*/
@JvmName("ajsasvvipvgiumqc")
public suspend fun dataTransferApi(`value`: FlowDataTransferApi?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.dataTransferApi = mapped
}
/**
* @param value The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
*/
@JvmName("tsxabrutbhbaoenr")
public suspend fun enableDynamicFieldUpdate(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.enableDynamicFieldUpdate = mapped
}
/**
* @param value Indicates whether Amazon AppFlow includes deleted files in the flow run.
*/
@JvmName("dlrdvkadoodaucra")
public suspend fun includeDeletedRecords(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.includeDeletedRecords = mapped
}
/**
* @param value The object specified in the Salesforce flow source.
*/
@JvmName("ajgrhmjhcoxkmxte")
public suspend fun `object`(`value`: String) {
val toBeMapped = value
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.`object` = mapped
}
internal fun build(): FlowSalesforceSourcePropertiesArgs = FlowSalesforceSourcePropertiesArgs(
dataTransferApi = dataTransferApi,
enableDynamicFieldUpdate = enableDynamicFieldUpdate,
includeDeletedRecords = includeDeletedRecords,
`object` = `object` ?: throw PulumiNullFieldException("object"),
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy