Package org.apache.camel.builder.endpoint.dsl

Interface SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder, SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Enclosing interface:

SalesforceEndpointBuilderFactory

public static interface SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder
extends SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder, SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Builder for endpoint for the Salesforce component.

Method Summary

Modifier and Type	Method	Description
default SalesforceEndpointBuilderFactory.AdvancedSalesforceEndpointBuilder	advanced()
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	apexMethod(String apexMethod)	APEX method name.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	apexQueryParams(String apexQueryParams)	Query params for APEX method.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	apexQueryParams(Map<String,Object> apexQueryParams)	Query params for APEX method.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	apiVersion(String apiVersion)	Salesforce API version.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	backoffIncrement(long backoffIncrement)	Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	backoffIncrement(String backoffIncrement)	Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	batchId(String batchId)	Bulk API Batch ID.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	contentType(String contentType)	Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	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.SalesforceEndpointBuilder	defaultReplayId(Long defaultReplayId)	Default replayId setting if no value is found in initialReplayIdMap.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	defaultReplayId(String defaultReplayId)	Default replayId setting if no value is found in initialReplayIdMap.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	fallBackReplayId(Long fallBackReplayId)	ReplayId to fall back to after an Invalid Replay Id response.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	fallBackReplayId(String fallBackReplayId)	ReplayId to fall back to after an Invalid Replay Id response.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	format(String format)	Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	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.SalesforceEndpointBuilder	httpClient(String httpClient)	Custom Jetty Http Client to use to connect to Salesforce.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	httpClient(org.apache.camel.component.salesforce.SalesforceHttpClient httpClient)	Custom Jetty Http Client to use to connect to Salesforce.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	includeDetails(Boolean includeDetails)	Include details in Salesforce1 Analytics report, defaults to false.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	includeDetails(String includeDetails)	Include details in Salesforce1 Analytics report, defaults to false.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	initialReplayIdMap(String initialReplayIdMap)	Replay IDs to start from per channel name.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	initialReplayIdMap(Map<String,Long> initialReplayIdMap)	Replay IDs to start from per channel name.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	instanceId(String instanceId)	Salesforce1 Analytics report execution instance ID.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	jobId(String jobId)	Bulk API Job ID.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	limit(Integer limit)	Limit on number of returned records.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	limit(String limit)	Limit on number of returned records.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	locator(String locator)	Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	maxBackoff(long maxBackoff)	Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	maxBackoff(String maxBackoff)	Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	maxRecords(Integer maxRecords)	The maximum number of records to retrieve per set of results for a Bulk 2.0 Query.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	maxRecords(String maxRecords)	The maximum number of records to retrieve per set of results for a Bulk 2.0 Query.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notFoundBehaviour(String notFoundBehaviour)	Sets the behaviour of 404 not found status received from Salesforce API.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notFoundBehaviour(org.apache.camel.component.salesforce.NotFoundBehaviour notFoundBehaviour)	Sets the behaviour of 404 not found status received from Salesforce API.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notifyForFields(String notifyForFields)	Notify for fields, options are ALL, REFERENCED, SELECT, WHERE.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notifyForFields(org.apache.camel.component.salesforce.internal.dto.NotifyForFieldsEnum notifyForFields)	Notify for fields, options are ALL, REFERENCED, SELECT, WHERE.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notifyForOperationCreate(Boolean notifyForOperationCreate)	Notify for create operation, defaults to false (API version &amp;gt;= 29.0).
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notifyForOperationCreate(String notifyForOperationCreate)	Notify for create operation, defaults to false (API version &amp;gt;= 29.0).
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notifyForOperationDelete(Boolean notifyForOperationDelete)	Notify for delete operation, defaults to false (API version &amp;gt;= 29.0).
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notifyForOperationDelete(String notifyForOperationDelete)	Notify for delete operation, defaults to false (API version &amp;gt;= 29.0).
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notifyForOperations(String notifyForOperations)	Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version &amp;lt; 29.0).
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notifyForOperations(org.apache.camel.component.salesforce.internal.dto.NotifyForOperationsEnum notifyForOperations)	Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version &amp;lt; 29.0).
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notifyForOperationUndelete(Boolean notifyForOperationUndelete)	Notify for un-delete operation, defaults to false (API version &amp;gt;= 29.0).
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notifyForOperationUndelete(String notifyForOperationUndelete)	Notify for un-delete operation, defaults to false (API version &amp;gt;= 29.0).
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notifyForOperationUpdate(Boolean notifyForOperationUpdate)	Notify for update operation, defaults to false (API version &amp;gt;= 29.0).
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	notifyForOperationUpdate(String notifyForOperationUpdate)	Notify for update operation, defaults to false (API version &amp;gt;= 29.0).
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	objectMapper(String objectMapper)	Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	pkChunking(Boolean pkChunking)	Use PK Chunking.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	pkChunking(String pkChunking)	Use PK Chunking.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	pkChunkingChunkSize(Integer pkChunkingChunkSize)	Chunk size for use with PK Chunking.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	pkChunkingChunkSize(String pkChunkingChunkSize)	Chunk size for use with PK Chunking.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	pkChunkingParent(String pkChunkingParent)	Specifies the parent object when you're enabling PK chunking for queries on sharing objects.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	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.SalesforceEndpointBuilder	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.SalesforceEndpointBuilder	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.SalesforceEndpointBuilder	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.SalesforceEndpointBuilder	reportId(String reportId)	Salesforce1 Analytics report Id.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	reportMetadata(String reportMetadata)	Salesforce1 Analytics report metadata for filtering.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	reportMetadata(org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata reportMetadata)	Salesforce1 Analytics report metadata for filtering.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	resultId(String resultId)	Bulk API Result ID.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	sObjectBlobFieldName(String sObjectBlobFieldName)	SObject blob field name.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	sObjectClass(String sObjectClass)	Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	sObjectFields(String sObjectFields)	SObject fields to retrieve.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	sObjectId(String sObjectId)	SObject ID if required by API.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	sObjectIdName(String sObjectIdName)	SObject external ID field name.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	sObjectIdValue(String sObjectIdValue)	SObject external ID field value.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	sObjectName(String sObjectName)	SObject name if required or supported by API.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	sObjectQuery(String sObjectQuery)	Salesforce SOQL query string.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	sObjectSearch(String sObjectSearch)	Salesforce SOSL search string.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	streamQueryResult(Boolean streamQueryResult)	If true, streams SOQL query result and transparently handles subsequent requests if there are multiple pages.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	streamQueryResult(String streamQueryResult)	If true, streams SOQL query result and transparently handles subsequent requests if there are multiple pages.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	updateTopic(boolean updateTopic)	Whether to update an existing Push Topic when using the Streaming API, defaults to false.
default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder	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, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

