The salesforce component is used for integrating Camel with the massive Salesforce API.
| Name | Kind | Group | Required | Default | Type | Enum | Description |
|---|---|---|---|---|---|---|---|
| operationName | path | common | org.apache.camel.component.salesforce.internal.OperationName | 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 QUERY_ALL 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 | common | java.lang.String | ||||
| apexMethod | parameter | common | java.lang.String | APEX method name | |||
| apexQueryParams | parameter | common | java.util.Map |
Query params for APEX method | |||
| apexUrl | parameter | common | java.lang.String | APEX method URL | |||
| apiVersion | parameter | common | java.lang.String | Salesforce API version, defaults to SalesforceEndpointConfig.DEFAULT_VERSION | |||
| backoffIncrement | parameter | common | long | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | |||
| batchId | parameter | common | java.lang.String | Bulk API Batch ID | |||
| contentType | parameter | common | org.apache.camel.component.salesforce.api.dto.bulk.ContentType | XML CSV ZIP_XML ZIP_CSV |
Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV | ||
| defaultReplayId | parameter | common | java.lang.Integer | Default replayId setting if no value is found in {@link #initialReplayIdMap} @param defaultReplayId | |||
| format | parameter | common | org.apache.camel.component.salesforce.internal.PayloadFormat | JSON XML |
Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON | ||
| httpClient | parameter | common | org.apache.camel.component.salesforce.SalesforceHttpClient | Custom Jetty Http Client to use to connect to Salesforce. | |||
| includeDetails | parameter | common | java.lang.Boolean | Include details in Salesforce1 Analytics report, defaults to false. | |||
| initialReplayIdMap | parameter | common | java.util.Map |
Replay IDs to start from per channel name. | |||
| instanceId | parameter | common | java.lang.String | Salesforce1 Analytics report execution instance ID | |||
| jobId | parameter | common | java.lang.String | Bulk API Job ID | |||
| maxBackoff | parameter | common | long | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | |||
| notifyForFields | parameter | common | org.apache.camel.component.salesforce.internal.dto.NotifyForFieldsEnum | ALL REFERENCED SELECT WHERE |
Notify for fields, options are ALL, REFERENCED, SELECT, WHERE | ||
| notifyForOperationCreate | parameter | common | java.lang.Boolean | Notify for create operation, defaults to false (API version >= 29.0) | |||
| notifyForOperationDelete | parameter | common | java.lang.Boolean | Notify for delete operation, defaults to false (API version >= 29.0) | |||
| notifyForOperations | parameter | common | org.apache.camel.component.salesforce.internal.dto.NotifyForOperationsEnum | ALL CREATE EXTENDED UPDATE |
Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version < 29.0) | ||
| notifyForOperationUndelete | parameter | common | java.lang.Boolean | Notify for un-delete operation, defaults to false (API version >= 29.0) | |||
| notifyForOperationUpdate | parameter | common | java.lang.Boolean | Notify for update operation, defaults to false (API version >= 29.0) | |||
| objectMapper | parameter | common | com.fasterxml.jackson.databind.ObjectMapper | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. | |||
| reportId | parameter | common | java.lang.String | Salesforce1 Analytics report Id | |||
| reportMetadata | parameter | common | org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata | Salesforce1 Analytics report metadata for filtering | |||
| resultId | parameter | common | java.lang.String | Bulk API Result ID | |||
| sObjectBlobFieldName | parameter | common | java.lang.String | SObject blob field name | |||
| sObjectClass | parameter | common | java.lang.String | Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin | |||
| sObjectFields | parameter | common | java.lang.String | SObject fields to retrieve | |||
| sObjectId | parameter | common | java.lang.String | SObject ID if required by API | |||
| sObjectIdName | parameter | common | java.lang.String | SObject external ID field name | |||
| sObjectIdValue | parameter | common | java.lang.String | SObject external ID field value | |||
| sObjectName | parameter | common | java.lang.String | SObject name if required or supported by API | |||
| sObjectQuery | parameter | common | java.lang.String | Salesforce SOQL query string | |||
| sObjectSearch | parameter | common | java.lang.String | Salesforce SOSL search string | |||
| updateTopic | parameter | common | boolean | Whether to update an existing Push Topic when using the Streaming API, defaults to false | |||
| bridgeErrorHandler | parameter | consumer | boolean | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| exceptionHandler | parameter | consumer (advanced) | org.apache.camel.spi.ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| exchangePattern | parameter | consumer (advanced) | org.apache.camel.ExchangePattern | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the exchange pattern when the consumer creates an exchange. | ||
| synchronous | parameter | advanced | false | boolean | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
The Salesforce consumer.