118.3. 组件选项

apexMethod (common)

APEX 方法名称。

字符串

apexQueryParams (common)

查询 APEX 方法的参数.

Map

apiVersion (common)

salesforce API 版本。

53.0

字符串

backoffIncrement (common)

对于流连接重启尝试超过 CometD auto-reconnect 的 backoff 间隔递增。

1000

long

batchId (common)

批量 API 批处理 ID。

字符串

contentType (common)

批量 API 内容类型, XML, CSV, ZIP_XML, ZIP_CSV 之一。

Enum 值：

ContentType

defaultReplayId (common)

如果没有在 initialReplayIdMap 中找到值，则默认 replayId 设置。

-1

Long

fallBackReplayId (common)

ReplayId 在 Invalid Replay Id 响应后回退到。

-1

Long

格式 (common)

用于 Salesforce API 调用的有效负载格式(JSON 或 XML)默认为 JSON。自 Camel 3.12 起，此选项仅适用于 Raw 操作。

Enum 值：

PayloadFormat

httpclient ( common)

自定义 Jetty Http 客户端用于连接到 Salesforce。

SalesforceHttpClient

httpClientConnectionTimeout (common)

连接到 Salesforce 服务器时 HttpClient 使用的连接超时。

60000

long

httpClientIdleTimeout (common)

在等待 Salesforce 服务器的响应时，HttpClient 使用超时。

10000

long

httpMaxContentLength (common)

HTTP 响应的最大内容长度。

整数

httpRequestBufferSize (common)

HTTP 请求缓冲区大小。可能需要增加大型 SOQL 查询。

8192

整数

includeDetails (common)

在 Salesforce1 分析报告中包括详细信息，默认为 false。

布尔值

initialReplayIdMap (common)

重播 ID 从每个频道名称开始。

Map

instanceID (common)

Salesforce1 分析报告执行实例 ID。

字符串

jobId (common)

批量 API 作业 ID。

字符串

limit (common)

返回的记录数量的限制。适用于某些 API，请查看 Salesforce 文档。

整数

Locator (common)

salesforce Bulk 2.0 API 提供的查找器，用于获取查询作业的结果。

字符串

maxBackoff (common)

Streaming connection restart attempt for failures beyond CometD auto-reconnect 的最大 backoff 间隔。

30000

long

maxRecords (common)

对于 Bulk 2.0 Query 的每个结果检索的最大记录数。请求仍受大小限制。如果您处理大量查询结果，您可能会在从 Salesforce 接收所有数据前遇到超时问题。要防止超时，请指定客户端在 maxRecords 参数中预期接收的最大记录数。这会将结果分成较小的集合，使用这个值作为最大大小。

整数

notFoundBehaviour (common)

设置从 Salesforce API 收到的 404 未找到状态的行为。如果正文设置为 NULL NotFoundBehaviour#NULL，或者应该在交换 NotFoundBehaviour CPUfreqEXCEPTION 上发送异常。

Enum 值：

例外

NotFoundBehaviour

notifyForFields (common)

notify 表示字段，选项为 ALL、REFERENCED、SELECT、WHERE。

Enum 值：

NotifyForFieldsEnum

notifyForOperationCreate (common)

notify 用于 create 操作，默认为 false (API version = 29.0)。

布尔值

notifyForOperationDelete (common)

notify 用于 delete 操作，默认为 false (API version = 29.0)。

布尔值

notifyForOperations (common)

notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API 版本 29.0)。

Enum 值：

NotifyForOperationsEnum

notifyForOperationUndelete (common)

notify 用于 un-delete 操作，默认为 false (API version = 29.0)。

布尔值

notifyForOperationUpdate (common)

notify 用于 update 操作，默认为 false (API version = 29.0)。

布尔值

ObjectMapper ( common)

自定义 Jackson ObjectMapper 在序列化/撤销 Salesforce 对象时使用。

ObjectMapper

packages (common)

在哪些软件包中是生成的 DTO 类。通常，类将使用 camel-salesforce-maven-plugin 生成。如果使用生成的 DTOs 来获得在 parameters/header 值中使用简短 SObject 名称的好处，则设置它。可以使用逗号分隔多个软件包。

字符串

pkChunking (common)

使用 PK Chunking。仅在原始 Bulk API 中使用。如果需要，批量 2.0 API 会自动执行 PK 块。

布尔值

pkChunkingChunkSize (common)

用于 PK Chunking 的块大小。如果未指定，salesforce 默认为 100,000。最大大小为 250,000。

