SalesforceEndpointConfig (Camel :: Salesforce 3.14.10 API)

java.lang.Object
- org.apache.camel.component.salesforce.SalesforceEndpointConfig

All Implemented Interfaces:: Cloneable

@UriParams
public class SalesforceEndpointConfig
extends Object
implements Cloneable

Salesforce Endpoint configuration.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALL_OR_NONE`
`static String`	`APEX_METHOD`
`static String`	`APEX_QUERY_PARAM_PREFIX`
`static String`	`APEX_URL`
`static String`	`API_VERSION`
`static String`	`APPROVAL`
`static String`	`BATCH_ID`
`static String`	`COMPOSITE_METHOD`
`static String`	`CONTENT_TYPE`
`static long`	`DEFAULT_BACKOFF_INCREMENT`
`static int`	`DEFAULT_MAX_AUTHENTICATION_RETRIES`
`static long`	`DEFAULT_MAX_BACKOFF`
`static String`	`DEFAULT_REPLAY_ID`
`static String`	`DEFAULT_VERSION`
`static String`	`FALL_BACK_REPLAY_ID`
`static String`	`FORMAT`
`static String`	`INCLUDE_DETAILS`
`static String`	`INITIAL_REPLAY_ID_MAP`
`static String`	`INSTANCE_ID`
`static String`	`JOB_ID`
`static String`	`LIMIT`
`static String`	`LOCATOR`
`static String`	`MAX_RECORDS`
`static String`	`NOT_FOUND_BEHAVIOUR`
`static String`	`PK_CHUNKING`
`static String`	`PK_CHUNKING_CHUNK_SIZE`
`static String`	`PK_CHUNKING_PARENT`
`static String`	`PK_CHUNKING_START_ROW`
`static String`	`QUERY_LOCATOR`
`static String`	`RAW_HTTP_HEADERS`
`static String`	`RAW_METHOD`
`static String`	`RAW_PATH`
`static String`	`RAW_PAYLOAD`
`static String`	`RAW_QUERY_PARAMETERS`
`static long`	`REPLAY_FROM_TIP`
`static String`	`REPORT_ID`
`static String`	`REPORT_METADATA`
`static String`	`RESULT_ID`
`static String`	`SOBJECT_BLOB_FIELD_NAME`
`static String`	`SOBJECT_CLASS`
`static String`	`SOBJECT_EXT_ID_NAME`
`static String`	`SOBJECT_EXT_ID_VALUE`
`static String`	`SOBJECT_FIELDS`
`static String`	`SOBJECT_ID`
`static String`	`SOBJECT_IDS`
`static String`	`SOBJECT_NAME`
`static String`	`SOBJECT_QUERY`
`static String`	`SOBJECT_SEARCH`

Constructor Summary

Constructors
Constructor and Description

SalesforceEndpointConfig()

Constructors
Constructor and Description
`SalesforceEndpointConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SalesforceEndpointConfig`	`copy()`
`String`	`getApexMethod()`
`Map<String,Object>`	`getApexQueryParams()`
`String`	`getApexUrl()`
`String`	`getApiVersion()`
`ApprovalRequest`	`getApproval()`
`ApprovalRequest.Action`	`getApprovalActionType()`
`String`	`getApprovalComments()`
`String`	`getApprovalContextActorId()`
`String`	`getApprovalContextId()`
`List<String>`	`getApprovalNextApproverIds()`
`String`	`getApprovalProcessDefinitionNameOrId()`
`long`	`getBackoffIncrement()`
`String`	`getBatchId()`
`String`	`getCompositeMethod()`
`ContentType`	`getContentType()`
`Long`	`getDefaultReplayId()`
`Long`	`getFallBackReplayId()`
`PayloadFormat`	`getFormat()`
`SalesforceHttpClient`	`getHttpClient()`
`Boolean`	`getIncludeDetails()`
`Map<String,Long>`	`getInitialReplayIdMap()`
`String`	`getInstanceId()`
`String`	`getJobId()`
`Integer`	`getLimit()`
`String`	`getLocator()`
`long`	`getMaxBackoff()`
`Integer`	`getMaxRecords()`
`NotFoundBehaviour`	`getNotFoundBehaviour()`
`NotifyForFieldsEnum`	`getNotifyForFields()`
`Boolean`	`getNotifyForOperationCreate()`
`Boolean`	`getNotifyForOperationDelete()`
`NotifyForOperationsEnum`	`getNotifyForOperations()`
`Boolean`	`getNotifyForOperationUndelete()`
`Boolean`	`getNotifyForOperationUpdate()`
`com.fasterxml.jackson.databind.ObjectMapper`	`getObjectMapper()`
`Boolean`	`getPkChunking()`
`Integer`	`getPkChunkingChunkSize()`
`String`	`getPkChunkingParent()`
`String`	`getPkChunkingStartRow()`
`String`	`getQueryLocator()`
`String`	`getRawHttpHeaders()`
`String`	`getRawMethod()`
`String`	`getRawPath()`
`String`	`getRawQueryParameters()`
`String`	`getReportId()`
`ReportMetadata`	`getReportMetadata()`
`String`	`getResultId()`
`String`	`getSObjectBlobFieldName()`
`String`	`getSObjectClass()`
`String`	`getSObjectFields()`
`String`	`getSObjectId()`
`String`	`getSObjectIdName()`
`String`	`getSObjectIdValue()`
`String`	`getSObjectName()`
`String`	`getSObjectQuery()`
`String`	`getSObjectSearch()`
`boolean`	`isAllOrNone()`
`boolean`	`isApprovalSkipEntryCriteria()`
`boolean`	`isRawPayload()`
`boolean`	`isUpdateTopic()`
`void`	`setAllOrNone(boolean allOrNone)`
`void`	`setApexMethod(String apexMethod)` APEX method name
`void`	`setApexQueryParams(Map<String,Object> apexQueryParams)` Query params for APEX method
`void`	`setApexUrl(String apexUrl)` APEX method URL
`void`	`setApiVersion(String apiVersion)` Salesforce API version.
`void`	`setApproval(ApprovalRequest approval)` The approval request for Approval API.
`void`	`setApprovalActionType(ApprovalRequest.Action actionType)` Represents the kind of action to take: Submit, Approve, or Reject.
`void`	`setApprovalComments(String comments)` The comment to add to the history step associated with this request.
`void`	`setApprovalContextActorId(String contextActorId)` The ID of the submitter who’s requesting the approval record.
`void`	`setApprovalContextId(String contextId)` The ID of the item that is being acted upon.
`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.
`void`	`setApprovalNextApproverIds(String nextApproverId)` If the process requires specification of the next approval, the ID of the user to be assigned the next request.
`void`	`setApprovalProcessDefinitionNameOrId(String processDefinitionNameOrId)` The developer name or ID of the process definition.
`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.
`void`	`setBackoffIncrement(long backoffIncrement)` Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
`void`	`setBatchId(String batchId)` Bulk API Batch ID
`void`	`setCompositeMethod(String compositeMethod)` Composite (raw) method.
`void`	`setContentType(ContentType contentType)` Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV
`void`	`setDefaultReplayId(Long defaultReplayId)` Default replayId setting if no value is found in `initialReplayIdMap`
`void`	`setFallBackReplayId(Long fallBackReplayId)` ReplayId to fall back to after an Invalid Replay Id response
`void`	`setFormat(PayloadFormat format)` Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON.
`void`	`setHttpClient(SalesforceHttpClient httpClient)` Custom Jetty Http Client to use to connect to Salesforce.
`void`	`setIncludeDetails(Boolean includeDetails)` Include details in Salesforce1 Analytics report, defaults to false.
`void`	`setInitialReplayIdMap(Map<String,Long> initialReplayIdMap)` Replay IDs to start from per channel name.
`void`	`setInstanceId(String instanceId)` Salesforce1 Analytics report execution instance ID
`void`	`setJobId(String jobId)` Bulk API Job ID
`void`	`setLimit(Integer limit)` Limit on number of returned records.
`void`	`setLocator(String locator)` Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job.
`void`	`setMaxBackoff(long maxBackoff)` Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
`void`	`setMaxRecords(Integer maxRecords)` The maximum number of records to retrieve per set of results for a Bulk 2.0 Query.
`void`	`setNotFoundBehaviour(NotFoundBehaviour notFoundBehaviour)` Sets the behaviour of 404 not found status received from Salesforce API.
`void`	`setNotifyForFields(NotifyForFieldsEnum notifyForFields)` Notify for fields, options are ALL, REFERENCED, SELECT, WHERE
`void`	`setNotifyForOperationCreate(Boolean notifyForOperationCreate)` Notify for create operation, defaults to false (API version >= 29.0)
`void`	`setNotifyForOperationDelete(Boolean notifyForOperationDelete)` Notify for delete operation, defaults to false (API version >= 29.0)
`void`	`setNotifyForOperations(NotifyForOperationsEnum notifyForOperations)` Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version < 29.0)
`void`	`setNotifyForOperationUndelete(Boolean notifyForOperationUndelete)` Notify for un-delete operation, defaults to false (API version >= 29.0)
`void`	`setNotifyForOperationUpdate(Boolean notifyForOperationUpdate)` Notify for update operation, defaults to false (API version >= 29.0)
`void`	`setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)` Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects.
`void`	`setPkChunking(Boolean pkChunking)` Use PK Chunking.
`void`	`setPkChunkingChunkSize(Integer pkChunkingChunkSize)` Chunk size for use with PK Chunking.
`void`	`setPkChunkingParent(String pkChunkingParent)` Specifies the parent object when you're enabling PK chunking for queries on sharing objects.
`void`	`setPkChunkingStartRow(String pkChunkingStartRow)` Specifies the 15-character or 18-character record ID to be used as the lower boundary for the first chunk.
`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.
`void`	`setRawHttpHeaders(String rawHttpHeaders)` Comma separated list of message headers to include as HTTP parameters for Raw operation.
`void`	`setRawMethod(String rawMethod)` HTTP method to use for the Raw operation
`void`	`setRawPath(String rawPath)` The portion of the endpoint URL after the domain name.
`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
`void`	`setRawQueryParameters(String rawQueryParameters)` Comma separated list of message headers to include as query parameters for Raw operation.
`void`	`setReportId(String reportId)` Salesforce1 Analytics report Id
`void`	`setReportMetadata(ReportMetadata reportMetadata)` Salesforce1 Analytics report metadata for filtering
`void`	`setResultId(String resultId)` Bulk API Result ID
`void`	`setSObjectBlobFieldName(String sObjectBlobFieldName)` SObject blob field name
`void`	`setSObjectClass(String sObjectClass)` Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin
`void`	`setSObjectFields(String sObjectFields)` SObject fields to retrieve
`void`	`setSObjectId(String sObjectId)` SObject ID if required by API
`void`	`setSObjectIdName(String sObjectIdName)` SObject external ID field name
`void`	`setSObjectIdValue(String sObjectIdValue)` SObject external ID field value
`void`	`setSObjectName(String sObjectName)` SObject name if required or supported by API
`void`	`setSObjectQuery(String sObjectQuery)` Salesforce SOQL query string
`void`	`setSObjectSearch(String sObjectSearch)` Salesforce SOSL search string
`void`	`setUpdateTopic(boolean updateTopic)` Whether to update an existing Push Topic when using the Streaming API, defaults to false
`Map<String,Object>`	`toValueMap()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_VERSION
```
public static final String DEFAULT_VERSION
```
    See Also:
    
    Constant Field Values
  - API_VERSION
