46.3. 端点选项

operationName (producer)

要使用的操作。

Enum 值：

OperationName

topicName (consumer)

要使用的主题/通道的名称。

字符串

apexMethod (common)

APEX 方法名称。

字符串

apexQueryParams (common)

查询参数 APEX 方法。

map

apiVersion (common)

Salesforce API 版本.

53.0

字符串

backoffIncrement (common)

backoff 间隔递增，用于流连接重启尝试超过 CometD auto-reconnect 失败。

1000

long

batchId (common)

批量 API 批处理 ID.

字符串

ContentType (common)

批量 API 内容类型，其中一个 XML、CSV、ZZ_XML、ZZ_CSV。

Enum 值：

ContentType

defaultReplayId (common)

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

-1

Long

fallBackReplayId (common)

ReplayId 在无效 Replay Id 响应后回退到。

-1

Long

格式 (common)

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

Enum 值：

PayloadFormat

httpclient ( common)

自定义 Jetty Http Client 用于连接到 Salesforce。

SalesforceHttpClient

includeDetails (common)

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

布尔值

initialReplayIdMap (common)

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

map

InstanceID (common)

Salesforce1 分析报告执行实例 ID.

字符串

jobId (common)

批量 API 作业 ID。

字符串

限制 （通用）

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

整数

定位器 (common)

assumes Bulk 2.0 API 提供的定位器，用于获取查询作业的结果。

字符串

maxBackoff (common)

与 CometD auto-reconnect 之外的失败流连接重启尝试的最大 backoff 间隔。

30000

long

maxRecords (common)

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

整数

notFoundBehaviour (common)

设置从 Salesforce API 收到的 404 尚未找到的状态。如果正文设置为 NULL NotFoundBehaviour#NULL，或者应在 Exchange NotFoundBehaviour#EXCEPTION 上发送一个例外。

Enum 值：

例外

NotFoundBehaviour

notifyForFields (common)

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

Enum 值：

NotifyForFieldsEnum

notifyForOperationCreate (common)

notify for create operation，默认为 false (API version = 29.0)。

布尔值

notifyForOperationDelete (common)

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

布尔值

notifyForOperations (common)

通知操作，选项为 ALL、CREATE、EXTENDED、UPDATE (API 版本 29.0)。

Enum 值：

NotifyForOperationsEnum

notifyForOperationUndelete (common)

notify for un-delete 操作，默认为 false (API 版本 = 29.0)。

布尔值

notifyForOperationUpdate (common)

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

布尔值

objectMapper (common)

自定义 Jackson ObjectMapper，用于序列化/反序列化 Salesforce 对象。

ObjectMapper

pkChunking (common)

使用 PK Chunking。仅用于原始 Bulk API。如有必要，批量 2.0 API 会自动执行 PK 块。

布尔值

pkChunkingChunkSize (common)

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

整数

pkChunkingParent (common)

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

字符串

pkChunkingStartRow (common)

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

字符串

queryLocator (common)

当查询结果超过一个调用中检索记录时，查询为使用查询器提供的查询定位器。在后续调用中使用这个值来检索其他记录。

字符串

rawPayload (common)

使用原始有效负载字符串作为请求和响应（默认情况下，JSON 或 XML 取决于格式），而不是 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)

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

false

布尔值

bridgeErrorHandler (consumer)

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

false

布尔值

replayId (consumer)

订阅时要使用的 replayId 值。

Long

exceptionHandler （消费者）

要让使用者使用自定义例外处理程序：请注意，如果启用了 bridgeErrorHandler 选项，则此选项不在使用。默认情况下，使用者将处理异常，其记录在 WARN 或 ERROR 级别中，并忽略。

ExceptionHandler

ExchangePattern （消费者）

在消费者创建交换时设置交换模式。

Enum 值：

ExchangePattern

allOrNone (producer)

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

false

布尔值

apexUrl (producer)

APEX 方法 URL。

字符串

compositeMethod (producer)

复合（原始）方法。

字符串

lazyStartProducer (producer)

制作者是否应启动 lazy （在第一个消息中）。通过启动 lazy，您可以使用此选项来允许 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 值，因为这将自动执行。

字符串