This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 42d07a89317c CAMEL-24340: camel-salesforce - improve option and header
documentation
42d07a89317c is described below
commit 42d07a89317cab3828a86783f4399bdd08e6da7f
Author: Stanislav Deviatov <[email protected]>
AuthorDate: Tue Aug 4 13:45:25 2026 +0200
CAMEL-24340: camel-salesforce - improve option and header documentation
Fix misleading apexMethod description that said "APEX method name" when the
value is actually used as the HTTP verb. Improve descriptions for apexUrl,
jobId, batchId, resultId, pubSubHost, pubSubPort, and 15 Streaming API /
Change Data Capture headers that previously used bare "The <name>."
templates.
Documentation only — no behaviour change.
Closes #25323
Co-authored-by: Claude Opus 5 <[email protected]>
---
.../camel/catalog/components/salesforce.json | 54 +++++-----
.../camel/component/salesforce/salesforce.json | 54 +++++-----
.../component/salesforce/SalesforceComponent.java | 6 +-
.../component/salesforce/SalesforceConstants.java | 76 ++++++++++---
.../salesforce/SalesforceEndpointConfig.java | 20 ++--
.../dsl/SalesforceComponentBuilderFactory.java | 35 ++++--
.../dsl/SalesforceEndpointBuilderFactory.java | 117 ++++++++++++++++-----
7 files changed, 250 insertions(+), 112 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/salesforce.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/salesforce.json
index 5fffa6528946..564b84936c27 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/salesforce.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/salesforce.json
@@ -25,11 +25,11 @@
"verifiers": "parameters,connectivity"
},
"componentProperties": {
- "apexMethod": { "index": 0, "kind": "property", "displayName": "Apex
Method", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "APEX method name" },
+ "apexMethod": { "index": 0, "kind": "property", "displayName": "Apex
Method", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "GET", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "HTTP verb used for the Apex
REST invocation, such as GET, POST, PUT, PATCH or DELETE. Applie [...]
"apexQueryParams": { "index": 1, "kind": "property", "displayName": "Apex
Query Params", "group": "common", "label": "", "required": false, "type":
"object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Query params for APEX method" },
"apiVersion": { "index": 2, "kind": "property", "displayName": "Api
Version", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "56.0", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Salesforce API version." },
"backoffIncrement": { "index": 3, "kind": "property", "displayName":
"Backoff Increment", "group": "common", "label": "", "required": false, "type":
"duration", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "1000", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Backoff interval increment for
Streaming connection restart attempts for failures beyond [...]
- "batchId": { "index": 4, "kind": "property", "displayName": "Batch Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Bulk API Batch ID" },
+ "batchId": { "index": 4, "kind": "property", "displayName": "Batch Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Identifies a batch within a
Bulk API v1 job. Required by getBatch, getRequest, getResults,
getQueryResultIds and getQuery [...]
"contentType": { "index": 5, "kind": "property", "displayName": "Content
Type", "group": "common", "label": "", "required": false, "type": "enum",
"javaType": "org.apache.camel.component.salesforce.api.dto.bulk.ContentType",
"enum": [ "XML", "CSV", "JSON", "ZIP_XML", "ZIP_CSV", "ZIP_JSON" ],
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "B [...]
"defaultReplayId": { "index": 6, "kind": "property", "displayName":
"Default Replay Id", "group": "common", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Long", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": -1, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Default replayId setting if no
value is found in initialReplayIdMap" },
"fallBackReplayId": { "index": 7, "kind": "property", "displayName": "Fall
Back Replay Id", "group": "common", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Long", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": -1, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "ReplayId to fall back to after
an Invalid Replay Id response" },
@@ -43,7 +43,7 @@
"includeDetails": { "index": 15, "kind": "property", "displayName":
"Include Details", "group": "common", "label": "", "required": false, "type":
"boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Include details in Salesforce1
Analytics report, defaults to false." },
"initialReplayIdMap": { "index": 16, "kind": "property", "displayName":
"Initial Replay Id Map", "group": "common", "label": "", "required": false,
"type": "object", "javaType": "java.util.Map<java.lang.String,
java.lang.Long>", "deprecated": false, "autowired": false, "secret": false,
"configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Replay IDs to start from per
channel name." },
"instanceId": { "index": 17, "kind": "property", "displayName": "Instance
Id", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Salesforce1 Analytics report
execution instance ID" },
- "jobId": { "index": 18, "kind": "property", "displayName": "Job Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Bulk API Job ID" },
+ "jobId": { "index": 18, "kind": "property", "displayName": "Job Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Identifies the Bulk API job to
act on, for Bulk API v1 operations such as getJob, closeJob, abortJob,
createBatch and getRes [...]
"limit": { "index": 19, "kind": "property", "displayName": "Limit",
"group": "common", "label": "", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Limit on number of returned
records. Applicable to some of the API, check the Salesforce documentation." },
"locator": { "index": 20, "kind": "property", "displayName": "Locator",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Locator provided by salesforce
Bulk 2.0 API for use in getting results for a Query job." },
"maxBackoff": { "index": 21, "kind": "property", "displayName": "Max
Backoff", "group": "common", "label": "", "required": false, "type":
"duration", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "30000", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Maximum backoff interval for
Streaming connection restart attempts for failures beyond CometD auto- [...]
@@ -65,7 +65,7 @@
"rawPayload": { "index": 37, "kind": "property", "displayName": "Raw
Payload", "group": "common", "label": "", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Use raw payload String for
request and response (either JSON or XML depending on format), instead o [...]
"reportId": { "index": 38, "kind": "property", "displayName": "Report Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Salesforce1 Analytics report
Id" },
"reportMetadata": { "index": 39, "kind": "property", "displayName":
"Report Metadata", "group": "common", "label": "", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata",
"deprecated": false, "autowired": false, "secret": false,
"configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Salesforce1 Analytics report
metadata for fi [...]
- "resultId": { "index": 40, "kind": "property", "displayName": "Result Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Bulk API Result ID" },
+ "resultId": { "index": 40, "kind": "property", "displayName": "Result Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Identifies one result set of a
completed Bulk API v1 query batch, as returned by the getQueryResultIds
operation. Used [...]
"sObjectBlobFieldName": { "index": 41, "kind": "property", "displayName":
"SObject Blob Field Name", "group": "common", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "SObject blob field name" },
"sObjectClass": { "index": 42, "kind": "property", "displayName": "SObject
Class", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Fully qualified SObject class
name, usually generated using camel-salesforce-maven-plugin" },
"sObjectFields": { "index": 43, "kind": "property", "displayName":
"SObject Fields", "group": "common", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "SObject fields to retrieve" },
@@ -94,7 +94,7 @@
"consumerWorkerPoolSize": { "index": 66, "kind": "property",
"displayName": "Consumer Worker Pool Size", "group": "consumer (advanced)",
"label": "consumer,advanced", "required": false, "type": "integer", "javaType":
"int", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 10, "description": "Core thread pool size size for consumer
worker pool." },
"initialReplyIdTimeout": { "index": 67, "kind": "property", "displayName":
"Initial Reply Id Timeout", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": 30,
"description": "Timeout in seconds to validate when a custom pubSubReplayId has
been configured, when starting the Camel Salesforce consumer." },
"allOrNone": { "index": 68, "kind": "property", "displayName": "All Or
None", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Composite API option to
indicate to rollback all records if any are not successful." },
- "apexUrl": { "index": 69, "kind": "property", "displayName": "Apex Url",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "APEX method URL" },
+ "apexUrl": { "index": 69, "kind": "property", "displayName": "Apex Url",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Path of the Apex REST resource
to invoke, appended to \/services\/apexrest\/ on the instance URL, for example
[...]
"compositeMethod": { "index": 70, "kind": "property", "displayName":
"Composite Method", "group": "producer", "label": "producer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Composite (raw) method." },
"eventName": { "index": 71, "kind": "property", "displayName": "Event
Name", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Name of Platform Event, Change
Data Capture Event, custom event, etc." },
"eventSchemaFormat": { "index": 72, "kind": "property", "displayName":
"Event Schema Format", "group": "producer", "label": "producer", "required":
false, "type": "enum", "javaType":
"org.apache.camel.component.salesforce.internal.dto.EventSchemaFormatEnum",
"enum": [ "EXPANDED", "COMPACT" ], "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": " [...]
@@ -127,8 +127,8 @@
"loginConfig": { "index": 99, "kind": "property", "displayName": "Login
Config", "group": "security", "label": "common,security", "required": false,
"type": "object", "javaType":
"org.apache.camel.component.salesforce.SalesforceLoginConfig", "deprecated":
false, "autowired": false, "secret": false, "description": "All authentication
configuration in one nested bean, all properties set there can be set directly
on the component as well" },
"loginUrl": { "index": 100, "kind": "property", "displayName": "Login
Url", "group": "security", "label": "common,security", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue":
"https:\/\/login.salesforce.com", "description": "URL of the Salesforce
instance used for authentication, by default set to
https:\/\/login.salesforce.com" },
"password": { "index": 101, "kind": "property", "displayName": "Password",
"group": "security", "label": "common,security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "Password used in
OAuth flow to gain access to access token. It's easy to get started with
password OAuth flow, but in general one should avoid it as it is deemed less
secure than other flows. Make sur [...]
- "pubSubHost": { "index": 102, "kind": "property", "displayName": "Pub Sub
Host", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue":
"api.pubsub.salesforce.com", "description": "Pub\/Sub host" },
- "pubSubPort": { "index": 103, "kind": "property", "displayName": "Pub Sub
Port", "group": "security", "label": "common,security", "required": false,
"type": "integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 7443, "description": "Pub\/Sub port" },
+ "pubSubHost": { "index": 102, "kind": "property", "displayName": "Pub Sub
Host", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue":
"api.pubsub.salesforce.com", "description": "Host name of the Salesforce
Pub\/Sub API gRPC service used by the pubSubSubscribe and pubSubPublish
operations. Give a bare host name, without scheme or port." },
+ "pubSubPort": { "index": 103, "kind": "property", "displayName": "Pub Sub
Port", "group": "security", "label": "common,security", "required": false,
"type": "integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 7443, "description": "TCP port of the
Salesforce Pub\/Sub API gRPC service used by the pubSubSubscribe and
pubSubPublish operations." },
"refreshToken": { "index": 104, "kind": "property", "displayName":
"Refresh Token", "group": "security", "label": "common,security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description":
"Refresh token already obtained in the refresh token OAuth flow. One needs to
setup a web application and configure a callback URL to receive the refresh
token, or configure using the builtin [...]
"sslContextParameters": { "index": 105, "kind": "property", "displayName":
"Ssl Context Parameters", "group": "security", "label": "common,security",
"required": false, "type": "object", "javaType":
"org.apache.camel.support.jsse.SSLContextParameters", "deprecated": false,
"autowired": false, "secret": false, "description": "SSL parameters to use, see
SSLContextParameters class for all available options." },
"useGlobalSslContextParameters": { "index": 106, "kind": "property",
"displayName": "Use Global Ssl Context Parameters", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Enable usage of global SSL context
parameters" },
@@ -138,22 +138,22 @@
"CamelSalesforceReplayId": { "index": 0, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"Object", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The Streaming API replayId.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_REPLAY_ID"
},
"CamelSalesforceEventUuid": { "index": 1, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"Object", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The Streaming API eventUuid.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_EVENT_UUID"
},
"CamelSalesforceChangeEventSchema": { "index": 2, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The change event schema.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_EVENT_SCHEMA"
},
- "CamelSalesforceEventType": { "index": 3, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The event type.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_EVENT_TYPE"
},
- "CamelSalesforceCommitTimestamp": { "index": 4, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The commit timestamp.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_TIMESTAMP"
},
- "CamelSalesforceCommitUser": { "index": 5, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The commit user.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_USER"
},
- "CamelSalesforceCommitNumber": { "index": 6, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The commit number.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_NUMBER"
},
- "CamelSalesforceRecordIds": { "index": 7, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"Object", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The record ids.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_RECORD_IDS"
},
- "CamelSalesforceChangeType": { "index": 8, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The change type.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_TYPE"
},
- "CamelSalesforceChangeOrigin": { "index": 9, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The change origin.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_ORIGIN"
},
- "CamelSalesforceTransactionKey": { "index": 10, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The transaction key.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_TRANSACTION_KEY"
},
- "CamelSalesforceSequenceNumber": { "index": 11, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The sequence number.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_SEQUENCE_NUMBER"
},
- "CamelSalesforceIsTransactionEnd": { "index": 12, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Is transaction end.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_IS_TRANSACTION_END"
},
- "CamelSalesforceEntityName": { "index": 13, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The entity name.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_ENTITY_NAME"
},
+ "CamelSalesforceEventType": { "index": 3, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "For change and platform events, the last
segment of the configured topic name, such as AccountChangeEvent. For PushTopic
messages, the Salesforce event type of the notification, such as created.",
"constantName": "org.apache.came [...]
+ "CamelSalesforceCommitTimestamp": { "index": 4, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Time of the Salesforce transaction that
produced the change event, from the ChangeEventHeader.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_TIMESTAMP"
},
+ "CamelSalesforceCommitUser": { "index": 5, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Id of the Salesforce user whose
transaction produced the change event, from the ChangeEventHeader.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_USER"
},
+ "CamelSalesforceCommitNumber": { "index": 6, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "System change number of the Salesforce
transaction that produced the change event, from the ChangeEventHeader.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_NUMBER"
},
+ "CamelSalesforceRecordIds": { "index": 7, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"Object", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "Ids of the records affected by the change
event, from the ChangeEventHeader. Holds more than one id when a single
transaction changed several records.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#H [...]
+ "CamelSalesforceChangeType": { "index": 8, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Kind of change carried by the change
event, from the ChangeEventHeader, for example CREATE or UPDATE.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_TYPE"
},
+ "CamelSalesforceChangeOrigin": { "index": 9, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Identifies the Salesforce API and
client that made the change, from the ChangeEventHeader.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_ORIGIN"
},
+ "CamelSalesforceTransactionKey": { "index": 10, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Key shared by every change event
produced by the same Salesforce transaction, from the ChangeEventHeader. Use it
to group events that belong to one transaction.", "constantName":
"org.apache.camel.component.salesforce.Sales [...]
+ "CamelSalesforceSequenceNumber": { "index": 11, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Position of this change event within
its Salesforce transaction, from the ChangeEventHeader.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_SEQUENCE_NUMBER"
},
+ "CamelSalesforceIsTransactionEnd": { "index": 12, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "True when this change event is the last
one of its Salesforce transaction, from the ChangeEventHeader. Use it together
with CamelSalesforceTransactionKey to detect the end of a transaction.",
"constantName": "org.apache.c [...]
+ "CamelSalesforceEntityName": { "index": 13, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Name of the Salesforce object the
change event applies to, such as Account, from the ChangeEventHeader.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_ENTITY_NAME"
},
"CamelSalesforcePlatformEventSchema": { "index": 14, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The platform event schema.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_PLATFORM_EVENT_SCHEMA"
},
- "CamelSalesforceCreatedDate": { "index": 15, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "java.time.ZonedDateTime", "deprecated": false, "deprecationNote":
"", "autowired": false, "secret": false, "description": "The created date.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CREATED_DATE"
},
- "CamelSalesforceTopicName": { "index": 16, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The topic name.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_TOPIC_NAME"
},
- "CamelSalesforceChannel": { "index": 17, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The channel.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANNEL"
},
- "CamelSalesforceClientId": { "index": 18, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The client id.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CLIENT_ID"
},
+ "CamelSalesforceCreatedDate": { "index": 15, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "java.time.ZonedDateTime", "deprecated": false, "deprecationNote":
"", "autowired": false, "secret": false, "description": "Creation time of the
event. Platform events supply a ZonedDateTime taken from the event payload,
while PushTopic notifications supply the raw createdDate value as a String.",
"constantName": "org.apache.camel. [...]
+ "CamelSalesforceTopicName": { "index": 16, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Name of the PushTopic the message was
received from. Set for PushTopic messages only.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_TOPIC_NAME"
},
+ "CamelSalesforceChannel": { "index": 17, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "Streaming API channel the message was received
on, such as \/topic\/MyTopic or \/data\/AccountChangeEvent.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANNEL"
},
+ "CamelSalesforceClientId": { "index": 18, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "Client id of the Streaming API subscription
that received the message. Set only when the server supplies one.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CLIENT_ID"
},
"CamelSalesforcePubSubReplayId": { "index": 19, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The Pub\/Sub API replayId.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_PUBSUB_REPLAY_ID"
},
"CamelSalesforcePubSubEventId": { "index": 20, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The Pub\/Sub API event id.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_PUBSUB_EVENT_ID"
},
"CamelSalesforcePubSubRpcId": { "index": 21, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The Pub\/Sub API rpc id.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_PUBSUB_RPC_ID"
},
@@ -162,11 +162,11 @@
"properties": {
"operationName": { "index": 0, "kind": "path", "displayName": "Operation
Name", "group": "common", "label": "common", "required": true, "type": "enum",
"javaType": "org.apache.camel.component.salesforce.internal.OperationName",
"enum": [ "getVersions", "getResources", "getGlobalObjects", "getBasicInfo",
"getDescription", "getSObject", "createSObject", "updateSObject",
"deleteSObject", "getSObjectWithId", "upsertSObject", "deleteSObjectWithId",
"getBlobField", "query", "queryMore", "q [...]
"topicName": { "index": 1, "kind": "path", "displayName": "Topic Name",
"group": "producer", "label": "consumer,producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The name of the topic\/channel to use"
},
- "apexMethod": { "index": 2, "kind": "parameter", "displayName": "Apex
Method", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "APEX method name" },
+ "apexMethod": { "index": 2, "kind": "parameter", "displayName": "Apex
Method", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "GET", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "HTTP verb used for the
Apex REST invocation, such as GET, POST, PUT, PATCH or DELETE [...]
"apexQueryParams": { "index": 3, "kind": "parameter", "displayName": "Apex
Query Params", "group": "common", "label": "", "required": false, "type":
"object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Query params for APEX
method" },
"apiVersion": { "index": 4, "kind": "parameter", "displayName": "Api
Version", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "56.0", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Salesforce API version."
},
"backoffIncrement": { "index": 5, "kind": "parameter", "displayName":
"Backoff Increment", "group": "common", "label": "", "required": false, "type":
"duration", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "1000", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Backoff interval
increment for Streaming connection restart attempts for failures [...]
- "batchId": { "index": 6, "kind": "parameter", "displayName": "Batch Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Bulk API Batch ID" },
+ "batchId": { "index": 6, "kind": "parameter", "displayName": "Batch Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Identifies a batch
within a Bulk API v1 job. Required by getBatch, getRequest, getResults,
getQueryResultIds and [...]
"contentType": { "index": 7, "kind": "parameter", "displayName": "Content
Type", "group": "common", "label": "", "required": false, "type": "enum",
"javaType": "org.apache.camel.component.salesforce.api.dto.bulk.ContentType",
"enum": [ "XML", "CSV", "JSON", "ZIP_XML", "ZIP_CSV", "ZIP_JSON" ],
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "descript [...]
"defaultReplayId": { "index": 8, "kind": "parameter", "displayName":
"Default Replay Id", "group": "common", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Long", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": -1, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Default replayId setting
if no value is found in initialReplayIdMap" },
"fallBackReplayId": { "index": 9, "kind": "parameter", "displayName":
"Fall Back Replay Id", "group": "common", "label": "", "required": false,
"type": "integer", "javaType": "java.lang.Long", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": -1, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "ReplayId to fall back to
after an Invalid Replay Id response" },
@@ -175,7 +175,7 @@
"includeDetails": { "index": 12, "kind": "parameter", "displayName":
"Include Details", "group": "common", "label": "", "required": false, "type":
"boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Include details in
Salesforce1 Analytics report, defaults to false." },
"initialReplayIdMap": { "index": 13, "kind": "parameter", "displayName":
"Initial Replay Id Map", "group": "common", "label": "", "required": false,
"type": "object", "javaType": "java.util.Map<java.lang.String,
java.lang.Long>", "deprecated": false, "autowired": false, "secret": false,
"configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Replay IDs to start from
per channel name." },
"instanceId": { "index": 14, "kind": "parameter", "displayName": "Instance
Id", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Salesforce1 Analytics
report execution instance ID" },
- "jobId": { "index": 15, "kind": "parameter", "displayName": "Job Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Bulk API Job ID" },
+ "jobId": { "index": 15, "kind": "parameter", "displayName": "Job Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Identifies the Bulk API
job to act on, for Bulk API v1 operations such as getJob, closeJob, abortJob,
createBatch an [...]
"limit": { "index": 16, "kind": "parameter", "displayName": "Limit",
"group": "common", "label": "", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Limit on number of
returned records. Applicable to some of the API, check the Salesforce
documentation." },
"locator": { "index": 17, "kind": "parameter", "displayName": "Locator",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Locator provided by
salesforce Bulk 2.0 API for use in getting results for a Query job." },
"maxBackoff": { "index": 18, "kind": "parameter", "displayName": "Max
Backoff", "group": "common", "label": "", "required": false, "type":
"duration", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "30000", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Maximum backoff interval
for Streaming connection restart attempts for failures beyond Come [...]
@@ -196,7 +196,7 @@
"rawPayload": { "index": 33, "kind": "parameter", "displayName": "Raw
Payload", "group": "common", "label": "", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Use raw payload String
for request and response (either JSON or XML depending on format), i [...]
"reportId": { "index": 34, "kind": "parameter", "displayName": "Report
Id", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Salesforce1 Analytics
report Id" },
"reportMetadata": { "index": 35, "kind": "parameter", "displayName":
"Report Metadata", "group": "common", "label": "", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata",
"deprecated": false, "autowired": false, "secret": false,
"configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Salesforce1 Analytics
report metadat [...]
- "resultId": { "index": 36, "kind": "parameter", "displayName": "Result
Id", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Bulk API Result ID" },
+ "resultId": { "index": 36, "kind": "parameter", "displayName": "Result
Id", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Identifies one result
set of a completed Bulk API v1 query batch, as returned by the
getQueryResultIds operati [...]
"sObjectBlobFieldName": { "index": 37, "kind": "parameter", "displayName":
"SObject Blob Field Name", "group": "common", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "SObject blob field name"
},
"sObjectClass": { "index": 38, "kind": "parameter", "displayName":
"SObject Class", "group": "common", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Fully qualified SObject
class name, usually generated using camel-salesforce-maven-plugin" },
"sObjectFields": { "index": 39, "kind": "parameter", "displayName":
"SObject Fields", "group": "common", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "SObject fields to
retrieve" },
@@ -223,7 +223,7 @@
"exceptionHandler": { "index": 60, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By de [...]
"exchangePattern": { "index": 61, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "enum", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
"allOrNone": { "index": 62, "kind": "parameter", "displayName": "All Or
None", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Composite API option to
indicate to rollback all records if any are not successful." },
- "apexUrl": { "index": 63, "kind": "parameter", "displayName": "Apex Url",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "APEX method URL" },
+ "apexUrl": { "index": 63, "kind": "parameter", "displayName": "Apex Url",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Path of the Apex REST
resource to invoke, appended to \/services\/apexrest\/ on the instance URL, for
[...]
"compositeMethod": { "index": 64, "kind": "parameter", "displayName":
"Composite Method", "group": "producer", "label": "producer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Composite (raw) method."
},
"eventName": { "index": 65, "kind": "parameter", "displayName": "Event
Name", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Name of Platform Event,
Change Data Capture Event, custom event, etc." },
"eventSchemaFormat": { "index": 66, "kind": "parameter", "displayName":
"Event Schema Format", "group": "producer", "label": "producer", "required":
false, "type": "enum", "javaType":
"org.apache.camel.component.salesforce.internal.dto.EventSchemaFormatEnum",
"enum": [ "EXPANDED", "COMPACT" ], "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "descrip [...]
diff --git
a/components/camel-salesforce/camel-salesforce-component/src/generated/resources/META-INF/org/apache/camel/component/salesforce/salesforce.json
b/components/camel-salesforce/camel-salesforce-component/src/generated/resources/META-INF/org/apache/camel/component/salesforce/salesforce.json
index 5fffa6528946..564b84936c27 100644
---
a/components/camel-salesforce/camel-salesforce-component/src/generated/resources/META-INF/org/apache/camel/component/salesforce/salesforce.json
+++
b/components/camel-salesforce/camel-salesforce-component/src/generated/resources/META-INF/org/apache/camel/component/salesforce/salesforce.json
@@ -25,11 +25,11 @@
"verifiers": "parameters,connectivity"
},
"componentProperties": {
- "apexMethod": { "index": 0, "kind": "property", "displayName": "Apex
Method", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "APEX method name" },
+ "apexMethod": { "index": 0, "kind": "property", "displayName": "Apex
Method", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "GET", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "HTTP verb used for the Apex
REST invocation, such as GET, POST, PUT, PATCH or DELETE. Applie [...]
"apexQueryParams": { "index": 1, "kind": "property", "displayName": "Apex
Query Params", "group": "common", "label": "", "required": false, "type":
"object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Query params for APEX method" },
"apiVersion": { "index": 2, "kind": "property", "displayName": "Api
Version", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "56.0", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Salesforce API version." },
"backoffIncrement": { "index": 3, "kind": "property", "displayName":
"Backoff Increment", "group": "common", "label": "", "required": false, "type":
"duration", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "1000", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Backoff interval increment for
Streaming connection restart attempts for failures beyond [...]
- "batchId": { "index": 4, "kind": "property", "displayName": "Batch Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Bulk API Batch ID" },
+ "batchId": { "index": 4, "kind": "property", "displayName": "Batch Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Identifies a batch within a
Bulk API v1 job. Required by getBatch, getRequest, getResults,
getQueryResultIds and getQuery [...]
"contentType": { "index": 5, "kind": "property", "displayName": "Content
Type", "group": "common", "label": "", "required": false, "type": "enum",
"javaType": "org.apache.camel.component.salesforce.api.dto.bulk.ContentType",
"enum": [ "XML", "CSV", "JSON", "ZIP_XML", "ZIP_CSV", "ZIP_JSON" ],
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "B [...]
"defaultReplayId": { "index": 6, "kind": "property", "displayName":
"Default Replay Id", "group": "common", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Long", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": -1, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Default replayId setting if no
value is found in initialReplayIdMap" },
"fallBackReplayId": { "index": 7, "kind": "property", "displayName": "Fall
Back Replay Id", "group": "common", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Long", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": -1, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "ReplayId to fall back to after
an Invalid Replay Id response" },
@@ -43,7 +43,7 @@
"includeDetails": { "index": 15, "kind": "property", "displayName":
"Include Details", "group": "common", "label": "", "required": false, "type":
"boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Include details in Salesforce1
Analytics report, defaults to false." },
"initialReplayIdMap": { "index": 16, "kind": "property", "displayName":
"Initial Replay Id Map", "group": "common", "label": "", "required": false,
"type": "object", "javaType": "java.util.Map<java.lang.String,
java.lang.Long>", "deprecated": false, "autowired": false, "secret": false,
"configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Replay IDs to start from per
channel name." },
"instanceId": { "index": 17, "kind": "property", "displayName": "Instance
Id", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Salesforce1 Analytics report
execution instance ID" },
- "jobId": { "index": 18, "kind": "property", "displayName": "Job Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Bulk API Job ID" },
+ "jobId": { "index": 18, "kind": "property", "displayName": "Job Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Identifies the Bulk API job to
act on, for Bulk API v1 operations such as getJob, closeJob, abortJob,
createBatch and getRes [...]
"limit": { "index": 19, "kind": "property", "displayName": "Limit",
"group": "common", "label": "", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Limit on number of returned
records. Applicable to some of the API, check the Salesforce documentation." },
"locator": { "index": 20, "kind": "property", "displayName": "Locator",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Locator provided by salesforce
Bulk 2.0 API for use in getting results for a Query job." },
"maxBackoff": { "index": 21, "kind": "property", "displayName": "Max
Backoff", "group": "common", "label": "", "required": false, "type":
"duration", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "30000", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Maximum backoff interval for
Streaming connection restart attempts for failures beyond CometD auto- [...]
@@ -65,7 +65,7 @@
"rawPayload": { "index": 37, "kind": "property", "displayName": "Raw
Payload", "group": "common", "label": "", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Use raw payload String for
request and response (either JSON or XML depending on format), instead o [...]
"reportId": { "index": 38, "kind": "property", "displayName": "Report Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Salesforce1 Analytics report
Id" },
"reportMetadata": { "index": 39, "kind": "property", "displayName":
"Report Metadata", "group": "common", "label": "", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata",
"deprecated": false, "autowired": false, "secret": false,
"configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Salesforce1 Analytics report
metadata for fi [...]
- "resultId": { "index": 40, "kind": "property", "displayName": "Result Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Bulk API Result ID" },
+ "resultId": { "index": 40, "kind": "property", "displayName": "Result Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Identifies one result set of a
completed Bulk API v1 query batch, as returned by the getQueryResultIds
operation. Used [...]
"sObjectBlobFieldName": { "index": 41, "kind": "property", "displayName":
"SObject Blob Field Name", "group": "common", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "SObject blob field name" },
"sObjectClass": { "index": 42, "kind": "property", "displayName": "SObject
Class", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Fully qualified SObject class
name, usually generated using camel-salesforce-maven-plugin" },
"sObjectFields": { "index": 43, "kind": "property", "displayName":
"SObject Fields", "group": "common", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "SObject fields to retrieve" },
@@ -94,7 +94,7 @@
"consumerWorkerPoolSize": { "index": 66, "kind": "property",
"displayName": "Consumer Worker Pool Size", "group": "consumer (advanced)",
"label": "consumer,advanced", "required": false, "type": "integer", "javaType":
"int", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 10, "description": "Core thread pool size size for consumer
worker pool." },
"initialReplyIdTimeout": { "index": 67, "kind": "property", "displayName":
"Initial Reply Id Timeout", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": 30,
"description": "Timeout in seconds to validate when a custom pubSubReplayId has
been configured, when starting the Camel Salesforce consumer." },
"allOrNone": { "index": 68, "kind": "property", "displayName": "All Or
None", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Composite API option to
indicate to rollback all records if any are not successful." },
- "apexUrl": { "index": 69, "kind": "property", "displayName": "Apex Url",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "APEX method URL" },
+ "apexUrl": { "index": 69, "kind": "property", "displayName": "Apex Url",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Path of the Apex REST resource
to invoke, appended to \/services\/apexrest\/ on the instance URL, for example
[...]
"compositeMethod": { "index": 70, "kind": "property", "displayName":
"Composite Method", "group": "producer", "label": "producer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Composite (raw) method." },
"eventName": { "index": 71, "kind": "property", "displayName": "Event
Name", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": "Name of Platform Event, Change
Data Capture Event, custom event, etc." },
"eventSchemaFormat": { "index": 72, "kind": "property", "displayName":
"Event Schema Format", "group": "producer", "label": "producer", "required":
false, "type": "enum", "javaType":
"org.apache.camel.component.salesforce.internal.dto.EventSchemaFormatEnum",
"enum": [ "EXPANDED", "COMPACT" ], "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "config", "description": " [...]
@@ -127,8 +127,8 @@
"loginConfig": { "index": 99, "kind": "property", "displayName": "Login
Config", "group": "security", "label": "common,security", "required": false,
"type": "object", "javaType":
"org.apache.camel.component.salesforce.SalesforceLoginConfig", "deprecated":
false, "autowired": false, "secret": false, "description": "All authentication
configuration in one nested bean, all properties set there can be set directly
on the component as well" },
"loginUrl": { "index": 100, "kind": "property", "displayName": "Login
Url", "group": "security", "label": "common,security", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue":
"https:\/\/login.salesforce.com", "description": "URL of the Salesforce
instance used for authentication, by default set to
https:\/\/login.salesforce.com" },
"password": { "index": 101, "kind": "property", "displayName": "Password",
"group": "security", "label": "common,security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "Password used in
OAuth flow to gain access to access token. It's easy to get started with
password OAuth flow, but in general one should avoid it as it is deemed less
secure than other flows. Make sur [...]
- "pubSubHost": { "index": 102, "kind": "property", "displayName": "Pub Sub
Host", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue":
"api.pubsub.salesforce.com", "description": "Pub\/Sub host" },
- "pubSubPort": { "index": 103, "kind": "property", "displayName": "Pub Sub
Port", "group": "security", "label": "common,security", "required": false,
"type": "integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 7443, "description": "Pub\/Sub port" },
+ "pubSubHost": { "index": 102, "kind": "property", "displayName": "Pub Sub
Host", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue":
"api.pubsub.salesforce.com", "description": "Host name of the Salesforce
Pub\/Sub API gRPC service used by the pubSubSubscribe and pubSubPublish
operations. Give a bare host name, without scheme or port." },
+ "pubSubPort": { "index": 103, "kind": "property", "displayName": "Pub Sub
Port", "group": "security", "label": "common,security", "required": false,
"type": "integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 7443, "description": "TCP port of the
Salesforce Pub\/Sub API gRPC service used by the pubSubSubscribe and
pubSubPublish operations." },
"refreshToken": { "index": 104, "kind": "property", "displayName":
"Refresh Token", "group": "security", "label": "common,security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description":
"Refresh token already obtained in the refresh token OAuth flow. One needs to
setup a web application and configure a callback URL to receive the refresh
token, or configure using the builtin [...]
"sslContextParameters": { "index": 105, "kind": "property", "displayName":
"Ssl Context Parameters", "group": "security", "label": "common,security",
"required": false, "type": "object", "javaType":
"org.apache.camel.support.jsse.SSLContextParameters", "deprecated": false,
"autowired": false, "secret": false, "description": "SSL parameters to use, see
SSLContextParameters class for all available options." },
"useGlobalSslContextParameters": { "index": 106, "kind": "property",
"displayName": "Use Global Ssl Context Parameters", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Enable usage of global SSL context
parameters" },
@@ -138,22 +138,22 @@
"CamelSalesforceReplayId": { "index": 0, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"Object", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The Streaming API replayId.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_REPLAY_ID"
},
"CamelSalesforceEventUuid": { "index": 1, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"Object", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The Streaming API eventUuid.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_EVENT_UUID"
},
"CamelSalesforceChangeEventSchema": { "index": 2, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The change event schema.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_EVENT_SCHEMA"
},
- "CamelSalesforceEventType": { "index": 3, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The event type.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_EVENT_TYPE"
},
- "CamelSalesforceCommitTimestamp": { "index": 4, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The commit timestamp.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_TIMESTAMP"
},
- "CamelSalesforceCommitUser": { "index": 5, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The commit user.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_USER"
},
- "CamelSalesforceCommitNumber": { "index": 6, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The commit number.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_NUMBER"
},
- "CamelSalesforceRecordIds": { "index": 7, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"Object", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The record ids.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_RECORD_IDS"
},
- "CamelSalesforceChangeType": { "index": 8, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The change type.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_TYPE"
},
- "CamelSalesforceChangeOrigin": { "index": 9, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The change origin.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_ORIGIN"
},
- "CamelSalesforceTransactionKey": { "index": 10, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The transaction key.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_TRANSACTION_KEY"
},
- "CamelSalesforceSequenceNumber": { "index": 11, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The sequence number.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_SEQUENCE_NUMBER"
},
- "CamelSalesforceIsTransactionEnd": { "index": 12, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Is transaction end.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_IS_TRANSACTION_END"
},
- "CamelSalesforceEntityName": { "index": 13, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The entity name.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_ENTITY_NAME"
},
+ "CamelSalesforceEventType": { "index": 3, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "For change and platform events, the last
segment of the configured topic name, such as AccountChangeEvent. For PushTopic
messages, the Salesforce event type of the notification, such as created.",
"constantName": "org.apache.came [...]
+ "CamelSalesforceCommitTimestamp": { "index": 4, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Time of the Salesforce transaction that
produced the change event, from the ChangeEventHeader.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_TIMESTAMP"
},
+ "CamelSalesforceCommitUser": { "index": 5, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Id of the Salesforce user whose
transaction produced the change event, from the ChangeEventHeader.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_USER"
},
+ "CamelSalesforceCommitNumber": { "index": 6, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "System change number of the Salesforce
transaction that produced the change event, from the ChangeEventHeader.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_COMMIT_NUMBER"
},
+ "CamelSalesforceRecordIds": { "index": 7, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"Object", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "Ids of the records affected by the change
event, from the ChangeEventHeader. Holds more than one id when a single
transaction changed several records.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#H [...]
+ "CamelSalesforceChangeType": { "index": 8, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Kind of change carried by the change
event, from the ChangeEventHeader, for example CREATE or UPDATE.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_TYPE"
},
+ "CamelSalesforceChangeOrigin": { "index": 9, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Identifies the Salesforce API and
client that made the change, from the ChangeEventHeader.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANGE_ORIGIN"
},
+ "CamelSalesforceTransactionKey": { "index": 10, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Key shared by every change event
produced by the same Salesforce transaction, from the ChangeEventHeader. Use it
to group events that belong to one transaction.", "constantName":
"org.apache.camel.component.salesforce.Sales [...]
+ "CamelSalesforceSequenceNumber": { "index": 11, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Position of this change event within
its Salesforce transaction, from the ChangeEventHeader.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_SEQUENCE_NUMBER"
},
+ "CamelSalesforceIsTransactionEnd": { "index": 12, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "True when this change event is the last
one of its Salesforce transaction, from the ChangeEventHeader. Use it together
with CamelSalesforceTransactionKey to detect the end of a transaction.",
"constantName": "org.apache.c [...]
+ "CamelSalesforceEntityName": { "index": 13, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Name of the Salesforce object the
change event applies to, such as Account, from the ChangeEventHeader.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_ENTITY_NAME"
},
"CamelSalesforcePlatformEventSchema": { "index": 14, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The platform event schema.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_PLATFORM_EVENT_SCHEMA"
},
- "CamelSalesforceCreatedDate": { "index": 15, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "java.time.ZonedDateTime", "deprecated": false, "deprecationNote":
"", "autowired": false, "secret": false, "description": "The created date.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CREATED_DATE"
},
- "CamelSalesforceTopicName": { "index": 16, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The topic name.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_TOPIC_NAME"
},
- "CamelSalesforceChannel": { "index": 17, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The channel.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANNEL"
},
- "CamelSalesforceClientId": { "index": 18, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The client id.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CLIENT_ID"
},
+ "CamelSalesforceCreatedDate": { "index": 15, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "java.time.ZonedDateTime", "deprecated": false, "deprecationNote":
"", "autowired": false, "secret": false, "description": "Creation time of the
event. Platform events supply a ZonedDateTime taken from the event payload,
while PushTopic notifications supply the raw createdDate value as a String.",
"constantName": "org.apache.camel. [...]
+ "CamelSalesforceTopicName": { "index": 16, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Name of the PushTopic the message was
received from. Set for PushTopic messages only.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_TOPIC_NAME"
},
+ "CamelSalesforceChannel": { "index": 17, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "Streaming API channel the message was received
on, such as \/topic\/MyTopic or \/data\/AccountChangeEvent.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANNEL"
},
+ "CamelSalesforceClientId": { "index": 18, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "Client id of the Streaming API subscription
that received the message. Set only when the server supplies one.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CLIENT_ID"
},
"CamelSalesforcePubSubReplayId": { "index": 19, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The Pub\/Sub API replayId.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_PUBSUB_REPLAY_ID"
},
"CamelSalesforcePubSubEventId": { "index": 20, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The Pub\/Sub API event id.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_PUBSUB_EVENT_ID"
},
"CamelSalesforcePubSubRpcId": { "index": 21, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The Pub\/Sub API rpc id.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_PUBSUB_RPC_ID"
},
@@ -162,11 +162,11 @@
"properties": {
"operationName": { "index": 0, "kind": "path", "displayName": "Operation
Name", "group": "common", "label": "common", "required": true, "type": "enum",
"javaType": "org.apache.camel.component.salesforce.internal.OperationName",
"enum": [ "getVersions", "getResources", "getGlobalObjects", "getBasicInfo",
"getDescription", "getSObject", "createSObject", "updateSObject",
"deleteSObject", "getSObjectWithId", "upsertSObject", "deleteSObjectWithId",
"getBlobField", "query", "queryMore", "q [...]
"topicName": { "index": 1, "kind": "path", "displayName": "Topic Name",
"group": "producer", "label": "consumer,producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The name of the topic\/channel to use"
},
- "apexMethod": { "index": 2, "kind": "parameter", "displayName": "Apex
Method", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "APEX method name" },
+ "apexMethod": { "index": 2, "kind": "parameter", "displayName": "Apex
Method", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "GET", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "HTTP verb used for the
Apex REST invocation, such as GET, POST, PUT, PATCH or DELETE [...]
"apexQueryParams": { "index": 3, "kind": "parameter", "displayName": "Apex
Query Params", "group": "common", "label": "", "required": false, "type":
"object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Query params for APEX
method" },
"apiVersion": { "index": 4, "kind": "parameter", "displayName": "Api
Version", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "56.0", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Salesforce API version."
},
"backoffIncrement": { "index": 5, "kind": "parameter", "displayName":
"Backoff Increment", "group": "common", "label": "", "required": false, "type":
"duration", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "1000", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Backoff interval
increment for Streaming connection restart attempts for failures [...]
- "batchId": { "index": 6, "kind": "parameter", "displayName": "Batch Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Bulk API Batch ID" },
+ "batchId": { "index": 6, "kind": "parameter", "displayName": "Batch Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Identifies a batch
within a Bulk API v1 job. Required by getBatch, getRequest, getResults,
getQueryResultIds and [...]
"contentType": { "index": 7, "kind": "parameter", "displayName": "Content
Type", "group": "common", "label": "", "required": false, "type": "enum",
"javaType": "org.apache.camel.component.salesforce.api.dto.bulk.ContentType",
"enum": [ "XML", "CSV", "JSON", "ZIP_XML", "ZIP_CSV", "ZIP_JSON" ],
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "descript [...]
"defaultReplayId": { "index": 8, "kind": "parameter", "displayName":
"Default Replay Id", "group": "common", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Long", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": -1, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Default replayId setting
if no value is found in initialReplayIdMap" },
"fallBackReplayId": { "index": 9, "kind": "parameter", "displayName":
"Fall Back Replay Id", "group": "common", "label": "", "required": false,
"type": "integer", "javaType": "java.lang.Long", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": -1, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "ReplayId to fall back to
after an Invalid Replay Id response" },
@@ -175,7 +175,7 @@
"includeDetails": { "index": 12, "kind": "parameter", "displayName":
"Include Details", "group": "common", "label": "", "required": false, "type":
"boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Include details in
Salesforce1 Analytics report, defaults to false." },
"initialReplayIdMap": { "index": 13, "kind": "parameter", "displayName":
"Initial Replay Id Map", "group": "common", "label": "", "required": false,
"type": "object", "javaType": "java.util.Map<java.lang.String,
java.lang.Long>", "deprecated": false, "autowired": false, "secret": false,
"configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Replay IDs to start from
per channel name." },
"instanceId": { "index": 14, "kind": "parameter", "displayName": "Instance
Id", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Salesforce1 Analytics
report execution instance ID" },
- "jobId": { "index": 15, "kind": "parameter", "displayName": "Job Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Bulk API Job ID" },
+ "jobId": { "index": 15, "kind": "parameter", "displayName": "Job Id",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Identifies the Bulk API
job to act on, for Bulk API v1 operations such as getJob, closeJob, abortJob,
createBatch an [...]
"limit": { "index": 16, "kind": "parameter", "displayName": "Limit",
"group": "common", "label": "", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Limit on number of
returned records. Applicable to some of the API, check the Salesforce
documentation." },
"locator": { "index": 17, "kind": "parameter", "displayName": "Locator",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Locator provided by
salesforce Bulk 2.0 API for use in getting results for a Query job." },
"maxBackoff": { "index": 18, "kind": "parameter", "displayName": "Max
Backoff", "group": "common", "label": "", "required": false, "type":
"duration", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "30000", "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Maximum backoff interval
for Streaming connection restart attempts for failures beyond Come [...]
@@ -196,7 +196,7 @@
"rawPayload": { "index": 33, "kind": "parameter", "displayName": "Raw
Payload", "group": "common", "label": "", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Use raw payload String
for request and response (either JSON or XML depending on format), i [...]
"reportId": { "index": 34, "kind": "parameter", "displayName": "Report
Id", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Salesforce1 Analytics
report Id" },
"reportMetadata": { "index": 35, "kind": "parameter", "displayName":
"Report Metadata", "group": "common", "label": "", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata",
"deprecated": false, "autowired": false, "secret": false,
"configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Salesforce1 Analytics
report metadat [...]
- "resultId": { "index": 36, "kind": "parameter", "displayName": "Result
Id", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Bulk API Result ID" },
+ "resultId": { "index": 36, "kind": "parameter", "displayName": "Result
Id", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Identifies one result
set of a completed Bulk API v1 query batch, as returned by the
getQueryResultIds operati [...]
"sObjectBlobFieldName": { "index": 37, "kind": "parameter", "displayName":
"SObject Blob Field Name", "group": "common", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "SObject blob field name"
},
"sObjectClass": { "index": 38, "kind": "parameter", "displayName":
"SObject Class", "group": "common", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Fully qualified SObject
class name, usually generated using camel-salesforce-maven-plugin" },
"sObjectFields": { "index": 39, "kind": "parameter", "displayName":
"SObject Fields", "group": "common", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "SObject fields to
retrieve" },
@@ -223,7 +223,7 @@
"exceptionHandler": { "index": 60, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By de [...]
"exchangePattern": { "index": 61, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "enum", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
"allOrNone": { "index": 62, "kind": "parameter", "displayName": "All Or
None", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Composite API option to
indicate to rollback all records if any are not successful." },
- "apexUrl": { "index": 63, "kind": "parameter", "displayName": "Apex Url",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "APEX method URL" },
+ "apexUrl": { "index": 63, "kind": "parameter", "displayName": "Apex Url",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Path of the Apex REST
resource to invoke, appended to \/services\/apexrest\/ on the instance URL, for
[...]
"compositeMethod": { "index": 64, "kind": "parameter", "displayName":
"Composite Method", "group": "producer", "label": "producer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Composite (raw) method."
},
"eventName": { "index": 65, "kind": "parameter", "displayName": "Event
Name", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "description": "Name of Platform Event,
Change Data Capture Event, custom event, etc." },
"eventSchemaFormat": { "index": 66, "kind": "parameter", "displayName":
"Event Schema Format", "group": "producer", "label": "producer", "required":
false, "type": "enum", "javaType":
"org.apache.camel.component.salesforce.internal.dto.EventSchemaFormatEnum",
"enum": [ "EXPANDED", "COMPACT" ], "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.salesforce.SalesforceEndpointConfig",
"configurationField": "configuration", "descrip [...]
diff --git
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceComponent.java
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceComponent.java
index ec3acb5d3dbc..35133a133a5d 100644
---
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceComponent.java
+++
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceComponent.java
@@ -166,11 +166,13 @@ public class SalesforceComponent extends DefaultComponent
implements SSLContextP
defaultValue = "false", label = "common,security")
private boolean lazyLogin;
- @Metadata(description = "Pub/Sub host",
+ @Metadata(description = "Host name of the Salesforce Pub/Sub API gRPC
service used by the pubSubSubscribe and"
+ + " pubSubPublish operations. Give a bare host
name, without scheme or port.",
defaultValue = "api.pubsub.salesforce.com", label =
"common,security")
private String pubSubHost = "api.pubsub.salesforce.com";
- @Metadata(description = "Pub/Sub port",
+ @Metadata(description = "TCP port of the Salesforce Pub/Sub API gRPC
service used by the pubSubSubscribe and"
+ + " pubSubPublish operations.",
defaultValue = "7443", label = "common,security")
private int pubSubPort = 7443;
diff --git
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceConstants.java
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceConstants.java
index a66c6d8935a0..07fbb9686755 100644
---
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceConstants.java
+++
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceConstants.java
@@ -27,37 +27,83 @@ public final class SalesforceConstants {
public static final String HEADER_SALESFORCE_EVENT_UUID =
"CamelSalesforceEventUuid";
@Metadata(label = "consumer", description = "The change event schema.",
javaType = "Object")
public static final String HEADER_SALESFORCE_CHANGE_EVENT_SCHEMA =
"CamelSalesforceChangeEventSchema";
- @Metadata(label = "consumer", description = "The event type.", javaType =
"String")
+ @Metadata(label = "consumer",
+ description = "For change and platform events, the last segment
of the configured topic name, such as"
+ + " AccountChangeEvent. For PushTopic messages,
the Salesforce event type of the"
+ + " notification, such as created.",
+ javaType = "String")
public static final String HEADER_SALESFORCE_EVENT_TYPE =
"CamelSalesforceEventType";
- @Metadata(label = "consumer", description = "The commit timestamp.",
javaType = "Object")
+ @Metadata(label = "consumer",
+ description = "Time of the Salesforce transaction that produced
the change event, from the"
+ + " ChangeEventHeader.",
+ javaType = "Object")
public static final String HEADER_SALESFORCE_COMMIT_TIMESTAMP =
"CamelSalesforceCommitTimestamp";
- @Metadata(label = "consumer", description = "The commit user.", javaType =
"Object")
+ @Metadata(label = "consumer",
+ description = "Id of the Salesforce user whose transaction
produced the change event, from the"
+ + " ChangeEventHeader.",
+ javaType = "Object")
public static final String HEADER_SALESFORCE_COMMIT_USER =
"CamelSalesforceCommitUser";
- @Metadata(label = "consumer", description = "The commit number.", javaType
= "Object")
+ @Metadata(label = "consumer",
+ description = "System change number of the Salesforce
transaction that produced the change event, from"
+ + " the ChangeEventHeader.",
+ javaType = "Object")
public static final String HEADER_SALESFORCE_COMMIT_NUMBER =
"CamelSalesforceCommitNumber";
- @Metadata(label = "consumer", description = "The record ids.", javaType =
"Object")
+ @Metadata(label = "consumer",
+ description = "Ids of the records affected by the change event,
from the ChangeEventHeader. Holds more"
+ + " than one id when a single transaction changed
several records.",
+ javaType = "Object")
public static final String HEADER_SALESFORCE_RECORD_IDS =
"CamelSalesforceRecordIds";
- @Metadata(label = "consumer", description = "The change type.", javaType =
"Object")
+ @Metadata(label = "consumer",
+ description = "Kind of change carried by the change event, from
the ChangeEventHeader, for example"
+ + " CREATE or UPDATE.",
+ javaType = "Object")
public static final String HEADER_SALESFORCE_CHANGE_TYPE =
"CamelSalesforceChangeType";
- @Metadata(label = "consumer", description = "The change origin.", javaType
= "Object")
+ @Metadata(label = "consumer",
+ description = "Identifies the Salesforce API and client that
made the change, from the"
+ + " ChangeEventHeader.",
+ javaType = "Object")
public static final String HEADER_SALESFORCE_CHANGE_ORIGIN =
"CamelSalesforceChangeOrigin";
- @Metadata(label = "consumer", description = "The transaction key.",
javaType = "Object")
+ @Metadata(label = "consumer",
+ description = "Key shared by every change event produced by the
same Salesforce transaction, from the"
+ + " ChangeEventHeader. Use it to group events that
belong to one transaction.",
+ javaType = "Object")
public static final String HEADER_SALESFORCE_TRANSACTION_KEY =
"CamelSalesforceTransactionKey";
- @Metadata(label = "consumer", description = "The sequence number.",
javaType = "Object")
+ @Metadata(label = "consumer",
+ description = "Position of this change event within its
Salesforce transaction, from the"
+ + " ChangeEventHeader.",
+ javaType = "Object")
public static final String HEADER_SALESFORCE_SEQUENCE_NUMBER =
"CamelSalesforceSequenceNumber";
- @Metadata(label = "consumer", description = "Is transaction end.",
javaType = "Object")
+ @Metadata(label = "consumer",
+ description = "True when this change event is the last one of
its Salesforce transaction, from the"
+ + " ChangeEventHeader. Use it together with
CamelSalesforceTransactionKey to detect the"
+ + " end of a transaction.",
+ javaType = "Object")
public static final String HEADER_SALESFORCE_IS_TRANSACTION_END =
"CamelSalesforceIsTransactionEnd";
- @Metadata(label = "consumer", description = "The entity name.", javaType =
"Object")
+ @Metadata(label = "consumer",
+ description = "Name of the Salesforce object the change event
applies to, such as Account, from the"
+ + " ChangeEventHeader.",
+ javaType = "Object")
public static final String HEADER_SALESFORCE_ENTITY_NAME =
"CamelSalesforceEntityName";
@Metadata(label = "consumer", description = "The platform event schema.",
javaType = "Object")
public static final String HEADER_SALESFORCE_PLATFORM_EVENT_SCHEMA =
"CamelSalesforcePlatformEventSchema";
- @Metadata(label = "consumer", description = "The created date.", javaType
= "java.time.ZonedDateTime")
+ @Metadata(label = "consumer",
+ description = "Creation time of the event. Platform events
supply a ZonedDateTime taken from the event"
+ + " payload, while PushTopic notifications supply
the raw createdDate value as a String.",
+ javaType = "java.time.ZonedDateTime")
public static final String HEADER_SALESFORCE_CREATED_DATE =
"CamelSalesforceCreatedDate";
- @Metadata(label = "consumer", description = "The topic name.", javaType =
"String")
+ @Metadata(label = "consumer",
+ description = "Name of the PushTopic the message was received
from. Set for PushTopic messages only.",
+ javaType = "String")
public static final String HEADER_SALESFORCE_TOPIC_NAME =
"CamelSalesforceTopicName";
- @Metadata(label = "consumer", description = "The channel.", javaType =
"String")
+ @Metadata(label = "consumer",
+ description = "Streaming API channel the message was received
on, such as /topic/MyTopic or"
+ + " /data/AccountChangeEvent.",
+ javaType = "String")
public static final String HEADER_SALESFORCE_CHANNEL =
"CamelSalesforceChannel";
- @Metadata(label = "consumer", description = "The client id.", javaType =
"String")
+ @Metadata(label = "consumer",
+ description = "Client id of the Streaming API subscription that
received the message. Set only when the"
+ + " server supplies one.",
+ javaType = "String")
public static final String HEADER_SALESFORCE_CLIENT_ID =
"CamelSalesforceClientId";
// Pub/Sub API headers
diff --git
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpointConfig.java
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpointConfig.java
index 843d7e42a04d..f162c4b056b9 100644
---
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpointConfig.java
+++
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpointConfig.java
@@ -155,7 +155,7 @@ public class SalesforceEndpointConfig implements Cloneable {
private Boolean streamQueryResult = false;
@UriParam(displayName = "SObject Search")
private String sObjectSearch;
- @UriParam
+ @UriParam(defaultValue = "GET")
private String apexMethod;
@UriParam(displayName = "Event Name", label = "producer")
private String eventName;
@@ -456,7 +456,8 @@ public class SalesforceEndpointConfig implements Cloneable {
}
/**
- * APEX method name
+ * HTTP verb used for the Apex REST invocation, such as GET, POST, PUT,
PATCH or DELETE. Applies to the apexCall
+ * operation and defaults to GET. Can be overridden per message with the
CamelSalesforceApexMethod header.
*/
public void setApexMethod(String apexMethod) {
this.apexMethod = apexMethod;
@@ -467,7 +468,10 @@ public class SalesforceEndpointConfig implements Cloneable
{
}
/**
- * APEX method URL
+ * Path of the Apex REST resource to invoke, appended to
/services/apexrest/ on the instance URL, for example
+ * MyApexClass/. The apexCall operation needs this value, which can be
given as this option, in the endpoint path as
+ * apexCall/MyApexClass/, or in the CamelSalesforceApexUrl header.
Placeholders written in curly braces are resolved
+ * from message headers of the same name.
*/
public void setApexUrl(String apexUrl) {
this.apexUrl = apexUrl;
@@ -534,7 +538,9 @@ public class SalesforceEndpointConfig implements Cloneable {
}
/**
- * Bulk API Job ID
+ * Identifies the Bulk API job to act on, for Bulk API v1 operations such
as getJob, closeJob, abortJob, createBatch
+ * and getResults, and for the bulk2 operations that target an existing
job. Operations that accept a JobInfo or
+ * BatchInfo message body can take the id from there instead.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
@@ -545,7 +551,8 @@ public class SalesforceEndpointConfig implements Cloneable {
}
/**
- * Bulk API Batch ID
+ * Identifies a batch within a Bulk API v1 job. Required by getBatch,
getRequest, getResults, getQueryResultIds and
+ * getQueryResult unless a BatchInfo message body supplies it. Not used by
Bulk API 2.0.
*/
public void setBatchId(String batchId) {
this.batchId = batchId;
@@ -556,7 +563,8 @@ public class SalesforceEndpointConfig implements Cloneable {
}
/**
- * Bulk API Result ID
+ * Identifies one result set of a completed Bulk API v1 query batch, as
returned by the getQueryResultIds operation.
+ * Used only by getQueryResult, together with jobId and batchId.
*/
public void setResultId(String resultId) {
this.resultId = resultId;
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/SalesforceComponentBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/SalesforceComponentBuilderFactory.java
index 577be92a6df6..5572378a6908 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/SalesforceComponentBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/SalesforceComponentBuilderFactory.java
@@ -50,11 +50,16 @@ public interface SalesforceComponentBuilderFactory {
*/
interface SalesforceComponentBuilder extends
ComponentBuilder<SalesforceComponent> {
+
/**
- * APEX method name.
+ * HTTP verb used for the Apex REST invocation, such as GET, POST, PUT,
+ * PATCH or DELETE. Applies to the apexCall operation and defaults to
+ * GET. Can be overridden per message with the
CamelSalesforceApexMethod
+ * header.
*
* The option is a: <code>java.lang.String</code> type.
*
+ * Default: GET
* Group: common
*
* @param apexMethod the value to set
@@ -117,7 +122,9 @@ public interface SalesforceComponentBuilderFactory {
}
/**
- * Bulk API Batch ID.
+ * Identifies a batch within a Bulk API v1 job. Required by getBatch,
+ * getRequest, getResults, getQueryResultIds and getQueryResult unless
a
+ * BatchInfo message body supplies it. Not used by Bulk API 2.0.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -350,7 +357,11 @@ public interface SalesforceComponentBuilderFactory {
}
/**
- * Bulk API Job ID.
+ * Identifies the Bulk API job to act on, for Bulk API v1 operations
+ * such as getJob, closeJob, abortJob, createBatch and getResults, and
+ * for the bulk2 operations that target an existing job. Operations
that
+ * accept a JobInfo or BatchInfo message body can take the id from
there
+ * instead.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -737,7 +748,9 @@ public interface SalesforceComponentBuilderFactory {
}
/**
- * Bulk API Result ID.
+ * Identifies one result set of a completed Bulk API v1 query batch, as
+ * returned by the getQueryResultIds operation. Used only by
+ * getQueryResult, together with jobId and batchId.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1235,7 +1248,12 @@ public interface SalesforceComponentBuilderFactory {
}
/**
- * APEX method URL.
+ * Path of the Apex REST resource to invoke, appended to
+ * /services/apexrest/ on the instance URL, for example MyApexClass/.
+ * The apexCall operation needs this value, which can be given as this
+ * option, in the endpoint path as apexCall/MyApexClass/, or in the
+ * CamelSalesforceApexUrl header. Placeholders written in curly braces
+ * are resolved from message headers of the same name.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1802,7 +1820,9 @@ public interface SalesforceComponentBuilderFactory {
/**
- * Pub/Sub host.
+ * Host name of the Salesforce Pub/Sub API gRPC service used by the
+ * pubSubSubscribe and pubSubPublish operations. Give a bare host name,
+ * without scheme or port.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1819,7 +1839,8 @@ public interface SalesforceComponentBuilderFactory {
/**
- * Pub/Sub port.
+ * TCP port of the Salesforce Pub/Sub API gRPC service used by the
+ * pubSubSubscribe and pubSubPublish operations.
*
* The option is a: <code>int</code> type.
*
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SalesforceEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SalesforceEndpointBuilderFactory.java
index 49006858ec44..b4c472aad853 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SalesforceEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SalesforceEndpointBuilderFactory.java
@@ -44,10 +44,14 @@ public interface SalesforceEndpointBuilderFactory {
return (AdvancedSalesforceEndpointConsumerBuilder) this;
}
/**
- * APEX method name.
+ * HTTP verb used for the Apex REST invocation, such as GET, POST, PUT,
+ * PATCH or DELETE. Applies to the apexCall operation and defaults to
+ * GET. Can be overridden per message with the
CamelSalesforceApexMethod
+ * header.
*
* The option is a: <code>java.lang.String</code> type.
*
+ * Default: GET
* Group: common
*
* @param apexMethod the value to set
@@ -136,7 +140,9 @@ public interface SalesforceEndpointBuilderFactory {
return this;
}
/**
- * Bulk API Batch ID.
+ * Identifies a batch within a Bulk API v1 job. Required by getBatch,
+ * getRequest, getResults, getQueryResultIds and getQueryResult unless
a
+ * BatchInfo message body supplies it. Not used by Bulk API 2.0.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -380,7 +386,11 @@ public interface SalesforceEndpointBuilderFactory {
return this;
}
/**
- * Bulk API Job ID.
+ * Identifies the Bulk API job to act on, for Bulk API v1 operations
+ * such as getJob, closeJob, abortJob, createBatch and getResults, and
+ * for the bulk2 operations that target an existing job. Operations
that
+ * accept a JobInfo or BatchInfo message body can take the id from
there
+ * instead.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -972,7 +982,9 @@ public interface SalesforceEndpointBuilderFactory {
return this;
}
/**
- * Bulk API Result ID.
+ * Identifies one result set of a completed Bulk API v1 query batch, as
+ * returned by the getQueryResultIds operation. Used only by
+ * getQueryResult, together with jobId and batchId.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1634,10 +1646,14 @@ public interface SalesforceEndpointBuilderFactory {
}
/**
- * APEX method name.
+ * HTTP verb used for the Apex REST invocation, such as GET, POST, PUT,
+ * PATCH or DELETE. Applies to the apexCall operation and defaults to
+ * GET. Can be overridden per message with the
CamelSalesforceApexMethod
+ * header.
*
* The option is a: <code>java.lang.String</code> type.
*
+ * Default: GET
* Group: common
*
* @param apexMethod the value to set
@@ -1726,7 +1742,9 @@ public interface SalesforceEndpointBuilderFactory {
return this;
}
/**
- * Bulk API Batch ID.
+ * Identifies a batch within a Bulk API v1 job. Required by getBatch,
+ * getRequest, getResults, getQueryResultIds and getQueryResult unless
a
+ * BatchInfo message body supplies it. Not used by Bulk API 2.0.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1970,7 +1988,11 @@ public interface SalesforceEndpointBuilderFactory {
return this;
}
/**
- * Bulk API Job ID.
+ * Identifies the Bulk API job to act on, for Bulk API v1 operations
+ * such as getJob, closeJob, abortJob, createBatch and getResults, and
+ * for the bulk2 operations that target an existing job. Operations
that
+ * accept a JobInfo or BatchInfo message body can take the id from
there
+ * instead.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -2562,7 +2584,9 @@ public interface SalesforceEndpointBuilderFactory {
return this;
}
/**
- * Bulk API Result ID.
+ * Identifies one result set of a completed Bulk API v1 query batch, as
+ * returned by the getQueryResultIds operation. Used only by
+ * getQueryResult, together with jobId and batchId.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -2802,7 +2826,12 @@ public interface SalesforceEndpointBuilderFactory {
return this;
}
/**
- * APEX method URL.
+ * Path of the Apex REST resource to invoke, appended to
+ * /services/apexrest/ on the instance URL, for example MyApexClass/.
+ * The apexCall operation needs this value, which can be given as this
+ * option, in the endpoint path as apexCall/MyApexClass/, or in the
+ * CamelSalesforceApexUrl header. Placeholders written in curly braces
+ * are resolved from message headers of the same name.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -3023,10 +3052,14 @@ public interface SalesforceEndpointBuilderFactory {
}
/**
- * APEX method name.
+ * HTTP verb used for the Apex REST invocation, such as GET, POST, PUT,
+ * PATCH or DELETE. Applies to the apexCall operation and defaults to
+ * GET. Can be overridden per message with the
CamelSalesforceApexMethod
+ * header.
*
* The option is a: <code>java.lang.String</code> type.
*
+ * Default: GET
* Group: common
*
* @param apexMethod the value to set
@@ -3115,7 +3148,9 @@ public interface SalesforceEndpointBuilderFactory {
return this;
}
/**
- * Bulk API Batch ID.
+ * Identifies a batch within a Bulk API v1 job. Required by getBatch,
+ * getRequest, getResults, getQueryResultIds and getQueryResult unless
a
+ * BatchInfo message body supplies it. Not used by Bulk API 2.0.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -3359,7 +3394,11 @@ public interface SalesforceEndpointBuilderFactory {
return this;
}
/**
- * Bulk API Job ID.
+ * Identifies the Bulk API job to act on, for Bulk API v1 operations
+ * such as getJob, closeJob, abortJob, createBatch and getResults, and
+ * for the bulk2 operations that target an existing job. Operations
that
+ * accept a JobInfo or BatchInfo message body can take the id from
there
+ * instead.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -3951,7 +3990,9 @@ public interface SalesforceEndpointBuilderFactory {
return this;
}
/**
- * Bulk API Result ID.
+ * Identifies one result set of a completed Bulk API v1 query batch, as
+ * returned by the getQueryResultIds operation. Used only by
+ * getQueryResult, together with jobId and batchId.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -4322,7 +4363,9 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceChangeEventSchema";
}
/**
- * The event type.
+ * For change and platform events, the last segment of the configured
+ * topic name, such as AccountChangeEvent. For PushTopic messages, the
+ * Salesforce event type of the notification, such as created.
*
* The option is a: {@code String} type.
*
@@ -4334,7 +4377,8 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceEventType";
}
/**
- * The commit timestamp.
+ * Time of the Salesforce transaction that produced the change event,
+ * from the ChangeEventHeader.
*
* The option is a: {@code Object} type.
*
@@ -4346,7 +4390,8 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceCommitTimestamp";
}
/**
- * The commit user.
+ * Id of the Salesforce user whose transaction produced the change
+ * event, from the ChangeEventHeader.
*
* The option is a: {@code Object} type.
*
@@ -4358,7 +4403,8 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceCommitUser";
}
/**
- * The commit number.
+ * System change number of the Salesforce transaction that produced the
+ * change event, from the ChangeEventHeader.
*
* The option is a: {@code Object} type.
*
@@ -4370,7 +4416,9 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceCommitNumber";
}
/**
- * The record ids.
+ * Ids of the records affected by the change event, from the
+ * ChangeEventHeader. Holds more than one id when a single transaction
+ * changed several records.
*
* The option is a: {@code Object} type.
*
@@ -4382,7 +4430,8 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceRecordIds";
}
/**
- * The change type.
+ * Kind of change carried by the change event, from the
+ * ChangeEventHeader, for example CREATE or UPDATE.
*
* The option is a: {@code Object} type.
*
@@ -4394,7 +4443,8 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceChangeType";
}
/**
- * The change origin.
+ * Identifies the Salesforce API and client that made the change, from
+ * the ChangeEventHeader.
*
* The option is a: {@code Object} type.
*
@@ -4406,7 +4456,9 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceChangeOrigin";
}
/**
- * The transaction key.
+ * Key shared by every change event produced by the same Salesforce
+ * transaction, from the ChangeEventHeader. Use it to group events that
+ * belong to one transaction.
*
* The option is a: {@code Object} type.
*
@@ -4418,7 +4470,8 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceTransactionKey";
}
/**
- * The sequence number.
+ * Position of this change event within its Salesforce transaction,
from
+ * the ChangeEventHeader.
*
* The option is a: {@code Object} type.
*
@@ -4430,7 +4483,9 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceSequenceNumber";
}
/**
- * Is transaction end.
+ * True when this change event is the last one of its Salesforce
+ * transaction, from the ChangeEventHeader. Use it together with
+ * CamelSalesforceTransactionKey to detect the end of a transaction.
*
* The option is a: {@code Object} type.
*
@@ -4442,7 +4497,8 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceIsTransactionEnd";
}
/**
- * The entity name.
+ * Name of the Salesforce object the change event applies to, such as
+ * Account, from the ChangeEventHeader.
*
* The option is a: {@code Object} type.
*
@@ -4466,7 +4522,9 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforcePlatformEventSchema";
}
/**
- * The created date.
+ * Creation time of the event. Platform events supply a ZonedDateTime
+ * taken from the event payload, while PushTopic notifications supply
+ * the raw createdDate value as a String.
*
* The option is a: {@code java.time.ZonedDateTime} type.
*
@@ -4478,7 +4536,8 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceCreatedDate";
}
/**
- * The topic name.
+ * Name of the PushTopic the message was received from. Set for
+ * PushTopic messages only.
*
* The option is a: {@code String} type.
*
@@ -4490,7 +4549,8 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceTopicName";
}
/**
- * The channel.
+ * Streaming API channel the message was received on, such as
+ * /topic/MyTopic or /data/AccountChangeEvent.
*
* The option is a: {@code String} type.
*
@@ -4502,7 +4562,8 @@ public interface SalesforceEndpointBuilderFactory {
return "CamelSalesforceChannel";
}
/**
- * The client id.
+ * Client id of the Streaming API subscription that received the
+ * message. Set only when the server supplies one.
*
* The option is a: {@code String} type.
*
