This is an automated email from the ASF dual-hosted git repository.
jeremyross pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 30d15e84d2e camel-salesforce: Document header.
30d15e84d2e is described below
commit 30d15e84d2ee7cdfe3cc9dc67f46943c85b853e4
Author: Jeremy Ross <[email protected]>
AuthorDate: Tue Jul 26 15:08:58 2022 -0500
camel-salesforce: Document header.
Header: CamelSalesforceQueryResultTotalSize
---
.../resources/org/apache/camel/component/salesforce/salesforce.json | 3 ++-
.../src/main/docs/salesforce-component.adoc | 4 ++--
.../org/apache/camel/component/salesforce/SalesforceConstants.java | 3 +++
.../component/salesforce/internal/processor/JsonRestProcessor.java | 4 ++--
.../it/resources/CamelSalesforceIntegrationTests.connectedApp | 2 +-
5 files changed, 10 insertions(+), 6 deletions(-)
diff --git
a/components/camel-salesforce/camel-salesforce-component/src/generated/resources/org/apache/camel/component/salesforce/salesforce.json
b/components/camel-salesforce/camel-salesforce-component/src/generated/resources/org/apache/camel/component/salesforce/salesforce.json
index e3b96ec8a08..56ef73e696e 100644
---
a/components/camel-salesforce/camel-salesforce-component/src/generated/resources/org/apache/camel/component/salesforce/salesforce.json
+++
b/components/camel-salesforce/camel-salesforce-component/src/generated/resources/org/apache/camel/component/salesforce/salesforce.json
@@ -134,7 +134,8 @@
"CamelSalesforceCreatedDate": { "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"java.time.ZonedDateTime", "deprecated": false, "deprecationNote": "",
"autowired": false, "secret": false, "description": "The created date.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CREATED_DATE"
},
"CamelSalesforceTopicName": { "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The topic name.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_TOPIC_NAME"
},
"CamelSalesforceChannel": { "kind": "header", "displayName": "", "group":
"consumer", "label": "consumer", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "The channel.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CHANNEL"
},
- "CamelSalesforceClientId": { "kind": "header", "displayName": "", "group":
"consumer", "label": "consumer", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "The client id.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CLIENT_ID"
}
+ "CamelSalesforceClientId": { "kind": "header", "displayName": "", "group":
"consumer", "label": "consumer", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "The client id.", "constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_CLIENT_ID"
},
+ "CamelSalesforceQueryResultTotalSize": { "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"int", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "Total number of records matching a query.",
"constantName":
"org.apache.camel.component.salesforce.SalesforceConstants#HEADER_SALESFORCE_QUERY_RESULT_TOTAL_SIZE"
}
},
"properties": {
"operationName": { "kind": "path", "displayName": "Operation Name",
"group": "producer", "label": "producer", "required": false, "type": "object",
"javaType": "org.apache.camel.component.salesforce.internal.OperationName",
"enum": [ "getVersions", "getResources", "getGlobalObjects", "getBasicInfo",
"getDescription", "getSObject", "createSObject", "updateSObject",
"deleteSObject", "getSObjectWithId", "upsertSObject", "deleteSObjectWithId",
"getBlobField", "query", "queryMore", "queryA [...]
diff --git
a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
index 7add05acdc6..c527bbe02d3 100644
---
a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
+++
b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
@@ -522,7 +522,7 @@ Deletes a record in salesforce by External ID.
`query`
-Runs a Salesforce SOQL query
+Runs a Salesforce SOQL query.
|===
| Parameter | Type | Description | Default | Required
@@ -535,7 +535,7 @@ Runs a Salesforce SOQL query
*Output*
-Type: Instance of class supplied in `sObjectClass`, or `Iterator<SomeSObject>`
if `streamQueryResult` is true.
+Type: Instance of class supplied in `sObjectClass`, or `Iterator<SomeSObject>`
if `streamQueryResult` is true. If `streamQueryResult` is true, the header
`CamelSalesforceQueryResultTotalSize` is set to the number of records that
matched the query.
[[queryMore]]
==== Query More
diff --git
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceConstants.java
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceConstants.java
index e0b2781ad44..0d8872361c2 100644
---
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceConstants.java
+++
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceConstants.java
@@ -57,6 +57,9 @@ public final class SalesforceConstants {
@Metadata(label = "consumer", description = "The client id.", javaType =
"String")
public static final String HEADER_SALESFORCE_CLIENT_ID =
"CamelSalesforceClientId";
+ @Metadata(label = "producer", description = "Total number of records
matching a query.", javaType = "int")
+ public static final String HEADER_SALESFORCE_QUERY_RESULT_TOTAL_SIZE =
"CamelSalesforceQueryResultTotalSize";
+
private SalesforceConstants() {
}
diff --git
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/internal/processor/JsonRestProcessor.java
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/internal/processor/JsonRestProcessor.java
index a9d40ea0f3d..fd8bf7094f1 100644
---
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/internal/processor/JsonRestProcessor.java
+++
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/internal/processor/JsonRestProcessor.java
@@ -44,9 +44,9 @@ import
org.apache.camel.component.salesforce.api.dto.approval.ApprovalResult;
import org.apache.camel.component.salesforce.api.dto.approval.Approvals;
import org.apache.camel.component.salesforce.api.utils.JsonUtils;
-public class JsonRestProcessor extends AbstractRestProcessor {
+import static
org.apache.camel.component.salesforce.SalesforceConstants.HEADER_SALESFORCE_QUERY_RESULT_TOTAL_SIZE;
- public static final String HEADER_SALESFORCE_QUERY_RESULT_TOTAL_SIZE =
"CamelSalesforceQueryResultTotalSize";
+public class JsonRestProcessor extends AbstractRestProcessor {
// it is ok to use a single thread safe ObjectMapper
private final ObjectMapper objectMapper;
diff --git
a/components/camel-salesforce/it/resources/CamelSalesforceIntegrationTests.connectedApp
b/components/camel-salesforce/it/resources/CamelSalesforceIntegrationTests.connectedApp
index ae4f9c265d5..0dbb442a6a6 100644
---
a/components/camel-salesforce/it/resources/CamelSalesforceIntegrationTests.connectedApp
+++
b/components/camel-salesforce/it/resources/CamelSalesforceIntegrationTests.connectedApp
@@ -16,7 +16,7 @@
limitations under the License.
-->
<ConnectedApp xmlns="http://soap.sforce.com/2006/04/metadata";>
- <contactEmail>[email protected]</contactEmail>
+ <contactEmail>[email protected]</contactEmail>
<label>CamelSalesforceIntegrationTests</label>
<oauthConfig>
<callbackUrl>https://login.salesforce.com/services/oauth2/success</callbackUrl>
