Salesforce

Salesforce

Scheme: salesforce

Represents a Salesforce endpoint.

Name Kind Type Required Deprecated Default Value Enum Values Description
operationName path org.apache.camel.component.salesforce.internal.OperationName false GET_VERSIONS
GET_RESOURCES
GET_GLOBAL_OBJECTS
GET_BASIC_INFO
GET_DESCRIPTION
GET_SOBJECT
CREATE_SOBJECT
UPDATE_SOBJECT
DELETE_SOBJECT
GET_SOBJECT_WITH_ID
UPSERT_SOBJECT
DELETE_SOBJECT_WITH_ID
GET_BLOB_FIELD
QUERY
QUERY_MORE
SEARCH
APEX_CALL
CREATE_JOB
GET_JOB
CLOSE_JOB
ABORT_JOB
CREATE_BATCH
GET_BATCH
GET_ALL_BATCHES
GET_REQUEST
GET_RESULTS
CREATE_BATCH_QUERY
GET_QUERY_RESULT_IDS
GET_QUERY_RESULT
GET_RECENT_REPORTS
GET_REPORT_DESCRIPTION
EXECUTE_SYNCREPORT
EXECUTE_ASYNCREPORT
GET_REPORT_INSTANCES
GET_REPORT_RESULTS
topicName path java.lang.String false
apiVersion parameter java.lang.String false Salesforce API version, defaults to SalesforceEndpointConfig.DEFAULT_VERSION
format parameter org.apache.camel.component.salesforce.internal.PayloadFormat false JSON
XML
Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON
sObjectName parameter java.lang.String false SObject name if required or supported by API
sObjectId parameter java.lang.String false SObject ID if required by API
sObjectFields parameter java.lang.String false SObject fields to retrieve
sObjectIdName parameter java.lang.String false SObject external ID field name
sObjectIdValue parameter java.lang.String false SObject external ID field value
sObjectBlobFieldName parameter java.lang.String false SObject blob field name
sObjectClass parameter java.lang.String false Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin
sObjectQuery parameter java.lang.String false Salesforce SOQL query string
sObjectSearch parameter java.lang.String false Salesforce SOSL search string
apexMethod parameter java.lang.String false APEX method name
apexUrl parameter java.lang.String false APEX method URL
apexQueryParams parameter java.util.Map false Query params for APEX method
contentType parameter org.apache.camel.component.salesforce.api.dto.bulk.ContentType false XML
CSV
ZIP_XML
ZIP_CSV
Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV
jobId parameter java.lang.String false Bulk API Job ID
batchId parameter java.lang.String false Bulk API Batch ID
resultId parameter java.lang.String false Bulk API Result ID
updateTopic parameter boolean false Whether to update an existing Push Topic when using the Streaming API, defaults to false
notifyForFields parameter org.apache.camel.component.salesforce.internal.dto.NotifyForFieldsEnum false ALL
REFERENCED
SELECT
WHERE
Notify for fields, options are ALL, REFERENCED, SELECT, WHERE
notifyForOperations parameter org.apache.camel.component.salesforce.internal.dto.NotifyForOperationsEnum false ALL
CREATE
EXTENDED
UPDATE
Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version < 29.0)
notifyForOperationCreate parameter java.lang.Boolean false Notify for create operation, defaults to false (API version >= 29.0)
notifyForOperationUpdate parameter java.lang.Boolean false Notify for update operation, defaults to false (API version >= 29.0)
notifyForOperationDelete parameter java.lang.Boolean false Notify for delete operation, defaults to false (API version >= 29.0)
notifyForOperationUndelete parameter java.lang.Boolean false Notify for un-delete operation, defaults to false (API version >= 29.0)
reportId parameter java.lang.String false Salesforce1 Analytics report Id
includeDetails parameter java.lang.Boolean false Include details in Salesforce1 Analytics report, defaults to false.
reportMetadata parameter org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata false Salesforce1 Analytics report metadata for filtering
instanceId parameter java.lang.String false Salesforce1 Analytics report execution instance ID
httpClient parameter org.eclipse.jetty.client.HttpClient false Custom Jetty Http Client to use to connect to Salesforce.
exchangePattern parameter org.apache.camel.ExchangePattern false InOnly InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter boolean false false Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

salesforce consumer

The Salesforce consumer.