54.3. 端点选项


Salesforce 端点使用 URI 语法进行配置:

salesforce:operationName:topicName

使用以下路径和查询参数:

54.3.1. 路径参数(2 参数)

Name描述默认值类型

operationName (producer)

要使用的操作。

Enum 值:

  • getVersions
  • getResources
  • getGlobalObjects
  • getBasicInfo
  • getDescription
  • getSObject
  • createSObject
  • updateSObject
  • deleteSObject
  • getSObjectWithId
  • upsertSObject
  • deleteSObjectWithId
  • getBlobField
  • query
  • queryMore
  • queryAll
  • search
  • apexCall
  • recent
  • createJob
  • getJob
  • closeJob
  • abortJob
  • createBatch
  • getBatch
  • getAllBatches
  • getRequest
  • getResults
  • createBatchQuery
  • getQueryResultIds
  • getQueryResult
  • getRecentReports
  • getReportDescription
  • executeSyncReport
  • executeAsyncReport
  • getReportInstances
  • getReportResults
  • limits
  • 批准
  • 批准
  • composite-tree
  • comp-batch
  • 复合
  • compositeRetrieveSObjectCollections
  • compositeCreateSObjectCollections
  • compositeUpdateSObjectCollections
  • compositeUpsertSObjectCollections
  • compositeDeleteSObjectCollections
  • bulk2GetAllJobs
  • bulk2CreateJob
  • bulk2GetJob
  • bulk2CreateBatch
  • bulk2CloseJob
  • bulk2AbortJob
  • bulk2DeleteJob
  • bulk2GetSuccessfulResults
  • bulk2GetFailedResults
  • bulk2GetUnprocessedRecords
  • bulk2CreateQueryJob
  • bulk2GetQueryJob
  • bulk2GetAllQueryJobs
  • bulk2GetQueryJobResults
  • bulk2AbortQueryJob
  • bulk2DeleteQueryJob
  • raw
 

OperationName

topicName (consumer)

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

 

字符串

54.3.2. 查询参数(57 参数)

Name描述默认值类型

apexMethod (common)

APEX 方法名称。

 

字符串

apexQueryParams (common)

查询 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。

Enum 值:

  • XML
  • CSV
  • JSON
  • ZIP_XML
  • ZIP_CSV
  • ZIP_JSON
 

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 值:

  • JSON
  • XML
 

PayloadFormat

httpClient (common)

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

 

SalesforceHttpClient

includeDetails (common)

在 Salesforce1 Analytics 报告中包含详细信息,默认为 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)

流连接重启尝试超过 CometD 自动连接的最大 backoff 间隔。

30000

long

maxRecords (common)

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

 

整数

notFoundBehaviour (common)

设置从 Salesforce API 接收的 404 not found 状态的行为。应将正文设置为 NULL NotFoundBehaviourHQNULL,或在交换 NotFoundBehaviour EXCEPTION 上发出一个异常信号 - 默认。

Enum 值:

  • 例外
  • NULL

例外

NotFoundBehaviour

notifyForFields (common)

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

Enum 值:

  • ALL
  • 引用
  • 选择
  • 其中
 

NotifyForFieldsEnum

notifyForOperationCreate (common)

通知创建操作,默认为 false (API 版本 = 29.0)。

 

布尔值

notifyForOperationDelete (common)

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

 

布尔值

notifyForOperations (common)

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

Enum 值:

  • ALL
  • 创建
  • EXTENDED
  • 更新
 

NotifyForOperationsEnum

notifyForOperationUndelete (common)

通知未删除操作,默认为 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 的块大小。如果未指定,则 Salesforce 默认为 100,000。最大大小为 250,000。

 

整数

pkChunkingParent (common)

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

 

字符串

pkChunkingStartRow (common)

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

 

字符串

queryLocator (common)

当查询结果超过单个调用中检索的记录时,查询 Locator 以供使用。在后续调用中使用这个值来检索其他记录。

 

字符串

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)

API 需要或支持 SObject 名称。

 

字符串

sObjectQuery (common)

Salesforce SOQL 查询字符串。

 

字符串

sObjectSearch (common)

Salesforce SOSL 搜索字符串。

 

字符串

updateTopic (common)

在使用流 API 时是否更新现有的 Push 主题,默认为 false。

false

布尔值

bridgeErrorHandler (consumer)

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

false

布尔值

replayId (consumer)

订阅时要使用的 replayId 值。

 

Long

exceptionHandler (consumer (advanced))

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

 

ExceptionHandler

exchangePattern (consumer (advanced))

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

Enum 值:

  • InOnly
  • InOut
  • InOptionalOut
 

ExchangePattern

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 部分。例如,'/services/data/v52.0/sobjects/Account/'。

 

字符串

rawQueryParameters (producer)

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

 

字符串

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.