Interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder
- Enclosing interface:
- SalesforceEndpointBuilderFactory
public static interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the Salesforce component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default SalesforceEndpointBuilderFactory.AdvancedSalesforceEndpointProducerBuilder
advanced()
default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
allOrNone(boolean allOrNone)
Composite API option to indicate to rollback all records if any are not successful.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
allOrNone(String allOrNone)
Composite API option to indicate to rollback all records if any are not successful.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
apexMethod(String apexMethod)
APEX method name.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
apexQueryParams(String apexQueryParams)
Query params for APEX method.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
apexQueryParams(Map<String,Object> apexQueryParams)
Query params for APEX method.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
apexUrl(String apexUrl)
APEX method URL.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
apiVersion(String apiVersion)
Salesforce API version.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
backoffIncrement(long backoffIncrement)
Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
backoffIncrement(String backoffIncrement)
Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
batchId(String batchId)
Bulk API Batch ID.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
compositeMethod(String compositeMethod)
Composite (raw) method.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
contentType(String contentType)
Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
contentType(org.apache.camel.component.salesforce.api.dto.bulk.ContentType contentType)
Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
defaultReplayId(Long defaultReplayId)
Default replayId setting if no value is found in initialReplayIdMap.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
defaultReplayId(String defaultReplayId)
Default replayId setting if no value is found in initialReplayIdMap.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
fallBackReplayId(Long fallBackReplayId)
ReplayId to fall back to after an Invalid Replay Id response.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
fallBackReplayId(String fallBackReplayId)
ReplayId to fall back to after an Invalid Replay Id response.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
format(String format)
Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
format(org.apache.camel.component.salesforce.internal.PayloadFormat format)
Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
httpClient(String httpClient)
Custom Jetty Http Client to use to connect to Salesforce.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
httpClient(org.apache.camel.component.salesforce.SalesforceHttpClient httpClient)
Custom Jetty Http Client to use to connect to Salesforce.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
includeDetails(Boolean includeDetails)
Include details in Salesforce1 Analytics report, defaults to false.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
includeDetails(String includeDetails)
Include details in Salesforce1 Analytics report, defaults to false.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
initialReplayIdMap(String initialReplayIdMap)
Replay IDs to start from per channel name.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
initialReplayIdMap(Map<String,Long> initialReplayIdMap)
Replay IDs to start from per channel name.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
instanceId(String instanceId)
Salesforce1 Analytics report execution instance ID.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
jobId(String jobId)
Bulk API Job ID.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message).default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
limit(Integer limit)
Limit on number of returned records.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
limit(String limit)
Limit on number of returned records.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
locator(String locator)
Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
maxBackoff(long maxBackoff)
Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
maxBackoff(String maxBackoff)
Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
maxRecords(Integer maxRecords)
The maximum number of records to retrieve per set of results for a Bulk 2.0 Query.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
maxRecords(String maxRecords)
The maximum number of records to retrieve per set of results for a Bulk 2.0 Query.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notFoundBehaviour(String notFoundBehaviour)
Sets the behaviour of 404 not found status received from Salesforce API.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notFoundBehaviour(org.apache.camel.component.salesforce.NotFoundBehaviour notFoundBehaviour)
Sets the behaviour of 404 not found status received from Salesforce API.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notifyForFields(String notifyForFields)
Notify for fields, options are ALL, REFERENCED, SELECT, WHERE.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notifyForFields(org.apache.camel.component.salesforce.internal.dto.NotifyForFieldsEnum notifyForFields)
Notify for fields, options are ALL, REFERENCED, SELECT, WHERE.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notifyForOperationCreate(Boolean notifyForOperationCreate)
Notify for create operation, defaults to false (API version &gt;= 29.0).default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notifyForOperationCreate(String notifyForOperationCreate)
Notify for create operation, defaults to false (API version &gt;= 29.0).default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notifyForOperationDelete(Boolean notifyForOperationDelete)
Notify for delete operation, defaults to false (API version &gt;= 29.0).default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notifyForOperationDelete(String notifyForOperationDelete)
Notify for delete operation, defaults to false (API version &gt;= 29.0).default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notifyForOperations(String notifyForOperations)
Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version &lt; 29.0).default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notifyForOperations(org.apache.camel.component.salesforce.internal.dto.NotifyForOperationsEnum notifyForOperations)
Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version &lt; 29.0).default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notifyForOperationUndelete(Boolean notifyForOperationUndelete)
Notify for un-delete operation, defaults to false (API version &gt;= 29.0).default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notifyForOperationUndelete(String notifyForOperationUndelete)
Notify for un-delete operation, defaults to false (API version &gt;= 29.0).default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notifyForOperationUpdate(Boolean notifyForOperationUpdate)
Notify for update operation, defaults to false (API version &gt;= 29.0).default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
notifyForOperationUpdate(String notifyForOperationUpdate)
Notify for update operation, defaults to false (API version &gt;= 29.0).default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
objectMapper(String objectMapper)
Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
pkChunking(Boolean pkChunking)
Use PK Chunking.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
pkChunking(String pkChunking)
Use PK Chunking.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
pkChunkingChunkSize(Integer pkChunkingChunkSize)
Chunk size for use with PK Chunking.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
pkChunkingChunkSize(String pkChunkingChunkSize)
Chunk size for use with PK Chunking.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
pkChunkingParent(String pkChunkingParent)
Specifies the parent object when you're enabling PK chunking for queries on sharing objects.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
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.SalesforceEndpointProducerBuilder
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.SalesforceEndpointProducerBuilder
rawHttpHeaders(String rawHttpHeaders)
Comma separated list of message headers to include as HTTP parameters for Raw operation.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
rawMethod(String rawMethod)
HTTP method to use for the Raw operation.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
rawPath(String rawPath)
The portion of the endpoint URL after the domain name.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
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.SalesforceEndpointProducerBuilder
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.SalesforceEndpointProducerBuilder
rawQueryParameters(String rawQueryParameters)
Comma separated list of message headers to include as query parameters for Raw operation.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
reportId(String reportId)
Salesforce1 Analytics report Id.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
reportMetadata(String reportMetadata)
Salesforce1 Analytics report metadata for filtering.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
reportMetadata(org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata reportMetadata)
Salesforce1 Analytics report metadata for filtering.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
resultId(String resultId)
Bulk API Result ID.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
sObjectBlobFieldName(String sObjectBlobFieldName)
SObject blob field name.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
sObjectClass(String sObjectClass)
Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
sObjectFields(String sObjectFields)
SObject fields to retrieve.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
sObjectId(String sObjectId)
SObject ID if required by API.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
sObjectIdName(String sObjectIdName)
SObject external ID field name.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
sObjectIdValue(String sObjectIdValue)
SObject external ID field value.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
sObjectName(String sObjectName)
SObject name if required or supported by API.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
sObjectQuery(String sObjectQuery)
Salesforce SOQL query string.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
sObjectSearch(String sObjectSearch)
Salesforce SOSL search string.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
updateTopic(boolean updateTopic)
Whether to update an existing Push Topic when using the Streaming API, defaults to false.default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder
updateTopic(String updateTopic)
Whether to update an existing Push Topic when using the Streaming API, defaults to false.
-
-
-
Method Detail
-
advanced
default SalesforceEndpointBuilderFactory.AdvancedSalesforceEndpointProducerBuilder advanced()
-
apexMethod
default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder contentType(org.apache.camel.component.salesforce.api.dto.bulk.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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder format(org.apache.camel.component.salesforce.internal.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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder httpClient(org.apache.camel.component.salesforce.SalesforceHttpClient 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder notFoundBehaviour(org.apache.camel.component.salesforce.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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder notifyForFields(org.apache.camel.component.salesforce.internal.dto.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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder notifyForOperationCreate(Boolean notifyForOperationCreate)
Notify for create operation, defaults to false (API version &gt;= 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.SalesforceEndpointProducerBuilder notifyForOperationCreate(String notifyForOperationCreate)
Notify for create operation, defaults to false (API version &gt;= 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.SalesforceEndpointProducerBuilder notifyForOperationDelete(Boolean notifyForOperationDelete)
Notify for delete operation, defaults to false (API version &gt;= 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.SalesforceEndpointProducerBuilder notifyForOperationDelete(String notifyForOperationDelete)
Notify for delete operation, defaults to false (API version &gt;= 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.SalesforceEndpointProducerBuilder notifyForOperations(org.apache.camel.component.salesforce.internal.dto.NotifyForOperationsEnum notifyForOperations)
Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version &lt; 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.SalesforceEndpointProducerBuilder notifyForOperations(String notifyForOperations)
Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version &lt; 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.SalesforceEndpointProducerBuilder notifyForOperationUndelete(Boolean notifyForOperationUndelete)
Notify for un-delete operation, defaults to false (API version &gt;= 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.SalesforceEndpointProducerBuilder notifyForOperationUndelete(String notifyForOperationUndelete)
Notify for un-delete operation, defaults to false (API version &gt;= 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.SalesforceEndpointProducerBuilder notifyForOperationUpdate(Boolean notifyForOperationUpdate)
Notify for update operation, defaults to false (API version &gt;= 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.SalesforceEndpointProducerBuilder notifyForOperationUpdate(String notifyForOperationUpdate)
Notify for update operation, defaults to false (API version &gt;= 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.SalesforceEndpointProducerBuilder objectMapper(com.fasterxml.jackson.databind.ObjectMapper 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder reportMetadata(org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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.SalesforceEndpointProducerBuilder 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
-
allOrNone
default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder allOrNone(boolean allOrNone)
Composite API option to indicate to rollback all records if any are not successful. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
allOrNone
- the value to set- Returns:
- the dsl builder
-
allOrNone
default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder allOrNone(String allOrNone)
Composite API option to indicate to rollback all records if any are not successful. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
allOrNone
- the value to set- Returns:
- the dsl builder
-
apexUrl
default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder apexUrl(String apexUrl)
APEX method URL. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
apexUrl
- the value to set- Returns:
- the dsl builder
-
compositeMethod
default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder compositeMethod(String compositeMethod)
Composite (raw) method. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
compositeMethod
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
rawHttpHeaders
default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder rawHttpHeaders(String rawHttpHeaders)
Comma separated list of message headers to include as HTTP parameters for Raw operation. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
rawHttpHeaders
- the value to set- Returns:
- the dsl builder
-
rawMethod
default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder rawMethod(String rawMethod)
HTTP method to use for the Raw operation. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
rawMethod
- the value to set- Returns:
- the dsl builder
-
rawPath
default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder rawPath(String rawPath)
The portion of the endpoint URL after the domain name. E.g., '/services/data/v52.0/sobjects/Account/'. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
rawPath
- the value to set- Returns:
- the dsl builder
-
rawQueryParameters
default SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder rawQueryParameters(String rawQueryParameters)
Comma separated list of message headers to include as query parameters for Raw operation. Do not url-encode values as this will be done automatically. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
rawQueryParameters
- the value to set- Returns:
- the dsl builder
-
-