整数

pkChunkingParent (common)

当您启用 PK 块对共享对象查询时，请指定父对象。块基于父对象的记录，而不是共享对象的记录。例如，在查询 AccountShare 时，将 Account 指定为父对象。只要支持父对象，PK 块支持共享对象。

字符串

pkChunkingStartRow (common)

指定用作第一个块的 15 个字符或 18 个字符的记录 ID。在重启批处理之间失败的作业时，使用此参数指定起始 ID。

字符串

queryLocator (common)

当查询结果比单个调用检索更多记录时，查询 salesforce 提供的查询查找器。在后续调用中使用这个值来检索额外的记录。

字符串

rawPayload (common)

将原始有效负载字符串用于请求和响应(JSON 或 XML 根据格式)，而不是 DTOs，默认为 false。

false

布尔值

reportId (common)

Salesforce1 分析报告 Id.

字符串

reportMetadata (common)

Salesforce1 分析报告用于过滤的元数据。

ReportMetadata

resultId (common)

批量 API 结果 ID。

字符串

sObjectBlobFieldName (common)

SObject blob 字段名称。

字符串

sObjectClass (common)

完全限定的 SObject 类名称，通常使用 camel-salesforce-maven-plugin 生成。

字符串

sObjectFields (common)

要检索的 SObject 字段。

字符串

sObjectId (common)

API 需要 SObject ID。

字符串

sObjectIdName (common)

SObject 外部 ID 字段名称。

字符串

sObjectIdValue (common)

SObject 外部 ID 字段值。

字符串

sObjectName (common)

SObject 名称（如果 API 需要或支持）

字符串

sObjectQuery (common)

SOQL 查询字符串。

字符串

sObjectSearch (common)

SOSL 搜索字符串。

字符串

updateTopic (common)

在使用 Streaming API 时更新现有的 Push Topic，默认为 false。

false

布尔值

config (common (advanced))

全局端点配置 - 使用 设置所有端点通用的值。

SalesforceEndpointConfig

httpClientProperties (common (advanced))

用于设置可以在底层 HTTP 客户端上配置的任何属性。查看 SalesforceHttpClient 的属性，以及适用于所有可用选项的 Jetty HttpClient。

Map

longPollingTransportProperties (common (advanced))

用于在 streaming api 使用的 BayeuxClient (CometD)上使用的 LongPollingTransport 上配置的任何属性。

Map

workerPoolMaxSize (common (advanced))

用于处理 HTTP 响应的线程池的最大大小。

20

int

workerPoolSize (common (advanced))

用于处理 HTTP 响应的线程池的大小。

10

int

bridgeErrorHandler (consumer)

允许将消费者桥接到 Camel 路由错误处理程序，这意味着当消费者试图选择传入消息或类似信息时发生异常，现在将作为消息处理并由路由 Error Handler 处理。默认情况下，使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况，该处理程序将被记录在 WARN 或 ERROR 级别，并忽略。

false

布尔值

allOrNone (producer)

复合 API 选项，用于指示在任何成功时回滚所有记录。

false

布尔值

apexUrl (producer)

APEX 方法 URL。

字符串

compositeMethod (producer)

复合（原始）方法。

字符串

lazyStartProducer (producer)

生成者是否应懒惰启动 （在第一个消息中）。通过懒惰启动，您可以使用此选项来允许 CamelContext 和路由在生成者启动期间启动，并导致路由启动失败。通过懒惰启动，启动失败可以在路由信息时通过 Camel 的路由错误处理程序进行处理。请注意，在处理第一个消息时，创建并启动生成者可能需要稍等时间，并延长处理的总处理时间。

false

布尔值

rawHttpHeaders (producer)

以逗号分隔的消息标头列表，作为 Raw 操作的 HTTP 参数包含。

字符串

rawMethod (producer)

用于 Raw 操作的 HTTP 方法。

字符串

rawPath (producer)

域名后端点 URL 的部分。E.g., '/services/data/v52.0/sobjects/Account/'.

字符串

rawQueryParameters (producer)

以逗号分隔的消息标头列表，作为 Raw 操作的查询参数列表。不要 url-encode 值，因为这将会被自动完成。

字符串

autowiredEnabled (advanced)

是否启用自动关闭。这用于自动关闭选项（选项必须标记为 autowired），方法是在 registry 中查找查找是否有单个匹配类型实例，然后在组件上配置。这可以用于自动配置 JDBC 数据源、JMS 连接工厂、AWS 客户端等。