replayId, replayId

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

allOrNone, allOrNone, apexUrl, compositeMethod, rawHttpHeaders, rawMethod, rawPath, rawQueryParameters

Method Detail

advanced

default SalesforceEndpointBuilderFactory.AdvancedSalesforceEndpointBuilder advanced()

Specified by:

advanced in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

advanced in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

apexMethod

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder apexMethod(String apexMethod)

APEX method name. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

apexMethod in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

apexMethod in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

apexMethod - the value to set

Returns:

the dsl builder

apexQueryParams

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder apexQueryParams(Map<String,Object> apexQueryParams)

Query params for APEX method. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. Group: common

Specified by:

apexQueryParams in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

apexQueryParams in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

apexQueryParams - the value to set

Returns:

the dsl builder

apexQueryParams

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder apexQueryParams(String apexQueryParams)

Query params for APEX method. The option will be converted to a <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. Group: common

Specified by:

apexQueryParams in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

apexQueryParams in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

apexQueryParams - the value to set

Returns:

the dsl builder

apiVersion

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder apiVersion(String apiVersion)

Salesforce API version. The option is a: <code>java.lang.String</code> type. Default: 56.0 Group: common

Specified by:

apiVersion in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

apiVersion in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

apiVersion - the value to set

Returns:

the dsl builder

backoffIncrement

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

backoffIncrement in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

backoffIncrement in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

backoffIncrement - the value to set

Returns:

the dsl builder

backoffIncrement

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

backoffIncrement in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

backoffIncrement in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

backoffIncrement - the value to set

Returns:

the dsl builder

batchId

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder batchId(String batchId)

Bulk API Batch ID. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

batchId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

batchId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

batchId - the value to set

Returns:

the dsl builder

contentType

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

contentType in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

contentType in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

contentType - the value to set

Returns:

the dsl builder

contentType

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

contentType in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

contentType in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

contentType - the value to set