```
public static final String API_VERSION
```
    See Also:
    
    Constant Field Values
  - FORMAT
```
public static final String FORMAT
```
    See Also:
    
    Constant Field Values
  - RAW_PAYLOAD
```
public static final String RAW_PAYLOAD
```
    See Also:
    
    Constant Field Values
  - SOBJECT_NAME
```
public static final String SOBJECT_NAME
```
    See Also:
    
    Constant Field Values
  - SOBJECT_ID
```
public static final String SOBJECT_ID
```
    See Also:
    
    Constant Field Values
  - SOBJECT_IDS
```
public static final String SOBJECT_IDS
```
    See Also:
    
    Constant Field Values
  - SOBJECT_FIELDS
```
public static final String SOBJECT_FIELDS
```
    See Also:
    
    Constant Field Values
  - SOBJECT_EXT_ID_NAME
```
public static final String SOBJECT_EXT_ID_NAME
```
    See Also:
    
    Constant Field Values
  - SOBJECT_EXT_ID_VALUE
```
public static final String SOBJECT_EXT_ID_VALUE
```
    See Also:
    
    Constant Field Values
  - SOBJECT_BLOB_FIELD_NAME
```
public static final String SOBJECT_BLOB_FIELD_NAME
```
    See Also:
    
    Constant Field Values
  - SOBJECT_CLASS
