You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2025/09/17 11:23:32 UTC
(camel) 01/01: CAMEL-22427 - Camel-AWS2-Textract: Improve Headers metadata in constant class
This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch textract-constant
in repository https://gitbox.apache.org/repos/asf/camel.git
commit d146100c8eb69a8820f1efdfe644e5a2ddfca4ae
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Wed Sep 17 13:22:45 2025 +0200
CAMEL-22427 - Camel-AWS2-Textract: Improve Headers metadata in constant class
Signed-off-by: Andrea Cosentino <an...@gmail.com>
---
.../camel/catalog/components/aws2-textract.json | 16 ++++++++--------
.../component/aws2/textract/aws2-textract.json | 16 ++++++++--------
.../component/aws2/textract/Textract2Constants.java | 21 +++++++++++++--------
.../dsl/Textract2EndpointBuilderFactory.java | 17 ++++++++++-------
4 files changed, 39 insertions(+), 31 deletions(-)
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-textract.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-textract.json
index 8a5ed70868f..7ddb801634d 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-textract.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-textract.json
@@ -51,14 +51,14 @@
"useSessionCredentials": { "index": 24, "kind": "property", "displayName": "Use Session Credentials", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.textract.Textract2Configuration", "configurationField": "configuration", "description": "Set whether the Textract client should expect to use Sessi [...]
},
"headers": {
- "CamelAwsTextractOperation": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The operation we want to perform", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#OPERATION" },
- "CamelAwsTextractS3Bucket": { "index": 1, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The S3 bucket name", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#S3_BUCKET" },
- "CamelAwsTextractS3Object": { "index": 2, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The S3 object name", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#S3_OBJECT" },
- "CamelAwsTextractS3ObjectVersion": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The S3 object version", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#S3_OBJECT_VERSION" },
- "CamelAwsTextractJobId": { "index": 4, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The job ID for async operations", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#JOB_ID" },
- "CamelAwsTextractMaxResults": { "index": 5, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The max results to return", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#MAX_RESULTS" },
- "CamelAwsTextractNextToken": { "index": 6, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The next token for pagination", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#NEXT_TOKEN" },
- "CamelAwsTextractFeatureTypes": { "index": 7, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "List<FeatureType>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The feature types for document analysis", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#FEATURE_TYPES" }
+ "CamelAwsTextractOperation": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The operation we want to perform", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#OPERATION" },
+ "CamelAwsTextractS3Bucket": { "index": 1, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The S3 bucket name containing the document to process", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#S3_BUCKET" },
+ "CamelAwsTextractS3Object": { "index": 2, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The S3 object name (key) of the document to process", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#S3_OBJECT" },
+ "CamelAwsTextractS3ObjectVersion": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The S3 object version of the document to process", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#S3_OBJECT_VERSION" },
+ "CamelAwsTextractJobId": { "index": 4, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The job ID for async operations (StartDocumentTextDetection, StartDocumentAnalysis)", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#JOB_ID" },
+ "CamelAwsTextractMaxResults": { "index": 5, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The maximum number of results to return in paginated operations", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#MAX_RESULTS" },
+ "CamelAwsTextractNextToken": { "index": 6, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The next token for pagination in operations that return multiple pages", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#NEXT_TOKEN" },
+ "CamelAwsTextractFeatureTypes": { "index": 7, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "List<FeatureType>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The feature types for document analysis (TABLES, FORMS, SIGNATURES, etc.)", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#FEATURE_TYPES" }
},
"properties": {
"label": { "index": 0, "kind": "path", "displayName": "Label", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.textract.Textract2Configuration", "configurationField": "configuration", "description": "Logical name" },
diff --git a/components/camel-aws/camel-aws2-textract/src/generated/resources/META-INF/org/apache/camel/component/aws2/textract/aws2-textract.json b/components/camel-aws/camel-aws2-textract/src/generated/resources/META-INF/org/apache/camel/component/aws2/textract/aws2-textract.json
index 8a5ed70868f..7ddb801634d 100644
--- a/components/camel-aws/camel-aws2-textract/src/generated/resources/META-INF/org/apache/camel/component/aws2/textract/aws2-textract.json
+++ b/components/camel-aws/camel-aws2-textract/src/generated/resources/META-INF/org/apache/camel/component/aws2/textract/aws2-textract.json
@@ -51,14 +51,14 @@
"useSessionCredentials": { "index": 24, "kind": "property", "displayName": "Use Session Credentials", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.textract.Textract2Configuration", "configurationField": "configuration", "description": "Set whether the Textract client should expect to use Sessi [...]
},
"headers": {
- "CamelAwsTextractOperation": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The operation we want to perform", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#OPERATION" },
- "CamelAwsTextractS3Bucket": { "index": 1, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The S3 bucket name", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#S3_BUCKET" },
- "CamelAwsTextractS3Object": { "index": 2, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The S3 object name", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#S3_OBJECT" },
- "CamelAwsTextractS3ObjectVersion": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The S3 object version", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#S3_OBJECT_VERSION" },
- "CamelAwsTextractJobId": { "index": 4, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The job ID for async operations", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#JOB_ID" },
- "CamelAwsTextractMaxResults": { "index": 5, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The max results to return", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#MAX_RESULTS" },
- "CamelAwsTextractNextToken": { "index": 6, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The next token for pagination", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#NEXT_TOKEN" },
- "CamelAwsTextractFeatureTypes": { "index": 7, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "List<FeatureType>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The feature types for document analysis", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#FEATURE_TYPES" }
+ "CamelAwsTextractOperation": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The operation we want to perform", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#OPERATION" },
+ "CamelAwsTextractS3Bucket": { "index": 1, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The S3 bucket name containing the document to process", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#S3_BUCKET" },
+ "CamelAwsTextractS3Object": { "index": 2, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The S3 object name (key) of the document to process", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#S3_OBJECT" },
+ "CamelAwsTextractS3ObjectVersion": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The S3 object version of the document to process", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#S3_OBJECT_VERSION" },
+ "CamelAwsTextractJobId": { "index": 4, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The job ID for async operations (StartDocumentTextDetection, StartDocumentAnalysis)", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#JOB_ID" },
+ "CamelAwsTextractMaxResults": { "index": 5, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The maximum number of results to return in paginated operations", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#MAX_RESULTS" },
+ "CamelAwsTextractNextToken": { "index": 6, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The next token for pagination in operations that return multiple pages", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#NEXT_TOKEN" },
+ "CamelAwsTextractFeatureTypes": { "index": 7, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "List<FeatureType>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The feature types for document analysis (TABLES, FORMS, SIGNATURES, etc.)", "constantName": "org.apache.camel.component.aws2.textract.Textract2Constants#FEATURE_TYPES" }
},
"properties": {
"label": { "index": 0, "kind": "path", "displayName": "Label", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.textract.Textract2Configuration", "configurationField": "configuration", "description": "Logical name" },
diff --git a/components/camel-aws/camel-aws2-textract/src/main/java/org/apache/camel/component/aws2/textract/Textract2Constants.java b/components/camel-aws/camel-aws2-textract/src/main/java/org/apache/camel/component/aws2/textract/Textract2Constants.java
index 159b5a1ebdf..67114911c2d 100644
--- a/components/camel-aws/camel-aws2-textract/src/main/java/org/apache/camel/component/aws2/textract/Textract2Constants.java
+++ b/components/camel-aws/camel-aws2-textract/src/main/java/org/apache/camel/component/aws2/textract/Textract2Constants.java
@@ -22,20 +22,25 @@ import org.apache.camel.spi.Metadata;
* Constants used in Camel AWS2 Textract module
*/
public interface Textract2Constants {
- @Metadata(description = "The operation we want to perform", javaType = "String")
+ @Metadata(label = "producer", description = "The operation we want to perform", javaType = "String")
String OPERATION = "CamelAwsTextractOperation";
- @Metadata(description = "The S3 bucket name", javaType = "String")
+ @Metadata(label = "producer", description = "The S3 bucket name containing the document to process", javaType = "String")
String S3_BUCKET = "CamelAwsTextractS3Bucket";
- @Metadata(description = "The S3 object name", javaType = "String")
+ @Metadata(label = "producer", description = "The S3 object name (key) of the document to process", javaType = "String")
String S3_OBJECT = "CamelAwsTextractS3Object";
- @Metadata(description = "The S3 object version", javaType = "String")
+ @Metadata(label = "producer", description = "The S3 object version of the document to process", javaType = "String")
String S3_OBJECT_VERSION = "CamelAwsTextractS3ObjectVersion";
- @Metadata(description = "The job ID for async operations", javaType = "String")
+ @Metadata(label = "producer",
+ description = "The job ID for async operations (StartDocumentTextDetection, StartDocumentAnalysis)",
+ javaType = "String")
String JOB_ID = "CamelAwsTextractJobId";
- @Metadata(description = "The max results to return", javaType = "Integer")
+ @Metadata(label = "producer", description = "The maximum number of results to return in paginated operations",
+ javaType = "Integer")
String MAX_RESULTS = "CamelAwsTextractMaxResults";
- @Metadata(description = "The next token for pagination", javaType = "String")
+ @Metadata(label = "producer", description = "The next token for pagination in operations that return multiple pages",
+ javaType = "String")
String NEXT_TOKEN = "CamelAwsTextractNextToken";
- @Metadata(description = "The feature types for document analysis", javaType = "List<FeatureType>")
+ @Metadata(label = "producer", description = "The feature types for document analysis (TABLES, FORMS, SIGNATURES, etc.)",
+ javaType = "List<FeatureType>")
String FEATURE_TYPES = "CamelAwsTextractFeatureTypes";
}
diff --git a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/Textract2EndpointBuilderFactory.java b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/Textract2EndpointBuilderFactory.java
index 45c2f8746cb..52b3158f8fc 100644
--- a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/Textract2EndpointBuilderFactory.java
+++ b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/Textract2EndpointBuilderFactory.java
@@ -653,7 +653,7 @@ public interface Textract2EndpointBuilderFactory {
return "CamelAwsTextractOperation";
}
/**
- * The S3 bucket name.
+ * The S3 bucket name containing the document to process.
*
* The option is a: {@code String} type.
*
@@ -665,7 +665,7 @@ public interface Textract2EndpointBuilderFactory {
return "CamelAwsTextractS3Bucket";
}
/**
- * The S3 object name.
+ * The S3 object name (key) of the document to process.
*
* The option is a: {@code String} type.
*
@@ -677,7 +677,7 @@ public interface Textract2EndpointBuilderFactory {
return "CamelAwsTextractS3Object";
}
/**
- * The S3 object version.
+ * The S3 object version of the document to process.
*
* The option is a: {@code String} type.
*
@@ -689,7 +689,8 @@ public interface Textract2EndpointBuilderFactory {
return "CamelAwsTextractS3ObjectVersion";
}
/**
- * The job ID for async operations.
+ * The job ID for async operations (StartDocumentTextDetection,
+ * StartDocumentAnalysis).
*
* The option is a: {@code String} type.
*
@@ -701,7 +702,7 @@ public interface Textract2EndpointBuilderFactory {
return "CamelAwsTextractJobId";
}
/**
- * The max results to return.
+ * The maximum number of results to return in paginated operations.
*
* The option is a: {@code Integer} type.
*
@@ -713,7 +714,8 @@ public interface Textract2EndpointBuilderFactory {
return "CamelAwsTextractMaxResults";
}
/**
- * The next token for pagination.
+ * The next token for pagination in operations that return multiple
+ * pages.
*
* The option is a: {@code String} type.
*
@@ -725,7 +727,8 @@ public interface Textract2EndpointBuilderFactory {
return "CamelAwsTextractNextToken";
}
/**
- * The feature types for document analysis.
+ * The feature types for document analysis (TABLES, FORMS, SIGNATURES,
+ * etc.).
*
* The option is a: {@code List<FeatureType>} type.
*