true

布尔值

httpProxyExcludedAddresses (proxy)

不应使用 HTTP 代理服务器的地址列表。

Set

httpProxyHost (proxy)

要使用的 HTTP 代理服务器的主机名。

字符串

httpProxyIncludedAddresses (proxy)

应该使用 HTTP 代理服务器的地址列表。

Set

httpProxyPort (proxy)

要使用的 HTTP 代理服务器的端口号。

整数

httpProxySocks4 (proxy)

如果设置为 true，则将 HTTP 代理配置为用作 SOCKS4 代理。

false

布尔值

authenticationType (security)

明确使用的身份验证方法，其中一个 USERNAME_PASSWORD、REFRESH_TOKEN 或 JWT。salesforce 组件可以自动确定要从属性集中使用的身份验证方法，将此属性设置为消除任何不确定性。

Enum 值：

AuthenticationType

clientId (security)

必需 在 Salesforce 实例设置中配置的连接应用程序的 OAuth 消费者密钥。通常，需要配置连接的应用程序，但可以通过安装软件包来提供。

字符串

clientSecret (security)

在 Salesforce 实例设置中配置的已连接应用程序的 OAuth 消费者 Secret。

字符串

httpProxyAuthUri (security)

用于针对 HTTP 代理服务器进行身份验证，需要与代理服务器的 URI 匹配，以便使用 httpProxyUsername 和 httpProxyPassword 进行身份验证。

字符串

httpProxyPassword (security)

用于对 HTTP 代理服务器进行身份验证的密码。

字符串

httpProxyRealm (security)

代理服务器的域，用于针对 HTTP 代理服务器抢占 Basic/Digest 身份验证方法。

字符串

httpProxySecure (security)

如果设置为 false，则禁用在访问 HTTP 代理时使用 TLS。

true

布尔值

httpProxyUseDigestAuth (security)

如果在向 HTTP 代理进行身份验证时，将使用 true Digest 身份验证，否则将使用基本授权方法。

false

布尔值

httpProxyUsername (security)

用于对 HTTP 代理服务器进行身份验证的用户名。

字符串

instanceUrl (security)

身份验证后使用的 Salesforce 实例的 URL，默认为从 Salesforce 获得成功身份验证。

字符串

JWTAudience (security)

使用 OAuth JWT 流时要用于 Audience 声明(aud)的值。如果没有设置，则将使用登录 URL，这在大多数情况下是合适的。

字符串

keystore (security)

在 OAuth JWT 流中使用的密钥存储参数。KeyStore 应该只包含一个带有私钥和证书的条目。salesforce 不会验证证书链，因此这很容易是自签名证书。确保将证书上传到对应的连接的应用程序。

KeyStoreParameters

lazyLogin (security)

如果设置为 true，则组件可以防止组件通过启动组件向 Salesforce 进行身份验证。您通常将其设置为 （默认） false，并提前进行身份验证，并立即了解任何身份验证问题。

false

布尔值

loginConfig (security)

在一个嵌套的 bean 中的所有身份验证配置，也可以直接在组件上设置所有属性。

SalesforceLoginConfig

loginUrl (security)

用于身份验证的 Salesforce 实例 所需的 URL，默认设置为 https://login.salesforce.com。

https://login.salesforce.com

字符串

密码 (security)

OAuth 流中使用的密码，以获取对访问令牌的访问权限。使用密码 OAuth 流很容易，但通常应该避免它，因为它被视为不如其他流的安全性。如果使用，请确保将安全令牌附加到密码的末尾。

字符串

refreshToken (security)

刷新令牌已在刷新令牌 OAuth 流中获取。一个需要设置 Web 应用程序并配置回调 URL 以接收刷新令牌，或使用 https://login.salesforce.com/services/oauth2/success 或 https://test.salesforce.com/services/oauth2/success 的内置回调进行配置，然后从流末尾的 URL 中重试 refresh_token。请注意，在开发组织中，Salesforce 允许在 localhost 处托管回调 Web 应用程序。

字符串

sslContextParameters (security)

要使用的 SSL 参数，请参阅所有可用选项的 SSLContextParameters 类。

SSLContextParameters

useGlobalSslContextParameters (security)

启用使用全局 SSL 上下文参数。

false

布尔值

用户名 (security)

OAuth 流中使用的用户名，以获取对访问令牌的访问权限。使用密码 OAuth 流很容易，但通常应该避免它，因为它被视为不如其他流的安全性。

字符串