Returns:

the dsl builder

defaultReplayId

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

defaultReplayId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

defaultReplayId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

defaultReplayId - the value to set

Returns:

the dsl builder

defaultReplayId

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

defaultReplayId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

defaultReplayId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

defaultReplayId - the value to set

Returns:

the dsl builder

fallBackReplayId

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

fallBackReplayId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

fallBackReplayId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

fallBackReplayId - the value to set

Returns:

the dsl builder

fallBackReplayId

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

fallBackReplayId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

fallBackReplayId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

fallBackReplayId - the value to set

Returns:

the dsl builder

format

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

format in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

format in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

format - the value to set

Returns:

the dsl builder

format

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

format in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

format in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

format - the value to set

Returns:

the dsl builder

httpClient

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

httpClient in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

httpClient in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

httpClient - the value to set

Returns:

the dsl builder

httpClient

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

httpClient in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

httpClient in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

httpClient - the value to set

Returns:

the dsl builder

includeDetails

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder includeDetails(Boolean includeDetails)

Include details in Salesforce1 Analytics report, defaults to false. The option is a: <code>java.lang.Boolean</code> type. Group: common

Specified by:

includeDetails in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

includeDetails in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

includeDetails - the value to set

Returns:

the dsl builder

includeDetails

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

includeDetails in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

includeDetails in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

includeDetails - the value to set

Returns:

the dsl builder

initialReplayIdMap

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder initialReplayIdMap(Map<String,Long> initialReplayIdMap)

Replay IDs to start from per channel name. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Long&gt;</code> type. Group: common

Specified by:

initialReplayIdMap in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

initialReplayIdMap in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

initialReplayIdMap - the value to set

Returns:

the dsl builder

initialReplayIdMap

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder initialReplayIdMap(String initialReplayIdMap)

Replay IDs to start from per channel name. The option will be converted to a <code>java.util.Map&lt;java.lang.String, java.lang.Long&gt;</code> type. Group: common

Specified by:

initialReplayIdMap in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

initialReplayIdMap in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

initialReplayIdMap - the value to set

Returns:

the dsl builder

instanceId

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder instanceId(String instanceId)

Salesforce1 Analytics report execution instance ID. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

instanceId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

instanceId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

instanceId - the value to set

Returns:

the dsl builder

jobId

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder jobId(String jobId)

Bulk API Job ID. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

jobId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

jobId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

jobId - the value to set

Returns:

the dsl builder

limit

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

limit in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

limit in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

limit - the value to set

Returns:

the dsl builder

limit

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

limit in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

limit in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

limit - the value to set

Returns:

the dsl builder

locator

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

locator in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

locator in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

locator - the value to set

Returns:

the dsl builder

maxBackoff

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

maxBackoff in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

maxBackoff in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

maxBackoff - the value to set

Returns:

the dsl builder

maxBackoff

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

maxBackoff in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

maxBackoff in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

maxBackoff - the value to set

Returns:

the dsl builder

maxRecords

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

maxRecords in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

maxRecords in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

maxRecords - the value to set

Returns:

the dsl builder

maxRecords

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

maxRecords in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

maxRecords in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

maxRecords - the value to set

Returns:

the dsl builder

notFoundBehaviour

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

notFoundBehaviour in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notFoundBehaviour in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notFoundBehaviour - the value to set

Returns:

the dsl builder

notFoundBehaviour

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

notFoundBehaviour in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notFoundBehaviour in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notFoundBehaviour - the value to set

Returns:

the dsl builder

notifyForFields

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

notifyForFields in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notifyForFields in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notifyForFields - the value to set

Returns:

the dsl builder

notifyForFields

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

notifyForFields in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notifyForFields in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notifyForFields - the value to set

Returns:

the dsl builder

notifyForOperationCreate

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder notifyForOperationCreate(Boolean notifyForOperationCreate)

Notify for create operation, defaults to false (API version &amp;gt;= 29.0). The option is a: <code>java.lang.Boolean</code> type. Group: common

Specified by:

notifyForOperationCreate in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notifyForOperationCreate in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notifyForOperationCreate - the value to set

Returns:

the dsl builder

notifyForOperationCreate

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder notifyForOperationCreate(String notifyForOperationCreate)

Notify for create operation, defaults to false (API version &amp;gt;= 29.0). The option will be converted to a <code>java.lang.Boolean</code> type. Group: common

