This is an automated email from the ASF dual-hosted git repository.
davsclaus 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 6e33d0081f2f Improve documentation for IBM Cloud Object Storage
related to endpoint (#20191)
6e33d0081f2f is described below
commit 6e33d0081f2f1cdce1ae000bd05eda14f7ed8119
Author: Aurélien Pupier <[email protected]>
AuthorDate: Wed Dec 3 14:14:03 2025 +0100
Improve documentation for IBM Cloud Object Storage related to endpoint
(#20191)
Signed-off-by: Aurélien Pupier <[email protected]>
---
.../org/apache/camel/catalog/components/ibm-cos.json | 4 ++--
.../META-INF/org/apache/camel/component/ibm/cos/ibm-cos.json | 4 ++--
.../camel-ibm-cos/src/main/docs/ibm-cos-component.adoc | 2 ++
.../apache/camel/component/ibm/cos/IBMCOSConfiguration.java | 3 ++-
.../builder/component/dsl/IbmCosComponentBuilderFactory.java | 4 +++-
.../builder/endpoint/dsl/IBMCOSEndpointBuilderFactory.java | 12 +++++++++---
6 files changed, 20 insertions(+), 9 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/ibm-cos.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/ibm-cos.json
index fbc0a889031a..ba0386123e32 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/ibm-cos.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/ibm-cos.json
@@ -27,7 +27,7 @@
"autoCreateBucket": { "index": 0, "kind": "property", "displayName": "Auto
Create Bucket", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "Automatically create the bucket if it doesn't
exist" },
"configuration": { "index": 1, "kind": "property", "displayName":
"Configuration", "group": "common", "label": "", "required": false, "type":
"object", "javaType": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"deprecated": false, "autowired": false, "secret": false, "description": "The
component configuration" },
"delimiter": { "index": 2, "kind": "property", "displayName": "Delimiter",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "The delimiter to use for listing objects" },
- "endpointUrl": { "index": 3, "kind": "property", "displayName": "Endpoint
Url", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "IBM COS Endpoint URL (e.g.,
https:\/\/s3.us-south.cloud-object-storage.appdomain.cloud)" },
+ "endpointUrl": { "index": 3, "kind": "property", "displayName": "Endpoint
Url", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "IBM COS Endpoint URL (e.g.,
https:\/\/s3.us-south.cloud-object-storage.appdomain.cloud) Note that some
operations [...]
"location": { "index": 4, "kind": "property", "displayName": "Location",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "IBM COS Location\/Region (e.g., us-south,
eu-gb)" },
"prefix": { "index": 5, "kind": "property", "displayName": "Prefix",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "The prefix to use for listing objects" },
"bridgeErrorHandler": { "index": 6, "kind": "property", "displayName":
"Bridge Error Handler", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Allows for bridging the consumer to the Camel routing Error Handler, which
mean any exceptions (if possible) occurred while the Camel consumer is trying
to pickup incoming messages, or the like [...]
@@ -81,7 +81,7 @@
"bucketName": { "index": 0, "kind": "path", "displayName": "Bucket Name",
"group": "common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Bucket name" },
"autoCreateBucket": { "index": 1, "kind": "parameter", "displayName":
"Auto Create Bucket", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "Automatically create the bucket if it doesn't
exist" },
"delimiter": { "index": 2, "kind": "parameter", "displayName":
"Delimiter", "group": "common", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "The delimiter to use for listing objects" },
- "endpointUrl": { "index": 3, "kind": "parameter", "displayName": "Endpoint
Url", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "IBM COS Endpoint URL (e.g.,
https:\/\/s3.us-south.cloud-object-storage.appdomain.cloud)" },
+ "endpointUrl": { "index": 3, "kind": "parameter", "displayName": "Endpoint
Url", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "IBM COS Endpoint URL (e.g.,
https:\/\/s3.us-south.cloud-object-storage.appdomain.cloud) Note that some
operations [...]
"location": { "index": 4, "kind": "parameter", "displayName": "Location",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "IBM COS Location\/Region (e.g., us-south,
eu-gb)" },
"prefix": { "index": 5, "kind": "parameter", "displayName": "Prefix",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "The prefix to use for listing objects" },
"deleteAfterRead": { "index": 6, "kind": "parameter", "displayName":
"Delete After Read", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration", "description": "Delete the object from
IBM COS after it has been retrieved" },
diff --git
a/components/camel-ibm/camel-ibm-cos/src/generated/resources/META-INF/org/apache/camel/component/ibm/cos/ibm-cos.json
b/components/camel-ibm/camel-ibm-cos/src/generated/resources/META-INF/org/apache/camel/component/ibm/cos/ibm-cos.json
index fbc0a889031a..ba0386123e32 100644
---
a/components/camel-ibm/camel-ibm-cos/src/generated/resources/META-INF/org/apache/camel/component/ibm/cos/ibm-cos.json
+++
b/components/camel-ibm/camel-ibm-cos/src/generated/resources/META-INF/org/apache/camel/component/ibm/cos/ibm-cos.json
@@ -27,7 +27,7 @@
"autoCreateBucket": { "index": 0, "kind": "property", "displayName": "Auto
Create Bucket", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "Automatically create the bucket if it doesn't
exist" },
"configuration": { "index": 1, "kind": "property", "displayName":
"Configuration", "group": "common", "label": "", "required": false, "type":
"object", "javaType": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"deprecated": false, "autowired": false, "secret": false, "description": "The
component configuration" },
"delimiter": { "index": 2, "kind": "property", "displayName": "Delimiter",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "The delimiter to use for listing objects" },
- "endpointUrl": { "index": 3, "kind": "property", "displayName": "Endpoint
Url", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "IBM COS Endpoint URL (e.g.,
https:\/\/s3.us-south.cloud-object-storage.appdomain.cloud)" },
+ "endpointUrl": { "index": 3, "kind": "property", "displayName": "Endpoint
Url", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "IBM COS Endpoint URL (e.g.,
https:\/\/s3.us-south.cloud-object-storage.appdomain.cloud) Note that some
operations [...]
"location": { "index": 4, "kind": "property", "displayName": "Location",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "IBM COS Location\/Region (e.g., us-south,
eu-gb)" },
"prefix": { "index": 5, "kind": "property", "displayName": "Prefix",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "The prefix to use for listing objects" },
"bridgeErrorHandler": { "index": 6, "kind": "property", "displayName":
"Bridge Error Handler", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Allows for bridging the consumer to the Camel routing Error Handler, which
mean any exceptions (if possible) occurred while the Camel consumer is trying
to pickup incoming messages, or the like [...]
@@ -81,7 +81,7 @@
"bucketName": { "index": 0, "kind": "path", "displayName": "Bucket Name",
"group": "common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Bucket name" },
"autoCreateBucket": { "index": 1, "kind": "parameter", "displayName":
"Auto Create Bucket", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "Automatically create the bucket if it doesn't
exist" },
"delimiter": { "index": 2, "kind": "parameter", "displayName":
"Delimiter", "group": "common", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "The delimiter to use for listing objects" },
- "endpointUrl": { "index": 3, "kind": "parameter", "displayName": "Endpoint
Url", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "IBM COS Endpoint URL (e.g.,
https:\/\/s3.us-south.cloud-object-storage.appdomain.cloud)" },
+ "endpointUrl": { "index": 3, "kind": "parameter", "displayName": "Endpoint
Url", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "IBM COS Endpoint URL (e.g.,
https:\/\/s3.us-south.cloud-object-storage.appdomain.cloud) Note that some
operations [...]
"location": { "index": 4, "kind": "parameter", "displayName": "Location",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "IBM COS Location\/Region (e.g., us-south,
eu-gb)" },
"prefix": { "index": 5, "kind": "parameter", "displayName": "Prefix",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ibm.cos.IBMCOSConfiguration", "configurationField":
"configuration", "description": "The prefix to use for listing objects" },
"deleteAfterRead": { "index": 6, "kind": "parameter", "displayName":
"Delete After Read", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration", "description": "Delete the object from
IBM COS after it has been retrieved" },
diff --git
a/components/camel-ibm/camel-ibm-cos/src/main/docs/ibm-cos-component.adoc
b/components/camel-ibm/camel-ibm-cos/src/main/docs/ibm-cos-component.adoc
index 8478c1d86b50..39a03822a5b6 100644
--- a/components/camel-ibm/camel-ibm-cos/src/main/docs/ibm-cos-component.adoc
+++ b/components/camel-ibm/camel-ibm-cos/src/main/docs/ibm-cos-component.adoc
@@ -127,6 +127,8 @@ Examples:
For a complete list of endpoints, see
https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints[IBM
COS Endpoints documentation].
+Note that several operations requires a regional endpoint, as opposed to a
cross-region endpoint.
+
=== IBM COS Producer Operation examples
- Single Upload: This operation will upload a file to IBM COS based on the
body content
diff --git
a/components/camel-ibm/camel-ibm-cos/src/main/java/org/apache/camel/component/ibm/cos/IBMCOSConfiguration.java
b/components/camel-ibm/camel-ibm-cos/src/main/java/org/apache/camel/component/ibm/cos/IBMCOSConfiguration.java
index f329551ae698..8ec4f1bb8915 100644
---
a/components/camel-ibm/camel-ibm-cos/src/main/java/org/apache/camel/component/ibm/cos/IBMCOSConfiguration.java
+++
b/components/camel-ibm/camel-ibm-cos/src/main/java/org/apache/camel/component/ibm/cos/IBMCOSConfiguration.java
@@ -134,7 +134,8 @@ public class IBMCOSConfiguration implements Cloneable {
}
/**
- * IBM COS Endpoint URL (e.g.,
https://s3.us-south.cloud-object-storage.appdomain.cloud)
+ * IBM COS Endpoint URL (e.g.,
https://s3.us-south.cloud-object-storage.appdomain.cloud) Note that some
operations
+ * requires to use a regional endpoint URL instead of a cross-region one.
*/
public void setEndpointUrl(String endpointUrl) {
this.endpointUrl = endpointUrl;
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/IbmCosComponentBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/IbmCosComponentBuilderFactory.java
index e054fe8ccbcd..135fa3901cac 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/IbmCosComponentBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/IbmCosComponentBuilderFactory.java
@@ -100,7 +100,9 @@ public interface IbmCosComponentBuilderFactory {
/**
* IBM COS Endpoint URL (e.g.,
- * https://s3.us-south.cloud-object-storage.appdomain.cloud).
+ * https://s3.us-south.cloud-object-storage.appdomain.cloud) Note that
+ * some operations requires to use a regional endpoint URL instead of a
+ * cross-region one.
*
* The option is a: <code>java.lang.String</code> type.
*
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/IBMCOSEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/IBMCOSEndpointBuilderFactory.java
index 21f53f63b2ab..1e5b5a35707c 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/IBMCOSEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/IBMCOSEndpointBuilderFactory.java
@@ -89,7 +89,9 @@ public interface IBMCOSEndpointBuilderFactory {
}
/**
* IBM COS Endpoint URL (e.g.,
- * https://s3.us-south.cloud-object-storage.appdomain.cloud).
+ * https://s3.us-south.cloud-object-storage.appdomain.cloud) Note that
+ * some operations requires to use a regional endpoint URL instead of a
+ * cross-region one.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1169,7 +1171,9 @@ public interface IBMCOSEndpointBuilderFactory {
}
/**
* IBM COS Endpoint URL (e.g.,
- * https://s3.us-south.cloud-object-storage.appdomain.cloud).
+ * https://s3.us-south.cloud-object-storage.appdomain.cloud) Note that
+ * some operations requires to use a regional endpoint URL instead of a
+ * cross-region one.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1534,7 +1538,9 @@ public interface IBMCOSEndpointBuilderFactory {
}
/**
* IBM COS Endpoint URL (e.g.,
- * https://s3.us-south.cloud-object-storage.appdomain.cloud).
+ * https://s3.us-south.cloud-object-storage.appdomain.cloud) Note that
+ * some operations requires to use a regional endpoint URL instead of a
+ * cross-region one.
*
* The option is a: <code>java.lang.String</code> type.
*
