42.2. 组件选项

apexMethod (common)

APEX 方法名称。

字符串

apexQueryParams (common)

查询参数（P APEX 方法）。

map

apiVersion (common)

Salesforce API 版本。

53.0

字符串

backoffIncrement (common)

backoff 间隔递增，流连接重启尝试超过 CometD 自动连接尝试。

1000

long

batchId (common)

批量 API 批处理 ID.

字符串

contentType (common)

批量 API 内容类型，XML、CSV、ZIP_XML、ZIP_CSV。

枚举值：

ContentType

defaultReplayId (common)

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

-1

Long

fallBackReplayId (common)

ReplayId 在 Invalid Replay Id 响应后回退。

-1

Long

format (common)

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

枚举值：

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 Analytics 报告中包含详情，默认为 false。

布尔值

initialReplayIdMap (common)

重播 ID，从每个频道名称启动。

map

instanceId (common)

Salesforce1 分析报告执行实例 ID。

字符串

jobId (common)

批量 API 作业 ID。

字符串

limit (common)

返回记录的限值。适用于一些 API，请查看 Salesforce 文档。

整数

locator (common)

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

字符串

maxBackoff (common)

在 CometD 自动连接失败之外，流连接重启尝试的最大 backoff 间隔。

30000

long

maxRecords (common)

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

整数

notFoundBehaviour (common)

设置来自 Salesforce API 的 404 未找到状态的行为。正文应设置为 NULL NotFoundBehaviour#NULL，或在交换 NotFoundBehaviour#EXTION 上发出一个异常。

枚举值：

例外

NotFoundBehaviour

notifyForFields (common)

通知字段，选项为 ALL、REFERENCED、SELECT、WHERE。

枚举值：

NotifyForFieldsEnum

notifyForOperationCreate (common)

通知创建操作，默认为 false（API 版本 = 29.0）。

布尔值

notifyForOperationDelete (common)

通知删除操作，默认为 false（API 版本 = 29.0）。

布尔值

notifyForOperations (common)

通知操作，选项为 ALL、I CREATE、EXTENDED、UPDATE（API 版本 29.0）。

枚举值：

NotifyForOperationsEnum

notifyForOperationUndelete (common)

为 un-delete 操作通知，默认为 false（API 版本 = 29.0）。

布尔值

notifyForOperationUpdate (common)

通知更新操作，默认为 false（API 版本 = 29.0）。

布尔值

objectMapper (common)

自定义 Jackson ObjectMapper，以在以串行方式处理 Salesforce 对象时使用。

ObjectMapper

packages (common)

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

字符串

pkChunking (common)

使用 PK Chunking。只在原始 Bulk API 中使用。必要时，批量 2.0 API 会自动执行 PK 块。

布尔值

pkChunkingChunkSize (common)

与 PK Chunking 搭配使用的块大小。如果未指定，DUPD 的默认值为 100,000。最大大小为 250,000。

整数

pkChunkingParent (common)

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

字符串

pkChunkingStartRow (common)

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

字符串

queryLocator (common)

当查询结果超过单个调用中检索结果时，由 salesforce 提供的查询查找器以供使用。在随后的调用中使用这个值来检索其他记录。

字符串

rawPayload (common)

将原始有效负载字符串用于请求和响应（根据格式的 JSON 或 XML），默认情况下为 DTOs 而不是 DTOs。

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)

如果 API 需要或支持，则 SObject 名称。

字符串

sObjectQuery (common)

Salesforce SOQL 查询字符串。

字符串

sObjectSearch (common)

Salesforce SOSL 搜索字符串。

字符串

updateTopic (common)

在使用流 API 时是否更新现有 Push Topic，默认为 false。

false

布尔值

config (common (advanced))

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

SalesforceEndpointConfig

httpClientProperties (common (advanced))

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

map

longPollingTransportProperties (common (advanced))

用于设置可由流传输 api 使用的 BayeuxClient(CometD)在 LongPollingTransport 上配置的任何属性。

map

workerPoolMaxSize (common (advanced))

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

20

int

workerPoolSize (common (advanced))

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

10

int

bridgeErrorHandler (consumer)

允许将消费者桥接到 Camel 路由 Error Handler，这意味着在消费者尝试获取传入的消息时发生任何异常，或像这样一样处理，消息现在将被作为消息进行处理，并由路由 Error Handler 处理。默认情况下，使用者将使用 org.apache.camel.spi.ExceptionHandler 处理异常，该处理程序将记录在 WARN 或 ERROR 级别并忽略。

false

布尔值

allOrNone (producer)

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

false

布尔值

apexUrl (producer)

APEX 方法 URL。

字符串

compositeMethod (producer)

复合（原始）方法。

字符串

lazyStartProducer (producer)

制作者是否应该启动 lazy（在第一个消息上）。通过启动 lazy，您可以使用它来允许 CamelContext 和路由在启动期间启动，否则在启动期间出现问题，并导致路由启动失败。通过将这个启动延迟到 lazy 后，可以在通过 Camel 的路由错误处理程序路由消息期间处理启动失败。注意在处理第一个消息时，创建并启动制作者可能花费较少的时间，从而延长处理的总处理时间。

false

布尔值

rawHttpHeaders (producer)

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

字符串

rawMethod (producer)

用于 Raw 操作的 HTTP 方法。

字符串

rawPath (producer)

域名后端点 URL 的部分。例如，'/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 组件可自动按验证方法从属性集使用，设置此属性以消除这种不确定性。

枚举值：

AuthenticationType

clientId (security)

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

字符串

clientSecret (security)

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

字符串

httpProxyAuthUri (security)

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

字符串

httpProxyPassword (security)

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

字符串

httpProxyRealm (security)

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

字符串

httpProxySecure (security)

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

true

布尔值

httpProxyUseDigestAuth (security)

如果设置为 true Digest 身份验证，则在对 HTTP 代理进行身份验证时使用，则将使用 Basic 授权方法。

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

布尔值

loginConfig (security)

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

SalesforceLoginConfig

loginUrl (security)

用于身份验证的 Salesforce 实例 所需的 URL 默认设置为。

字符串

密码 （安全性）

OAuth 流中使用的密码获取访问令牌的访问权限。从密码 OAuth 流中易于启动，但一般应该避免，因为与其他流程相比安全性较低。如果使用一个密码，请确保将安全令牌附加到密码的末尾。

字符串

refreshToken (security)

刷新令牌已在刷新令牌 OAuth 流中获取。需要一个设置 web 应用并配置回调 URL 以接收刷新令牌，或使用内置的回调（位于 ）进行配置，然后从流末尾的 URL 重新检索 refresh_token。请注意，在开发机构中，Salesforce 允许在 localhost 上托管回调 Web 应用程序。

字符串

sslContextParameters (security)

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

SSLContextParameters

useGlobalSslContextParameters (security)

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

false

布尔值

userName (security)

OAuth 流中使用的用户名以获取访问令牌的访问权限。从密码 OAuth 流中易于启动，但一般应该避免，因为与其他流程相比安全性较低。

字符串