```
public static final String SOBJECT_CLASS
```
    See Also:
    
    Constant Field Values
  - SOBJECT_QUERY
```
public static final String SOBJECT_QUERY
```
    See Also:
    
    Constant Field Values
  - SOBJECT_SEARCH
```
public static final String SOBJECT_SEARCH
```
    See Also:
    
    Constant Field Values
  - APEX_METHOD
```
public static final String APEX_METHOD
```
    See Also:
    
    Constant Field Values
  - APEX_URL
```
public static final String APEX_URL
```
    See Also:
    
    Constant Field Values
  - COMPOSITE_METHOD
```
public static final String COMPOSITE_METHOD
```
    See Also:
    
    Constant Field Values
  - LIMIT
```
public static final String LIMIT
```
    See Also:
    
    Constant Field Values
  - ALL_OR_NONE
```
public static final String ALL_OR_NONE
```
    See Also:
    
    Constant Field Values
  - APEX_QUERY_PARAM_PREFIX
```
public static final String APEX_QUERY_PARAM_PREFIX
```
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - JOB_ID
```
public static final String JOB_ID
```
    See Also:
    
    Constant Field Values
  - BATCH_ID
```
public static final String BATCH_ID
```
    See Also:
    
    Constant Field Values
  - RESULT_ID
