Package org.apache.camel.builder.component.dsl

Interface SalesforceComponentBuilderFactory.SalesforceComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.salesforce.SalesforceComponent>
All Known Implementing Classes:
SalesforceComponentBuilderFactory.SalesforceComponentBuilderImpl
Enclosing interface:
SalesforceComponentBuilderFactory
public static interface SalesforceComponentBuilderFactory.SalesforceComponentBuilder extends ComponentBuilder<org.apache.camel.component.salesforce.SalesforceComponent>
Builder for the Salesforce component.

  • Method Details

    • apexMethod

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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
      Parameters:
      apexQueryParams - the value to set
      Returns:
      the dsl builder

    • apiVersion

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder apiVersion(String apiVersion)
      Salesforce API version. The option is a: <code>java.lang.String</code> type. Default: 56.0 Group: common
      Parameters:
      apiVersion - the value to set
      Returns:
      the dsl builder

    • backoffIncrement

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • batchId

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • defaultReplayId

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • fallBackReplayId

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • format

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • httpClient

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • httpClientConnectionTimeout

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpClientConnectionTimeout(long httpClientConnectionTimeout)
      Connection timeout used by the HttpClient when connecting to the Salesforce server. The option is a: <code>long</code> type. Default: 60000 Group: common
      Parameters:
      httpClientConnectionTimeout - the value to set
      Returns:
      the dsl builder

    • httpClientIdleTimeout

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpClientIdleTimeout(long httpClientIdleTimeout)
      Timeout used by the HttpClient when waiting for response from the Salesforce server. The option is a: <code>long</code> type. Default: 10000 Group: common
      Parameters:
      httpClientIdleTimeout - the value to set
      Returns:
      the dsl builder

    • httpMaxContentLength

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpMaxContentLength(Integer httpMaxContentLength)
      Max content length of an HTTP response. The option is a: <code>java.lang.Integer</code> type. Group: common
      Parameters:
      httpMaxContentLength - the value to set
      Returns:
      the dsl builder

    • httpRequestBufferSize

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpRequestBufferSize(Integer httpRequestBufferSize)
      HTTP request buffer size. May need to be increased for large SOQL queries. The option is a: <code>java.lang.Integer</code> type. Default: 8192 Group: common
      Parameters:
      httpRequestBufferSize - the value to set
      Returns:
      the dsl builder

    • httpRequestTimeout

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpRequestTimeout(long httpRequestTimeout)
      Timeout value for HTTP requests. The option is a: <code>long</code> type. Default: 60000 Group: common
      Parameters:
      httpRequestTimeout - the value to set
      Returns:
      the dsl builder

    • includeDetails

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • initialReplayIdMap

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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
      Parameters:
      initialReplayIdMap - the value to set
      Returns:
      the dsl builder

    • instanceId

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • locator

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • maxRecords

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • notFoundBehaviour

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • notifyForFields

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • notifyForOperationCreate

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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
      Parameters:
      notifyForOperationCreate - the value to set
      Returns:
      the dsl builder

    • notifyForOperationDelete

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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
      Parameters:
      notifyForOperationDelete - the value to set
      Returns:
      the dsl builder

    • notifyForOperations

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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
      Parameters:
      notifyForOperations - the value to set
      Returns:
      the dsl builder

    • notifyForOperationUndelete

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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
      Parameters:
      notifyForOperationUndelete - the value to set
      Returns:
      the dsl builder

    • notifyForOperationUpdate

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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
      Parameters:
      notifyForOperationUpdate - the value to set
      Returns:
      the dsl builder

    • objectMapper

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • packages

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder packages(String packages)
      In what packages are the generated DTO classes. Typically the classes would be generated using camel-salesforce-maven-plugin. Set it if using the generated DTOs to gain the benefit of using short SObject names in parameters/header values. Multiple packages can be separated by comma. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      packages - the value to set
      Returns:
      the dsl builder

    • pkChunking

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • pkChunkingChunkSize

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • pkChunkingParent

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • reportId

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • resultId

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • streamQueryResult

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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
      Parameters:
      streamQueryResult - the value to set
      Returns:
      the dsl builder

    • updateTopic

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • config

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder config(org.apache.camel.component.salesforce.SalesforceEndpointConfig config)
      Global endpoint configuration - use to set values that are common to all endpoints. The option is a: <code>org.apache.camel.component.salesforce.SalesforceEndpointConfig</code> type. Group: common (advanced)
      Parameters:
      config - the value to set
      Returns:
      the dsl builder

    • httpClientProperties

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpClientProperties(Map<String,Object> httpClientProperties)
      Used to set any properties that can be configured on the underlying HTTP client. Have a look at properties of SalesforceHttpClient and the Jetty HttpClient for all available options. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. Group: common (advanced)
      Parameters:
      httpClientProperties - the value to set
      Returns:
      the dsl builder

    • longPollingTransportProperties

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder longPollingTransportProperties(Map<String,Object> longPollingTransportProperties)
      Used to set any properties that can be configured on the LongPollingTransport used by the BayeuxClient (CometD) used by the streaming api. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. Group: common (advanced)
      Parameters:
      longPollingTransportProperties - the value to set
      Returns:
      the dsl builder

    • workerPoolMaxSize

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder workerPoolMaxSize(int workerPoolMaxSize)
      Maximum size of the thread pool used to handle HTTP responses. The option is a: <code>int</code> type. Default: 20 Group: common (advanced)
      Parameters:
      workerPoolMaxSize - the value to set
      Returns:
      the dsl builder

    • workerPoolSize

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder workerPoolSize(int workerPoolSize)
      Size of the thread pool used to handle HTTP responses. The option is a: <code>int</code> type. Default: 10 Group: common (advanced)
      Parameters:
      workerPoolSize - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • pubSubBatchSize

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder pubSubBatchSize(int pubSubBatchSize)
      Max number of events to receive in a batch from the Pub/Sub API. The option is a: <code>int</code> type. Default: 100 Group: consumer
      Parameters:
      pubSubBatchSize - the value to set
      Returns:
      the dsl builder

    • pubSubDeserializeType

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder pubSubDeserializeType(org.apache.camel.component.salesforce.PubSubDeserializeType pubSubDeserializeType)
      How to deserialize events consume from the Pub/Sub API. AVRO will try a SpecificRecord subclass if found, otherwise GenericRecord. The option is a: <code>org.apache.camel.component.salesforce.PubSubDeserializeType</code> type. Default: AVRO Group: consumer
      Parameters:
      pubSubDeserializeType - the value to set
      Returns:
      the dsl builder

    • pubSubPojoClass

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder pubSubPojoClass(String pubSubPojoClass)
      Fully qualified class name to deserialize Pub/Sub API event to. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      pubSubPojoClass - the value to set
      Returns:
      the dsl builder

    • replayPreset

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder replayPreset(com.salesforce.eventbus.protobuf.ReplayPreset replayPreset)
      Replay preset for Pub/Sub API. The option is a: <code>com.salesforce.eventbus.protobuf.ReplayPreset</code> type. Default: LATEST Group: consumer
      Parameters:
      replayPreset - the value to set
      Returns:
      the dsl builder

    • allOrNone

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • apexUrl

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • rawHttpHeaders

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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

    • autowiredEnabled

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • httpProxyExcludedAddresses

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyExcludedAddresses(Set<String> httpProxyExcludedAddresses)
      A list of addresses for which HTTP proxy server should not be used. The option is a: <code>java.util.Set&lt;java.lang.String&gt;</code> type. Group: proxy
      Parameters:
      httpProxyExcludedAddresses - the value to set
      Returns:
      the dsl builder

    • httpProxyHost

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyHost(String httpProxyHost)
      Hostname of the HTTP proxy server to use. The option is a: <code>java.lang.String</code> type. Group: proxy
      Parameters:
      httpProxyHost - the value to set
      Returns:
      the dsl builder

    • httpProxyIncludedAddresses

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyIncludedAddresses(Set<String> httpProxyIncludedAddresses)
      A list of addresses for which HTTP proxy server should be used. The option is a: <code>java.util.Set&lt;java.lang.String&gt;</code> type. Group: proxy
      Parameters:
      httpProxyIncludedAddresses - the value to set
      Returns:
      the dsl builder

    • httpProxyPort

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyPort(Integer httpProxyPort)
      Port number of the HTTP proxy server to use. The option is a: <code>java.lang.Integer</code> type. Group: proxy
      Parameters:
      httpProxyPort - the value to set
      Returns:
      the dsl builder

    • httpProxySocks4

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxySocks4(boolean httpProxySocks4)
      If set to true the configures the HTTP proxy to use as a SOCKS4 proxy. The option is a: <code>boolean</code> type. Default: false Group: proxy
      Parameters:
      httpProxySocks4 - the value to set
      Returns:
      the dsl builder

    • authenticationType

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder authenticationType(org.apache.camel.component.salesforce.AuthenticationType authenticationType)
      Explicit authentication method to be used, one of USERNAME_PASSWORD, REFRESH_TOKEN or JWT. Salesforce component can auto-determine the authentication method to use from the properties set, set this property to eliminate any ambiguity. The option is a: <code>org.apache.camel.component.salesforce.AuthenticationType</code> type. Group: security
      Parameters:
      authenticationType - the value to set
      Returns:
      the dsl builder

    • clientId

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder clientId(String clientId)
      OAuth Consumer Key of the connected app configured in the Salesforce instance setup. Typically a connected app needs to be configured but one can be provided by installing a package. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      clientId - the value to set
      Returns:
      the dsl builder

    • clientSecret

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder clientSecret(String clientSecret)
      OAuth Consumer Secret of the connected app configured in the Salesforce instance setup. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      clientSecret - the value to set
      Returns:
      the dsl builder

    • httpProxyAuthUri

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyAuthUri(String httpProxyAuthUri)
      Used in authentication against the HTTP proxy server, needs to match the URI of the proxy server in order for the httpProxyUsername and httpProxyPassword to be used for authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      httpProxyAuthUri - the value to set
      Returns:
      the dsl builder

    • httpProxyPassword

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyPassword(String httpProxyPassword)
      Password to use to authenticate against the HTTP proxy server. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      httpProxyPassword - the value to set
      Returns:
      the dsl builder

    • httpProxyRealm

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyRealm(String httpProxyRealm)
      Realm of the proxy server, used in preemptive Basic/Digest authentication methods against the HTTP proxy server. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      httpProxyRealm - the value to set
      Returns:
      the dsl builder

    • httpProxySecure

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxySecure(boolean httpProxySecure)
      If set to false disables the use of TLS when accessing the HTTP proxy. The option is a: <code>boolean</code> type. Default: true Group: security
      Parameters:
      httpProxySecure - the value to set
      Returns:
      the dsl builder

    • httpProxyUseDigestAuth

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyUseDigestAuth(boolean httpProxyUseDigestAuth)
      If set to true Digest authentication will be used when authenticating to the HTTP proxy, otherwise Basic authorization method will be used. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      httpProxyUseDigestAuth - the value to set
      Returns:
      the dsl builder

    • httpProxyUsername

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyUsername(String httpProxyUsername)
      Username to use to authenticate against the HTTP proxy server. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      httpProxyUsername - the value to set
      Returns:
      the dsl builder

    • instanceUrl

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder instanceUrl(String instanceUrl)
      URL of the Salesforce instance used after authentication, by default received from Salesforce on successful authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      instanceUrl - the value to set
      Returns:
      the dsl builder

    • jwtAudience

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder jwtAudience(String jwtAudience)
      Value to use for the Audience claim (aud) when using OAuth JWT flow. If not set, the login URL will be used, which is appropriate in most cases. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      jwtAudience - the value to set
      Returns:
      the dsl builder

    • keystore

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder keystore(org.apache.camel.support.jsse.KeyStoreParameters keystore)
      KeyStore parameters to use in OAuth JWT flow. The KeyStore should contain only one entry with private key and certificate. Salesforce does not verify the certificate chain, so this can easily be a selfsigned certificate. Make sure that you upload the certificate to the corresponding connected app. The option is a: <code>org.apache.camel.support.jsse.KeyStoreParameters</code> type. Group: security
      Parameters:
      keystore - the value to set
      Returns:
      the dsl builder

    • lazyLogin

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder lazyLogin(boolean lazyLogin)
      If set to true prevents the component from authenticating to Salesforce with the start of the component. You would generally set this to the (default) false and authenticate early and be immediately aware of any authentication issues. Lazy login is not supported by salesforce consumers. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      lazyLogin - the value to set
      Returns:
      the dsl builder

    • loginConfig

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder loginConfig(org.apache.camel.component.salesforce.SalesforceLoginConfig loginConfig)
      All authentication configuration in one nested bean, all properties set there can be set directly on the component as well. The option is a: <code>org.apache.camel.component.salesforce.SalesforceLoginConfig</code> type. Group: security
      Parameters:
      loginConfig - the value to set
      Returns:
      the dsl builder

    • loginUrl

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder loginUrl(String loginUrl)
      URL of the Salesforce instance used for authentication, by default set to https://login.salesforce.com. The option is a: <code>java.lang.String</code> type. Default: https://login.salesforce.com Group: security
      Parameters:
      loginUrl - the value to set
      Returns:
      the dsl builder

    • password

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder password(String password)
      Password used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. Make sure that you append security token to the end of the password if using one. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • pubSubHost

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder pubSubHost(String pubSubHost)
      Pub/Sub host. The option is a: <code>java.lang.String</code> type. Default: api.pubsub.salesforce.com Group: security
      Parameters:
      pubSubHost - the value to set
      Returns:
      the dsl builder

    • pubSubPort

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder pubSubPort(int pubSubPort)
      Pub/Sub port. The option is a: <code>int</code> type. Default: 7443 Group: security
      Parameters:
      pubSubPort - the value to set
      Returns:
      the dsl builder

    • refreshToken

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder refreshToken(String refreshToken)
      Refresh token already obtained in the refresh token OAuth flow. One needs to setup a web application and configure a callback URL to receive the refresh token, or configure using the builtin callback at https://login.salesforce.com/services/oauth2/success or https://test.salesforce.com/services/oauth2/success and then retrive the refresh_token from the URL at the end of the flow. Note that in development organizations Salesforce allows hosting the callback web application at localhost. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      refreshToken - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
      SSL parameters to use, see SSLContextParameters class for all available options. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • useGlobalSslContextParameters

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
      Enable usage of global SSL context parameters. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useGlobalSslContextParameters - the value to set
      Returns:
      the dsl builder

    • userName

      default SalesforceComponentBuilderFactory.SalesforceComponentBuilder userName(String userName)
      Username used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      userName - the value to set
      Returns:
      the dsl builder