Specified by:

notifyForOperationCreate in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notifyForOperationCreate in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notifyForOperationCreate - the value to set

Returns:

the dsl builder

notifyForOperationDelete

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder notifyForOperationDelete(Boolean notifyForOperationDelete)

Notify for delete operation, defaults to false (API version &amp;gt;= 29.0). The option is a: <code>java.lang.Boolean</code> type. Group: common

Specified by:

notifyForOperationDelete in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notifyForOperationDelete in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notifyForOperationDelete - the value to set

Returns:

the dsl builder

notifyForOperationDelete

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder notifyForOperationDelete(String notifyForOperationDelete)

Notify for delete operation, defaults to false (API version &amp;gt;= 29.0). The option will be converted to a <code>java.lang.Boolean</code> type. Group: common

Specified by:

notifyForOperationDelete in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notifyForOperationDelete in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notifyForOperationDelete - the value to set

Returns:

the dsl builder

notifyForOperations

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder notifyForOperations(org.apache.camel.component.salesforce.internal.dto.NotifyForOperationsEnum notifyForOperations)

Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version &amp;lt; 29.0). The option is a: <code>org.apache.camel.component.salesforce.internal.dto.NotifyForOperationsEnum</code> type. Group: common

Specified by:

notifyForOperations in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notifyForOperations in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notifyForOperations - the value to set

Returns:

the dsl builder

notifyForOperations

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder notifyForOperations(String notifyForOperations)

Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version &amp;lt; 29.0). The option will be converted to a <code>org.apache.camel.component.salesforce.internal.dto.NotifyForOperationsEnum</code> type. Group: common

Specified by:

notifyForOperations in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notifyForOperations in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notifyForOperations - the value to set

Returns:

the dsl builder

notifyForOperationUndelete

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder notifyForOperationUndelete(Boolean notifyForOperationUndelete)

Notify for un-delete operation, defaults to false (API version &amp;gt;= 29.0). The option is a: <code>java.lang.Boolean</code> type. Group: common

Specified by:

notifyForOperationUndelete in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notifyForOperationUndelete in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notifyForOperationUndelete - the value to set

Returns:

the dsl builder

notifyForOperationUndelete

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder notifyForOperationUndelete(String notifyForOperationUndelete)

Notify for un-delete operation, defaults to false (API version &amp;gt;= 29.0). The option will be converted to a <code>java.lang.Boolean</code> type. Group: common

Specified by:

notifyForOperationUndelete in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notifyForOperationUndelete in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notifyForOperationUndelete - the value to set

Returns:

the dsl builder

notifyForOperationUpdate

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder notifyForOperationUpdate(Boolean notifyForOperationUpdate)

Notify for update operation, defaults to false (API version &amp;gt;= 29.0). The option is a: <code>java.lang.Boolean</code> type. Group: common

Specified by:

notifyForOperationUpdate in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notifyForOperationUpdate in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notifyForOperationUpdate - the value to set

Returns:

the dsl builder

notifyForOperationUpdate

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder notifyForOperationUpdate(String notifyForOperationUpdate)

Notify for update operation, defaults to false (API version &amp;gt;= 29.0). The option will be converted to a <code>java.lang.Boolean</code> type. Group: common

Specified by:

notifyForOperationUpdate in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

notifyForOperationUpdate in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

notifyForOperationUpdate - the value to set

Returns:

the dsl builder

objectMapper

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

objectMapper in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

objectMapper in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

objectMapper - the value to set

Returns:

the dsl builder

objectMapper

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

objectMapper in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

objectMapper in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

objectMapper - the value to set

Returns:

the dsl builder

pkChunking

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

pkChunking in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

pkChunking in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

pkChunking - the value to set

Returns:

the dsl builder

pkChunking

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

pkChunking in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

pkChunking in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

pkChunking - the value to set

Returns:

the dsl builder

pkChunkingChunkSize

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

pkChunkingChunkSize in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

pkChunkingChunkSize in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

pkChunkingChunkSize - the value to set

Returns:

the dsl builder

pkChunkingChunkSize

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

pkChunkingChunkSize in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

pkChunkingChunkSize in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

pkChunkingChunkSize - the value to set

Returns:

the dsl builder

pkChunkingParent

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

pkChunkingParent in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

pkChunkingParent in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