```
public static final String RESULT_ID
```
    See Also:
    
    Constant Field Values
  - QUERY_LOCATOR
```
public static final String QUERY_LOCATOR
```
    See Also:
    
    Constant Field Values
  - LOCATOR
```
public static final String LOCATOR
```
    See Also:
    
    Constant Field Values
  - MAX_RECORDS
```
public static final String MAX_RECORDS
```
    See Also:
    
    Constant Field Values
  - PK_CHUNKING
```
public static final String PK_CHUNKING
```
    See Also:
    
    Constant Field Values
  - PK_CHUNKING_CHUNK_SIZE
```
public static final String PK_CHUNKING_CHUNK_SIZE
```
    See Also:
    
    Constant Field Values
  - PK_CHUNKING_PARENT
```
public static final String PK_CHUNKING_PARENT
```
    See Also:
    
    Constant Field Values
  - PK_CHUNKING_START_ROW
```
public static final String PK_CHUNKING_START_ROW
```
    See Also:
    
    Constant Field Values
  - REPORT_ID
```
public static final String REPORT_ID
```
    See Also:
    
    Constant Field Values
  - INCLUDE_DETAILS
```
public static final String INCLUDE_DETAILS
```
    See Also:
    
    Constant Field Values
  - REPORT_METADATA
```
public static final String REPORT_METADATA
```
    See Also:
    
    Constant Field Values
  - INSTANCE_ID
```
public static final String INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - DEFAULT_REPLAY_ID
```
public static final String DEFAULT_REPLAY_ID
```
    See Also:
    
    Constant Field Values
  - FALL_BACK_REPLAY_ID
```
public static final String FALL_BACK_REPLAY_ID
```
    See Also:
    
    Constant Field Values
  - INITIAL_REPLAY_ID_MAP
```
public static final String INITIAL_REPLAY_ID_MAP
```
    See Also:
    
    Constant Field Values
  - REPLAY_FROM_TIP
```
public static final long REPLAY_FROM_TIP
```
    See Also:
    
    Constant Field Values
  - APPROVAL
```
public static final String APPROVAL
```
    See Also:
    
    Constant Field Values
  - RAW_PATH
```
public static final String RAW_PATH
```
    See Also:
    
    Constant Field Values
  - RAW_METHOD
```
public static final String RAW_METHOD
```
    See Also:
    
    Constant Field Values
  - RAW_QUERY_PARAMETERS
```
public static final String RAW_QUERY_PARAMETERS
```
    See Also:
    
    Constant Field Values
  - RAW_HTTP_HEADERS
```
public static final String RAW_HTTP_HEADERS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_AUTHENTICATION_RETRIES
```
public static final int DEFAULT_MAX_AUTHENTICATION_RETRIES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BACKOFF_INCREMENT
```
public static final long DEFAULT_BACKOFF_INCREMENT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_BACKOFF
```
public static final long DEFAULT_MAX_BACKOFF
```
    See Also:
    
    Constant Field Values
  - NOT_FOUND_BEHAVIOUR
