SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder

Enclosing interface:

SalesforceEndpointBuilderFactory
```
public static interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the Salesforce component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default SalesforceEndpointBuilderFactory.AdvancedSalesforceEndpointConsumerBuilder`	`advanced()`
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`apexMethod(String apexMethod)` APEX method name.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`apexQueryParams(Map<String,Object> apexQueryParams)` Query params for APEX method.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`apexQueryParams(String apexQueryParams)` Query params for APEX method.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`apiVersion(String apiVersion)` Salesforce API version.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`backoffIncrement(long backoffIncrement)` Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`backoffIncrement(String backoffIncrement)` Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`batchId(String batchId)` Bulk API Batch ID.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` 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.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`bridgeErrorHandler(String bridgeErrorHandler)` 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.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`contentType(SalesforceEndpointBuilderFactory.ContentType contentType)` Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`contentType(String contentType)` Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`defaultReplayId(Long defaultReplayId)` Default replayId setting if no value is found in initialReplayIdMap.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`defaultReplayId(String defaultReplayId)` Default replayId setting if no value is found in initialReplayIdMap.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`fallBackReplayId(Long fallBackReplayId)` ReplayId to fall back to after an Invalid Replay Id response.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`fallBackReplayId(String fallBackReplayId)` ReplayId to fall back to after an Invalid Replay Id response.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`format(SalesforceEndpointBuilderFactory.PayloadFormat format)` Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`format(String format)` Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`httpClient(Object httpClient)` Custom Jetty Http Client to use to connect to Salesforce.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`httpClient(String httpClient)` Custom Jetty Http Client to use to connect to Salesforce.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`includeDetails(Boolean includeDetails)` Include details in Salesforce1 Analytics report, defaults to false.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`includeDetails(String includeDetails)` Include details in Salesforce1 Analytics report, defaults to false.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`initialReplayIdMap(Map<String,Long> initialReplayIdMap)` Replay IDs to start from per channel name.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`initialReplayIdMap(String initialReplayIdMap)` Replay IDs to start from per channel name.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`instanceId(String instanceId)` Salesforce1 Analytics report execution instance ID.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`jobId(String jobId)` Bulk API Job ID.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`limit(Integer limit)` Limit on number of returned records.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`limit(String limit)` Limit on number of returned records.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`locator(String locator)` Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`maxBackoff(long maxBackoff)` Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`maxBackoff(String maxBackoff)` Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`maxRecords(Integer maxRecords)` The maximum number of records to retrieve per set of results for a Bulk 2.0 Query.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`maxRecords(String maxRecords)` The maximum number of records to retrieve per set of results for a Bulk 2.0 Query.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notFoundBehaviour(SalesforceEndpointBuilderFactory.NotFoundBehaviour notFoundBehaviour)` Sets the behaviour of 404 not found status received from Salesforce API.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notFoundBehaviour(String notFoundBehaviour)` Sets the behaviour of 404 not found status received from Salesforce API.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notifyForFields(SalesforceEndpointBuilderFactory.NotifyForFieldsEnum notifyForFields)` Notify for fields, options are ALL, REFERENCED, SELECT, WHERE.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notifyForFields(String notifyForFields)` Notify for fields, options are ALL, REFERENCED, SELECT, WHERE.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notifyForOperationCreate(Boolean notifyForOperationCreate)` Notify for create operation, defaults to false (API version = 29.0).
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notifyForOperationCreate(String notifyForOperationCreate)` Notify for create operation, defaults to false (API version = 29.0).
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notifyForOperationDelete(Boolean notifyForOperationDelete)` Notify for delete operation, defaults to false (API version = 29.0).
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notifyForOperationDelete(String notifyForOperationDelete)` Notify for delete operation, defaults to false (API version = 29.0).
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notifyForOperations(SalesforceEndpointBuilderFactory.NotifyForOperationsEnum notifyForOperations)` Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version 29.0).
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notifyForOperations(String notifyForOperations)` Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version 29.0).
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notifyForOperationUndelete(Boolean notifyForOperationUndelete)` Notify for un-delete operation, defaults to false (API version = 29.0).
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notifyForOperationUndelete(String notifyForOperationUndelete)` Notify for un-delete operation, defaults to false (API version = 29.0).
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notifyForOperationUpdate(Boolean notifyForOperationUpdate)` Notify for update operation, defaults to false (API version = 29.0).
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`notifyForOperationUpdate(String notifyForOperationUpdate)` Notify for update operation, defaults to false (API version = 29.0).
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`objectMapper(Object objectMapper)` Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`objectMapper(String objectMapper)` Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`pkChunking(Boolean pkChunking)` Use PK Chunking.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`pkChunking(String pkChunking)` Use PK Chunking.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`pkChunkingChunkSize(Integer pkChunkingChunkSize)` Chunk size for use with PK Chunking.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`pkChunkingChunkSize(String pkChunkingChunkSize)` Chunk size for use with PK Chunking.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`pkChunkingParent(String pkChunkingParent)` Specifies the parent object when you're enabling PK chunking for queries on sharing objects.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`pkChunkingStartRow(String pkChunkingStartRow)` Specifies the 15-character or 18-character record ID to be used as the lower boundary for the first chunk.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`queryLocator(String queryLocator)` Query Locator provided by salesforce for use when a query results in more records than can be retrieved in a single call.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`rawPayload(boolean rawPayload)` Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`rawPayload(String rawPayload)` Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`replayId(Long replayId)` The replayId value to use when subscribing.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`replayId(String replayId)` The replayId value to use when subscribing.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`reportId(String reportId)` Salesforce1 Analytics report Id.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`reportMetadata(Object reportMetadata)` Salesforce1 Analytics report metadata for filtering.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`reportMetadata(String reportMetadata)` Salesforce1 Analytics report metadata for filtering.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`resultId(String resultId)` Bulk API Result ID.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`sObjectBlobFieldName(String sObjectBlobFieldName)` SObject blob field name.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`sObjectClass(String sObjectClass)` Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`sObjectFields(String sObjectFields)` SObject fields to retrieve.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`sObjectId(String sObjectId)` SObject ID if required by API.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`sObjectIdName(String sObjectIdName)` SObject external ID field name.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`sObjectIdValue(String sObjectIdValue)` SObject external ID field value.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`sObjectName(String sObjectName)` SObject name if required or supported by API.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`sObjectQuery(String sObjectQuery)` Salesforce SOQL query string.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`sObjectSearch(String sObjectSearch)` Salesforce SOSL search string.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`updateTopic(boolean updateTopic)` Whether to update an existing Push Topic when using the Streaming API, defaults to false.
`default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder`	`updateTopic(String updateTopic)` Whether to update an existing Push Topic when using the Streaming API, defaults to false.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- Method Detail
  - advanced
