Package org.apache.camel.component.salesforce

Class SalesforceEndpointConfig

  • All Implemented Interfaces:
    Cloneable
    @UriParams
public class SalesforceEndpointConfig
extends Object
implements Cloneable
    Salesforce Endpoint configuration.

    • Constructor Detail

      • SalesforceEndpointConfig

        public SalesforceEndpointConfig()

    • Method Detail

      • setFormat

        public void setFormat​(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.

      • isRawPayload

        public boolean isRawPayload()

      • setRawPayload

        public void setRawPayload​(boolean rawPayload)
        Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default

      • getApiVersion

        public String getApiVersion()

      • setApiVersion

        public void setApiVersion​(String apiVersion)
        Salesforce API version.

      • getSObjectName

        public String getSObjectName()

      • setSObjectName

        public void setSObjectName​(String sObjectName)
        SObject name if required or supported by API

      • getSObjectId

        public String getSObjectId()

      • setSObjectId

        public void setSObjectId​(String sObjectId)
        SObject ID if required by API

      • getSObjectFields

        public String getSObjectFields()

      • setSObjectFields

        public void setSObjectFields​(String sObjectFields)
        SObject fields to retrieve

      • getSObjectIdName

        public String getSObjectIdName()

      • setSObjectIdName

        public void setSObjectIdName​(String sObjectIdName)
        SObject external ID field name

      • getSObjectIdValue

        public String getSObjectIdValue()

      • setSObjectIdValue

        public void setSObjectIdValue​(String sObjectIdValue)
        SObject external ID field value

      • getSObjectBlobFieldName

        public String getSObjectBlobFieldName()

      • setSObjectBlobFieldName

        public void setSObjectBlobFieldName​(String sObjectBlobFieldName)
        SObject blob field name

      • getSObjectClass

        public String getSObjectClass()

      • setSObjectClass

        public void setSObjectClass​(String sObjectClass)
        Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin

      • getSObjectQuery

        public String getSObjectQuery()

      • setSObjectQuery

        public void setSObjectQuery​(String sObjectQuery)
        Salesforce SOQL query string

      • getSObjectSearch

        public String getSObjectSearch()

      • getStreamQueryResult

        public Boolean getStreamQueryResult()

      • setStreamQueryResult

        public void setStreamQueryResult​(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.

      • setSObjectSearch

        public void setSObjectSearch​(String sObjectSearch)
        Salesforce SOSL search string

      • getApexMethod

        public String getApexMethod()

      • setApexMethod

        public void setApexMethod​(String apexMethod)
        APEX method name

      • getApexUrl

        public String getApexUrl()

      • setApexUrl

        public void setApexUrl​(String apexUrl)
        APEX method URL

      • setApexQueryParams

        public void setApexQueryParams​(Map<String,​Object> apexQueryParams)
        Query params for APEX method

      • getCompositeMethod

        public String getCompositeMethod()

      • setCompositeMethod

        public void setCompositeMethod​(String compositeMethod)
        Composite (raw) method.

      • isAllOrNone

        public boolean isAllOrNone()

      • setAllOrNone

        public void setAllOrNone​(boolean allOrNone)

      • setApproval

        public void setApproval​(ApprovalRequest approval)
        The approval request for Approval API.
        Parameters:
        approval -

      • setContentType

        public void setContentType​(ContentType contentType)
        Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV

      • getJobId

        public String getJobId()

      • setJobId

        public void setJobId​(String jobId)
        Bulk API Job ID

      • getBatchId

        public String getBatchId()

      • setBatchId

        public void setBatchId​(String batchId)
        Bulk API Batch ID

      • getResultId

        public String getResultId()

      • setResultId

        public void setResultId​(String resultId)
        Bulk API Result ID

      • isUpdateTopic

        public boolean isUpdateTopic()

      • getQueryLocator

        public String getQueryLocator()

      • setQueryLocator

        public void setQueryLocator​(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.

      • getLocator

        public String getLocator()

      • setLocator

        public void setLocator​(String locator)
        Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job.

      • getMaxRecords

        public Integer getMaxRecords()

      • setMaxRecords

        public void setMaxRecords​(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.

      • getPkChunking

        public Boolean getPkChunking()

      • setPkChunking

        public void setPkChunking​(Boolean pkChunking)
        Use PK Chunking. Only for use in original Bulk API. Bulk 2.0 API performs PK chunking automatically, if necessary.

      • getPkChunkingChunkSize

        public Integer getPkChunkingChunkSize()

      • setPkChunkingChunkSize

        public void setPkChunkingChunkSize​(Integer pkChunkingChunkSize)
        Chunk size for use with PK Chunking. If unspecified, salesforce default is 100,000. Maximum size is 250,000.

      • getPkChunkingParent

        public String getPkChunkingParent()

      • setPkChunkingParent

        public void setPkChunkingParent​(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.

      • getPkChunkingStartRow

        public String getPkChunkingStartRow()

      • setPkChunkingStartRow

        public void setPkChunkingStartRow​(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.

      • setUpdateTopic

        public void setUpdateTopic​(boolean updateTopic)
        Whether to update an existing Push Topic when using the Streaming API, defaults to false

      • setNotifyForFields

        public void setNotifyForFields​(NotifyForFieldsEnum notifyForFields)
        Notify for fields, options are ALL, REFERENCED, SELECT, WHERE

      • setNotifyForOperations

        public void setNotifyForOperations​(NotifyForOperationsEnum notifyForOperations)
        Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version < 29.0)

      • getNotifyForOperationCreate

        public Boolean getNotifyForOperationCreate()

      • setNotifyForOperationCreate

        public void setNotifyForOperationCreate​(Boolean notifyForOperationCreate)
        Notify for create operation, defaults to false (API version >= 29.0)

      • getNotifyForOperationUpdate

        public Boolean getNotifyForOperationUpdate()

      • setNotifyForOperationUpdate

        public void setNotifyForOperationUpdate​(Boolean notifyForOperationUpdate)
        Notify for update operation, defaults to false (API version >= 29.0)

      • getNotifyForOperationDelete

        public Boolean getNotifyForOperationDelete()

      • setNotifyForOperationDelete

        public void setNotifyForOperationDelete​(Boolean notifyForOperationDelete)
        Notify for delete operation, defaults to false (API version >= 29.0)

      • getNotifyForOperationUndelete

        public Boolean getNotifyForOperationUndelete()

      • setNotifyForOperationUndelete

        public void setNotifyForOperationUndelete​(Boolean notifyForOperationUndelete)
        Notify for un-delete operation, defaults to false (API version >= 29.0)

      • getReportId

        public String getReportId()

      • setReportId

        public void setReportId​(String reportId)
        Salesforce1 Analytics report Id

      • getIncludeDetails

        public Boolean getIncludeDetails()

      • setIncludeDetails

        public void setIncludeDetails​(Boolean includeDetails)
        Include details in Salesforce1 Analytics report, defaults to false.

      • setReportMetadata

        public void setReportMetadata​(ReportMetadata reportMetadata)
        Salesforce1 Analytics report metadata for filtering

      • getInstanceId

        public String getInstanceId()

      • setInstanceId

        public void setInstanceId​(String instanceId)
        Salesforce1 Analytics report execution instance ID

      • setHttpClient

        public void setHttpClient​(SalesforceHttpClient httpClient)
        Custom Jetty Http Client to use to connect to Salesforce.

      • getObjectMapper

        public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

      • getBackoffIncrement

        public long getBackoffIncrement()

      • setBackoffIncrement

        public void setBackoffIncrement​(long backoffIncrement)
        Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect.

      • getMaxBackoff

        public long getMaxBackoff()

      • setMaxBackoff

        public void setMaxBackoff​(long maxBackoff)
        Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect.

      • setObjectMapper

        public void setObjectMapper​(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
        Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects.

      • getDefaultReplayId

        public Long getDefaultReplayId()

      • setDefaultReplayId

        public void setDefaultReplayId​(Long defaultReplayId)
        Default replayId setting if no value is found in initialReplayIdMap
        Parameters:
        defaultReplayId -

      • getInitialReplayIdMap

        public Map<String,​Long> getInitialReplayIdMap()

      • setInitialReplayIdMap

        public void setInitialReplayIdMap​(Map<String,​Long> initialReplayIdMap)
        Replay IDs to start from per channel name.

      • getFallBackReplayId

        public Long getFallBackReplayId()

      • setFallBackReplayId

        public void setFallBackReplayId​(Long fallBackReplayId)
        ReplayId to fall back to after an Invalid Replay Id response

      • getLimit

        public Integer getLimit()

      • setLimit

        public void setLimit​(Integer limit)
        Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation.
        Parameters:
        limit -

      • getApprovalComments

        public String getApprovalComments()

      • getApprovalContextActorId

        public String getApprovalContextActorId()

      • getApprovalContextId

        public String getApprovalContextId()

      • getApprovalNextApproverIds

        public List<String> getApprovalNextApproverIds()

      • getApprovalProcessDefinitionNameOrId

        public String getApprovalProcessDefinitionNameOrId()

      • isApprovalSkipEntryCriteria

        public boolean isApprovalSkipEntryCriteria()

      • setApprovalActionType

        public void setApprovalActionType​(ApprovalRequest.Action actionType)
        Represents the kind of action to take: Submit, Approve, or Reject.
        Parameters:
        actionType -

      • setApprovalComments

        public void setApprovalComments​(String comments)
        The comment to add to the history step associated with this request.
        Parameters:
        comments -

      • setApprovalContextActorId

        public void setApprovalContextActorId​(String contextActorId)
        The ID of the submitter who’s requesting the approval record.
        Parameters:
        contextActorId -

      • setApprovalContextId

        public void setApprovalContextId​(String contextId)
        The ID of the item that is being acted upon.
        Parameters:
        contextId -

      • setApprovalNextApproverIds

        public void setApprovalNextApproverIds​(List<String> nextApproverIds)
        If the process requires specification of the next approval, the ID of the user to be assigned the next request.
        Parameters:
        nextApproverIds -

      • setApprovalNextApproverIds

        public void setApprovalNextApproverIds​(String nextApproverId)
        If the process requires specification of the next approval, the ID of the user to be assigned the next request.
        Parameters:
        nextApproverId -

      • setApprovalProcessDefinitionNameOrId

        public void setApprovalProcessDefinitionNameOrId​(String processDefinitionNameOrId)
        The developer name or ID of the process definition.
        Parameters:
        processDefinitionNameOrId -

      • setApprovalSkipEntryCriteria

        public void setApprovalSkipEntryCriteria​(boolean skipEntryCriteria)
        Determines whether to evaluate the entry criteria for the process (true) or not (false) if the process definition name or ID isn’t null. If the process definition name or ID isn’t specified, this argument is ignored, and standard evaluation is followed based on process order. By default, the entry criteria isn’t skipped if it’s not set by this request.
        Parameters:
        skipEntryCriteria -

      • getRawPath

        public String getRawPath()

      • setRawPath

        public void setRawPath​(String rawPath)
        The portion of the endpoint URL after the domain name. E.g., " + "'/services/data/v52.0/sobjects/Account/'
        Parameters:
        rawPath - the path

      • getRawMethod

        public String getRawMethod()

      • setRawMethod

        public void setRawMethod​(String rawMethod)
        HTTP method to use for the Raw operation
        Parameters:
        rawMethod - http method

      • getRawQueryParameters

        public String getRawQueryParameters()

      • setRawQueryParameters

        public void setRawQueryParameters​(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.
        Parameters:
        rawQueryParameters -

      • getRawHttpHeaders

        public String getRawHttpHeaders()

      • setRawHttpHeaders

        public void setRawHttpHeaders​(String rawHttpHeaders)
        Comma separated list of message headers to include as HTTP parameters for Raw operation.