```
public static final String NOT_FOUND_BEHAVIOUR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SalesforceEndpointConfig
```
public SalesforceEndpointConfig()
```
- Method Detail
  - copy
```
public SalesforceEndpointConfig copy()
```
  - getFormat
```
public PayloadFormat getFormat()
```
  - 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()
```
  - 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
  - getApexQueryParams
```
public Map<String,Object> getApexQueryParams()
```
  - 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)
```
  - getApproval
```
public ApprovalRequest getApproval()
```
  - setApproval
```
public void setApproval(ApprovalRequest approval)
```
    The approval request for Approval API.
    
    Parameters:
    
    approval -
  - getContentType
```
public ContentType getContentType()
```
  - 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
  - getNotifyForFields
```
public NotifyForFieldsEnum getNotifyForFields()
```
  - setNotifyForFields
```
public void setNotifyForFields(NotifyForFieldsEnum notifyForFields)
```
    Notify for fields, options are ALL, REFERENCED, SELECT, WHERE
  - getNotifyForOperations
```
public NotifyForOperationsEnum getNotifyForOperations()
```
  - 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.
  - getReportMetadata
```
public ReportMetadata getReportMetadata()
```
  - 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.
  - getHttpClient
```
public SalesforceHttpClient getHttpClient()
```
  - 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.
  - toValueMap
```
public Map<String,Object> toValueMap()
```
  - 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 -
  - getApprovalActionType
```
public ApprovalRequest.Action getApprovalActionType()
```
  - 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 -
  - getNotFoundBehaviour
```
public NotFoundBehaviour getNotFoundBehaviour()
```
  - setNotFoundBehaviour
```
public void setNotFoundBehaviour(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.
  - 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.
    
    Parameters:
    
    -

Class SalesforceEndpointConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_VERSION

API_VERSION

FORMAT

RAW_PAYLOAD

SOBJECT_NAME

SOBJECT_ID

SOBJECT_IDS

SOBJECT_FIELDS

SOBJECT_EXT_ID_NAME

SOBJECT_EXT_ID_VALUE

SOBJECT_BLOB_FIELD_NAME

SOBJECT_CLASS

SOBJECT_QUERY

SOBJECT_SEARCH

APEX_METHOD

APEX_URL

COMPOSITE_METHOD

LIMIT

ALL_OR_NONE

APEX_QUERY_PARAM_PREFIX

CONTENT_TYPE

JOB_ID

BATCH_ID

RESULT_ID

QUERY_LOCATOR

LOCATOR

MAX_RECORDS

PK_CHUNKING

PK_CHUNKING_CHUNK_SIZE

PK_CHUNKING_PARENT

PK_CHUNKING_START_ROW

REPORT_ID

INCLUDE_DETAILS

REPORT_METADATA

INSTANCE_ID

DEFAULT_REPLAY_ID

FALL_BACK_REPLAY_ID

INITIAL_REPLAY_ID_MAP

REPLAY_FROM_TIP

APPROVAL

RAW_PATH

RAW_METHOD

RAW_QUERY_PARAMETERS

RAW_HTTP_HEADERS

DEFAULT_MAX_AUTHENTICATION_RETRIES

DEFAULT_BACKOFF_INCREMENT

DEFAULT_MAX_BACKOFF

NOT_FOUND_BEHAVIOUR

Constructor Detail

SalesforceEndpointConfig

Method Detail

copy

getFormat

setFormat

isRawPayload

setRawPayload

getApiVersion

setApiVersion

getSObjectName

setSObjectName

getSObjectId

setSObjectId

getSObjectFields

setSObjectFields

getSObjectIdName

setSObjectIdName

getSObjectIdValue

setSObjectIdValue

getSObjectBlobFieldName

setSObjectBlobFieldName

getSObjectClass

setSObjectClass

getSObjectQuery

setSObjectQuery