```
default SalesforceEndpointBuilderFactory.AdvancedSalesforceEndpointConsumerBuilder advanced()
```
  - apexMethod
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder apexMethod(String apexMethod)
```
    APEX method name. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    apexMethod - the value to set
    
    Returns:
    
    the dsl builder
  - apexQueryParams
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder apexQueryParams(Map<String,Object> apexQueryParams)
```
    Query params for APEX method. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. Group: common
    
    Parameters:
    
    apexQueryParams - the value to set
    
    Returns:
    
    the dsl builder
  - apexQueryParams
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder apexQueryParams(String apexQueryParams)
```
    Query params for APEX method. The option will be converted to a <code>java.util.Map<java.lang.String, java.lang.Object></code> type. Group: common
    
    Parameters:
    
    apexQueryParams - the value to set
    
    Returns:
    
    the dsl builder
  - apiVersion
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder apiVersion(String apiVersion)
```
    Salesforce API version. The option is a: <code>java.lang.String</code> type. Default: 53.0 Group: common
    
    Parameters:
    
    apiVersion - the value to set
    
    Returns:
    
    the dsl builder
  - backoffIncrement
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder backoffIncrement(long backoffIncrement)
```
    Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. The option is a: <code>long</code> type. Default: 1000 Group: common
    
    Parameters:
    
    backoffIncrement - the value to set
    
    Returns:
    
    the dsl builder
  - backoffIncrement
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder backoffIncrement(String backoffIncrement)
```
    Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. The option will be converted to a <code>long</code> type. Default: 1000 Group: common
    
    Parameters:
    
    backoffIncrement - the value to set
    
    Returns:
    
    the dsl builder
  - batchId
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder batchId(String batchId)
```
    Bulk API Batch ID. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    batchId - the value to set
    
    Returns:
    
    the dsl builder
  - contentType
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder contentType(SalesforceEndpointBuilderFactory.ContentType contentType)
```
    Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV. The option is a: <code>org.apache.camel.component.salesforce.api.dto.bulk.ContentType</code> type. Group: common
    
    Parameters:
    
    contentType - the value to set
    
    Returns:
    
    the dsl builder
  - contentType
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder contentType(String contentType)
```
    Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV. The option will be converted to a <code>org.apache.camel.component.salesforce.api.dto.bulk.ContentType</code> type. Group: common
    
    Parameters:
    
    contentType - the value to set
    
    Returns:
    
    the dsl builder
  - defaultReplayId
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder defaultReplayId(Long defaultReplayId)
```
    Default replayId setting if no value is found in initialReplayIdMap. The option is a: <code>java.lang.Long</code> type. Default: -1 Group: common
    
    Parameters:
    
    defaultReplayId - the value to set
    
    Returns:
    
    the dsl builder
  - defaultReplayId
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder defaultReplayId(String defaultReplayId)
```
    Default replayId setting if no value is found in initialReplayIdMap. The option will be converted to a <code>java.lang.Long</code> type. Default: -1 Group: common
    
    Parameters:
    
    defaultReplayId - the value to set
    
    Returns:
    
    the dsl builder
  - fallBackReplayId
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder fallBackReplayId(Long fallBackReplayId)
```
    ReplayId to fall back to after an Invalid Replay Id response. The option is a: <code>java.lang.Long</code> type. Default: -1 Group: common
    
    Parameters:
    
    fallBackReplayId - the value to set
    
    Returns:
    
    the dsl builder
  - fallBackReplayId
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder fallBackReplayId(String fallBackReplayId)
```
    ReplayId to fall back to after an Invalid Replay Id response. The option will be converted to a <code>java.lang.Long</code> type. Default: -1 Group: common
    
    Parameters:
    
    fallBackReplayId - the value to set
    
    Returns:
    
    the dsl builder
  - format
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder format(SalesforceEndpointBuilderFactory.PayloadFormat format)
```
    Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON. As of Camel 3.12, this option only applies to the Raw operation. The option is a: <code>org.apache.camel.component.salesforce.internal.PayloadFormat</code> type. Group: common
    
    Parameters:
    
    format - the value to set
    
    Returns:
    
    the dsl builder
  - format
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder format(String format)
```
    Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON. As of Camel 3.12, this option only applies to the Raw operation. The option will be converted to a <code>org.apache.camel.component.salesforce.internal.PayloadFormat</code> type. Group: common
    
    Parameters:
    
    format - the value to set
    
    Returns:
    
    the dsl builder
  - httpClient
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder httpClient(Object httpClient)
```
    Custom Jetty Http Client to use to connect to Salesforce. The option is a: <code>org.apache.camel.component.salesforce.SalesforceHttpClient</code> type. Group: common
    
    Parameters:
    
    httpClient - the value to set
    
    Returns:
    
    the dsl builder
  - httpClient
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder httpClient(String httpClient)
```
    Custom Jetty Http Client to use to connect to Salesforce. The option will be converted to a <code>org.apache.camel.component.salesforce.SalesforceHttpClient</code> type. Group: common
    
    Parameters:
    
    httpClient - the value to set
    
    Returns:
    
    the dsl builder
  - includeDetails
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder includeDetails(Boolean includeDetails)
```
    Include details in Salesforce1 Analytics report, defaults to false. The option is a: <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    includeDetails - the value to set
    
    Returns:
    
    the dsl builder
  - includeDetails
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder includeDetails(String includeDetails)
```
    Include details in Salesforce1 Analytics report, defaults to false. The option will be converted to a <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    includeDetails - the value to set
    
    Returns:
    
    the dsl builder
  - initialReplayIdMap
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder initialReplayIdMap(Map<String,Long> initialReplayIdMap)
```
    Replay IDs to start from per channel name. The option is a: <code>java.util.Map<java.lang.String, java.lang.Long></code> type. Group: common
    
    Parameters:
    
    initialReplayIdMap - the value to set
    
    Returns:
    
    the dsl builder
  - initialReplayIdMap
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder initialReplayIdMap(String initialReplayIdMap)
```
    Replay IDs to start from per channel name. The option will be converted to a <code>java.util.Map<java.lang.String, java.lang.Long></code> type. Group: common
    
    Parameters:
    
    initialReplayIdMap - the value to set
    
    Returns:
    
    the dsl builder
  - instanceId
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder instanceId(String instanceId)
```
    Salesforce1 Analytics report execution instance ID. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    instanceId - the value to set
    
    Returns:
    
    the dsl builder
  - jobId
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder jobId(String jobId)
```
    Bulk API Job ID. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    jobId - the value to set
    
    Returns:
    
    the dsl builder
  - limit
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder limit(Integer limit)
```
    Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation. The option is a: <code>java.lang.Integer</code> type. Group: common
    
    Parameters:
    
    limit - the value to set
    
    Returns:
    
    the dsl builder
  - limit
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder limit(String limit)
```
    Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation. The option will be converted to a <code>java.lang.Integer</code> type. Group: common
    
    Parameters:
    
    limit - the value to set
    
    Returns:
    
    the dsl builder
  - locator
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder locator(String locator)
```
    Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    locator - the value to set
    
    Returns:
    
    the dsl builder
  - maxBackoff
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder maxBackoff(long maxBackoff)
```
    Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. The option is a: <code>long</code> type. Default: 30000 Group: common
    
    Parameters:
    
    maxBackoff - the value to set
    
    Returns:
    
    the dsl builder
  - maxBackoff
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder maxBackoff(String maxBackoff)
```
    Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. The option will be converted to a <code>long</code> type. Default: 30000 Group: common
    
    Parameters:
    
    maxBackoff - the value to set
    
    Returns:
    
    the dsl builder
  - maxRecords
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder maxRecords(Integer maxRecords)
```
    The maximum number of records to retrieve per set of results for a Bulk 2.0 Query. The request is still subject to the size limits. If you are working with a very large number of query results, you may experience a timeout before receiving all the data from Salesforce. To prevent a timeout, specify the maximum number of records your client is expecting to receive in the maxRecords parameter. This splits the results into smaller sets with this value as the maximum size. The option is a: <code>java.lang.Integer</code> type. Group: common
    
    Parameters:
    
    maxRecords - the value to set
    
    Returns:
    
    the dsl builder
  - maxRecords
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder maxRecords(String maxRecords)
```
    The maximum number of records to retrieve per set of results for a Bulk 2.0 Query. The request is still subject to the size limits. If you are working with a very large number of query results, you may experience a timeout before receiving all the data from Salesforce. To prevent a timeout, specify the maximum number of records your client is expecting to receive in the maxRecords parameter. This splits the results into smaller sets with this value as the maximum size. The option will be converted to a <code>java.lang.Integer</code> type. Group: common
    
    Parameters:
    
    maxRecords - the value to set
    
    Returns:
    
    the dsl builder
  - notFoundBehaviour
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notFoundBehaviour(SalesforceEndpointBuilderFactory.NotFoundBehaviour notFoundBehaviour)
```
    Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULL NotFoundBehaviour#NULL or should a exception be signaled on the exchange NotFoundBehaviour#EXCEPTION - the default. The option is a: <code>org.apache.camel.component.salesforce.NotFoundBehaviour</code> type. Default: EXCEPTION Group: common
    
    Parameters:
    
    notFoundBehaviour - the value to set
    
    Returns:
    
    the dsl builder
  - notFoundBehaviour
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notFoundBehaviour(String notFoundBehaviour)
```
    Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULL NotFoundBehaviour#NULL or should a exception be signaled on the exchange NotFoundBehaviour#EXCEPTION - the default. The option will be converted to a <code>org.apache.camel.component.salesforce.NotFoundBehaviour</code> type. Default: EXCEPTION Group: common
    
    Parameters:
    
    notFoundBehaviour - the value to set
    
    Returns:
    
    the dsl builder
  - notifyForFields
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notifyForFields(SalesforceEndpointBuilderFactory.NotifyForFieldsEnum notifyForFields)
```
    Notify for fields, options are ALL, REFERENCED, SELECT, WHERE. The option is a: <code>org.apache.camel.component.salesforce.internal.dto.NotifyForFieldsEnum</code> type. Group: common
    
    Parameters:
    
    notifyForFields - the value to set
    
    Returns:
    
    the dsl builder
  - notifyForFields
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notifyForFields(String notifyForFields)
```
    Notify for fields, options are ALL, REFERENCED, SELECT, WHERE. The option will be converted to a <code>org.apache.camel.component.salesforce.internal.dto.NotifyForFieldsEnum</code> type. Group: common
    
    Parameters:
    
    notifyForFields - the value to set
    
    Returns:
    
    the dsl builder
  - notifyForOperationCreate
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notifyForOperationCreate(Boolean notifyForOperationCreate)
```
    Notify for create operation, defaults to false (API version = 29.0). The option is a: <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    notifyForOperationCreate - the value to set
    
    Returns:
    
    the dsl builder
  - notifyForOperationCreate
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notifyForOperationCreate(String notifyForOperationCreate)
```
    Notify for create operation, defaults to false (API version = 29.0). The option will be converted to a <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    notifyForOperationCreate - the value to set
    
    Returns:
    
    the dsl builder
  - notifyForOperationDelete
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notifyForOperationDelete(Boolean notifyForOperationDelete)
```
    Notify for delete operation, defaults to false (API version = 29.0). The option is a: <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    notifyForOperationDelete - the value to set
    
    Returns:
    
    the dsl builder
  - notifyForOperationDelete
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notifyForOperationDelete(String notifyForOperationDelete)
```
    Notify for delete operation, defaults to false (API version = 29.0). The option will be converted to a <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    notifyForOperationDelete - the value to set
    
    Returns:
    
    the dsl builder
  - notifyForOperations
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notifyForOperations(SalesforceEndpointBuilderFactory.NotifyForOperationsEnum notifyForOperations)
```
    Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version 29.0). The option is a: <code>org.apache.camel.component.salesforce.internal.dto.NotifyForOperationsEnum</code> type. Group: common
    
    Parameters:
    
    notifyForOperations - the value to set
    
    Returns:
    
    the dsl builder
  - notifyForOperations
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notifyForOperations(String notifyForOperations)
```
    Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version 29.0). The option will be converted to a <code>org.apache.camel.component.salesforce.internal.dto.NotifyForOperationsEnum</code> type. Group: common
    
    Parameters:
    
    notifyForOperations - the value to set
    
    Returns:
    
    the dsl builder
  - notifyForOperationUndelete
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notifyForOperationUndelete(Boolean notifyForOperationUndelete)
```
    Notify for un-delete operation, defaults to false (API version = 29.0). The option is a: <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    notifyForOperationUndelete - the value to set
    
    Returns:
    
    the dsl builder
  - notifyForOperationUndelete
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notifyForOperationUndelete(String notifyForOperationUndelete)
```
    Notify for un-delete operation, defaults to false (API version = 29.0). The option will be converted to a <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    notifyForOperationUndelete - the value to set
    
    Returns:
    
    the dsl builder
  - notifyForOperationUpdate
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notifyForOperationUpdate(Boolean notifyForOperationUpdate)
```
    Notify for update operation, defaults to false (API version = 29.0). The option is a: <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    notifyForOperationUpdate - the value to set
    
    Returns:
    
    the dsl builder
  - notifyForOperationUpdate
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder notifyForOperationUpdate(String notifyForOperationUpdate)
```
    Notify for update operation, defaults to false (API version = 29.0). The option will be converted to a <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    notifyForOperationUpdate - the value to set
    
    Returns:
    
    the dsl builder
  - objectMapper
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder objectMapper(Object objectMapper)
```
    Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. The option is a: <code>com.fasterxml.jackson.databind.ObjectMapper</code> type. Group: common
    
    Parameters:
    
    objectMapper - the value to set
    
    Returns:
    
    the dsl builder
  - objectMapper
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder objectMapper(String objectMapper)
```
    Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. The option will be converted to a <code>com.fasterxml.jackson.databind.ObjectMapper</code> type. Group: common
    
    Parameters:
    
    objectMapper - the value to set
    
    Returns:
    
    the dsl builder
  - pkChunking
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder pkChunking(Boolean pkChunking)
```
    Use PK Chunking. Only for use in original Bulk API. Bulk 2.0 API performs PK chunking automatically, if necessary. The option is a: <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    pkChunking - the value to set
    
    Returns:
    
    the dsl builder
  - pkChunking
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder pkChunking(String pkChunking)
```
    Use PK Chunking. Only for use in original Bulk API. Bulk 2.0 API performs PK chunking automatically, if necessary. The option will be converted to a <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    pkChunking - the value to set
    
    Returns:
    
    the dsl builder
  - pkChunkingChunkSize
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder pkChunkingChunkSize(Integer pkChunkingChunkSize)
```
    Chunk size for use with PK Chunking. If unspecified, salesforce default is 100,000. Maximum size is 250,000. The option is a: <code>java.lang.Integer</code> type. Group: common
    
    Parameters:
    
    pkChunkingChunkSize - the value to set
    
    Returns:
    
    the dsl builder
  - pkChunkingChunkSize
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder pkChunkingChunkSize(String pkChunkingChunkSize)
```
    Chunk size for use with PK Chunking. If unspecified, salesforce default is 100,000. Maximum size is 250,000. The option will be converted to a <code>java.lang.Integer</code> type. Group: common
    
    Parameters:
    
    pkChunkingChunkSize - the value to set
    
    Returns:
    
    the dsl builder
  - pkChunkingParent
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder pkChunkingParent(String pkChunkingParent)
```
    Specifies the parent object when you're enabling PK chunking for queries on sharing objects. The chunks are based on the parent object's records rather than the sharing object's records. For example, when querying on AccountShare, specify Account as the parent object. PK chunking is supported for sharing objects as long as the parent object is supported. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    pkChunkingParent - the value to set
    
    Returns:
    
    the dsl builder
  - pkChunkingStartRow
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder pkChunkingStartRow(String pkChunkingStartRow)
```
    Specifies the 15-character or 18-character record ID to be used as the lower boundary for the first chunk. Use this parameter to specify a starting ID when restarting a job that failed between batches. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    pkChunkingStartRow - the value to set
    
    Returns:
    
    the dsl builder
  - queryLocator
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder queryLocator(String queryLocator)
```
    Query Locator provided by salesforce for use when a query results in more records than can be retrieved in a single call. Use this value in a subsequent call to retrieve additional records. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    queryLocator - the value to set
    
    Returns:
    
    the dsl builder
  - rawPayload
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder rawPayload(boolean rawPayload)
```
    Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default. The option is a: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    rawPayload - the value to set
    
    Returns:
    
    the dsl builder
  - rawPayload
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder rawPayload(String rawPayload)
```
    Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default. The option will be converted to a <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    rawPayload - the value to set
    
    Returns:
    
    the dsl builder
  - reportId
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder reportId(String reportId)
```
    Salesforce1 Analytics report Id. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    reportId - the value to set
    
    Returns:
    
    the dsl builder
  - reportMetadata
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder reportMetadata(Object reportMetadata)
```
    Salesforce1 Analytics report metadata for filtering. The option is a: <code>org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata</code> type. Group: common
    
    Parameters:
    
    reportMetadata - the value to set
    
    Returns:
    
    the dsl builder
  - reportMetadata
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder reportMetadata(String reportMetadata)
```
    Salesforce1 Analytics report metadata for filtering. The option will be converted to a <code>org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata</code> type. Group: common
    
    Parameters:
    
    reportMetadata - the value to set
    
    Returns:
    
    the dsl builder
  - resultId
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder resultId(String resultId)
```
    Bulk API Result ID. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    resultId - the value to set
    
    Returns:
    
    the dsl builder
  - sObjectBlobFieldName
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder sObjectBlobFieldName(String sObjectBlobFieldName)
```
    SObject blob field name. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    sObjectBlobFieldName - the value to set
    
    Returns:
    
    the dsl builder
  - sObjectClass
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder sObjectClass(String sObjectClass)
```
    Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    sObjectClass - the value to set
    
    Returns:
    
    the dsl builder
  - sObjectFields
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder sObjectFields(String sObjectFields)
```
    SObject fields to retrieve. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    sObjectFields - the value to set
    
    Returns:
    
    the dsl builder
  - sObjectId
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder sObjectId(String sObjectId)
```
    SObject ID if required by API. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    sObjectId - the value to set
    
    Returns:
    
    the dsl builder
  - sObjectIdName
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder sObjectIdName(String sObjectIdName)
```
    SObject external ID field name. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    sObjectIdName - the value to set
    
    Returns:
    
    the dsl builder
  - sObjectIdValue
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder sObjectIdValue(String sObjectIdValue)
```
    SObject external ID field value. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    sObjectIdValue - the value to set
    
    Returns:
    
    the dsl builder
  - sObjectName
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder sObjectName(String sObjectName)
```
    SObject name if required or supported by API. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    sObjectName - the value to set
    
    Returns:
    
    the dsl builder
  - sObjectQuery
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder sObjectQuery(String sObjectQuery)
```
    Salesforce SOQL query string. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    sObjectQuery - the value to set
    
    Returns:
    
    the dsl builder
  - sObjectSearch
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder sObjectSearch(String sObjectSearch)
```
    Salesforce SOSL search string. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    sObjectSearch - the value to set
    
    Returns:
    
    the dsl builder
  - updateTopic
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder updateTopic(boolean updateTopic)
```
    Whether to update an existing Push Topic when using the Streaming API, defaults to false. The option is a: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    updateTopic - the value to set
    
    Returns:
    
    the dsl builder
  - updateTopic
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder updateTopic(String updateTopic)
```
    Whether to update an existing Push Topic when using the Streaming API, defaults to false. The option will be converted to a <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    updateTopic - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    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 or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