pkChunkingParent - the value to set

Returns:

the dsl builder

pkChunkingStartRow

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

pkChunkingStartRow in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

pkChunkingStartRow in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

pkChunkingStartRow - the value to set

Returns:

the dsl builder

queryLocator

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

queryLocator in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

queryLocator in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

queryLocator - the value to set

Returns:

the dsl builder

rawPayload

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

rawPayload in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

rawPayload in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

rawPayload - the value to set

Returns:

the dsl builder

rawPayload

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

rawPayload in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

rawPayload in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

rawPayload - the value to set

Returns:

the dsl builder

reportId

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder reportId(String reportId)

Salesforce1 Analytics report Id. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

reportId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

reportId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

reportId - the value to set

Returns:

the dsl builder

reportMetadata

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

reportMetadata in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

reportMetadata in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

reportMetadata - the value to set

Returns:

the dsl builder

reportMetadata

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

reportMetadata in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

reportMetadata in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

reportMetadata - the value to set

Returns:

the dsl builder

resultId

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder resultId(String resultId)

Bulk API Result ID. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

resultId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

resultId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

resultId - the value to set

Returns:

the dsl builder

sObjectBlobFieldName

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder sObjectBlobFieldName(String sObjectBlobFieldName)

SObject blob field name. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

sObjectBlobFieldName in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

sObjectBlobFieldName in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

sObjectBlobFieldName - the value to set

Returns:

the dsl builder

sObjectClass

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

sObjectClass in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

sObjectClass in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

sObjectClass - the value to set

Returns:

the dsl builder

sObjectFields

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder sObjectFields(String sObjectFields)

SObject fields to retrieve. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

sObjectFields in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

sObjectFields in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

sObjectFields - the value to set

Returns:

the dsl builder

sObjectId

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder sObjectId(String sObjectId)

SObject ID if required by API. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

sObjectId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

sObjectId in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

sObjectId - the value to set

Returns:

the dsl builder

sObjectIdName

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder sObjectIdName(String sObjectIdName)

SObject external ID field name. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

sObjectIdName in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

sObjectIdName in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

sObjectIdName - the value to set

Returns:

the dsl builder

sObjectIdValue

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder sObjectIdValue(String sObjectIdValue)

SObject external ID field value. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

sObjectIdValue in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

sObjectIdValue in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

sObjectIdValue - the value to set

Returns:

the dsl builder

sObjectName

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder sObjectName(String sObjectName)

SObject name if required or supported by API. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

sObjectName in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

sObjectName in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

sObjectName - the value to set

Returns:

the dsl builder

sObjectQuery

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder sObjectQuery(String sObjectQuery)

Salesforce SOQL query string. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

sObjectQuery in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

sObjectQuery in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

sObjectQuery - the value to set

Returns:

the dsl builder

sObjectSearch

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder sObjectSearch(String sObjectSearch)

Salesforce SOSL search string. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

sObjectSearch in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

sObjectSearch in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

sObjectSearch - the value to set

Returns:

the dsl builder

streamQueryResult

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder streamQueryResult(Boolean streamQueryResult)

If true, streams SOQL query result and transparently handles subsequent requests if there are multiple pages. Otherwise, results are returned one page at a time. The option is a: <code>java.lang.Boolean</code> type. Default: false Group: common

Specified by:

streamQueryResult in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

streamQueryResult in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

streamQueryResult - the value to set

Returns:

the dsl builder

streamQueryResult

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder streamQueryResult(String streamQueryResult)

If true, streams SOQL query result and transparently handles subsequent requests if there are multiple pages. Otherwise, results are returned one page at a time. The option will be converted to a <code>java.lang.Boolean</code> type. Default: false Group: common

Specified by:

streamQueryResult in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

streamQueryResult in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

streamQueryResult - the value to set

Returns:

the dsl builder

updateTopic

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

updateTopic in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

updateTopic in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

updateTopic - the value to set

Returns:

the dsl builder

updateTopic

default SalesforceEndpointBuilderFactory.SalesforceEndpointBuilder 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

Specified by:

updateTopic in interface SalesforceEndpointBuilderFactory.SalesforceEndpointConsumerBuilder

Specified by:

updateTopic in interface SalesforceEndpointBuilderFactory.SalesforceEndpointProducerBuilder

Parameters:

updateTopic - the value to set

Returns:

the dsl builder