```
    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 or ERROR level and ignored. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - replayId
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder replayId(Long replayId)
```
    The replayId value to use when subscribing. The option is a: <code>java.lang.Long</code> type. Group: consumer
    
    Parameters:
    
    replayId - the value to set
    
    Returns:
    
    the dsl builder
  - replayId
```
default SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder replayId(String replayId)
```
    The replayId value to use when subscribing. The option will be converted to a <code>java.lang.Long</code> type. Group: consumer
    
    Parameters:
    
    replayId - the value to set
    
    Returns:
    
    the dsl builder

Interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

apexMethod

apexQueryParams

apexQueryParams

apiVersion

backoffIncrement

backoffIncrement

batchId

contentType

contentType

defaultReplayId

defaultReplayId

fallBackReplayId

fallBackReplayId

format

format

httpClient

httpClient

includeDetails

includeDetails

initialReplayIdMap

initialReplayIdMap

instanceId

jobId

limit

limit

locator

maxBackoff

maxBackoff

maxRecords

maxRecords

notFoundBehaviour

notFoundBehaviour

notifyForFields

notifyForFields

notifyForOperationCreate

notifyForOperationCreate

notifyForOperationDelete

notifyForOperationDelete

notifyForOperations

notifyForOperations

notifyForOperationUndelete

notifyForOperationUndelete

notifyForOperationUpdate

notifyForOperationUpdate

objectMapper

objectMapper

pkChunking

pkChunking

pkChunkingChunkSize

pkChunkingChunkSize

pkChunkingParent

pkChunkingStartRow

queryLocator

rawPayload

rawPayload

reportId

reportMetadata

reportMetadata

resultId

sObjectBlobFieldName

sObjectClass

sObjectFields

sObjectId

sObjectIdName

sObjectIdValue

sObjectName

sObjectQuery

sObjectSearch

updateTopic

updateTopic

bridgeErrorHandler

bridgeErrorHandler

replayId

replayId