This is an automated email from the ASF dual-hosted git repository. nfilotto pushed a commit to branch CAMEL-17792/doc-message-headers in repository https://gitbox.apache.org/repos/asf/camel.git
commit b211dcf34d33ce65625bfc318496b81f4e37d079 Author: Nicolas Filotto <[email protected]> AuthorDate: Wed Mar 16 10:14:58 2022 +0100 CAMEL-17792: Add doc about the message headers of camel-aws2-eventbridge --- .../camel/component/aws2/eventbridge/aws2-eventbridge.json | 9 +++++++++ .../src/main/docs/aws2-eventbridge-component.adoc | 5 ++++- .../camel/component/aws2/eventbridge/EventbridgeConstants.java | 9 +++++++++ .../camel/component/aws2/eventbridge/EventbridgeEndpoint.java | 3 ++- 4 files changed, 24 insertions(+), 2 deletions(-) diff --git a/components/camel-aws/camel-aws2-eventbridge/src/generated/resources/org/apache/camel/component/aws2/eventbridge/aws2-eventbridge.json b/components/camel-aws/camel-aws2-eventbridge/src/generated/resources/org/apache/camel/component/aws2/eventbridge/aws2-eventbridge.json index f764c3b..43514ad 100644 --- a/components/camel-aws/camel-aws2-eventbridge/src/generated/resources/org/apache/camel/component/aws2/eventbridge/aws2-eventbridge.json +++ b/components/camel-aws/camel-aws2-eventbridge/src/generated/resources/org/apache/camel/component/aws2/eventbridge/aws2-eventbridge.json @@ -40,6 +40,15 @@ "accessKey": { "kind": "property", "displayName": "Access Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key" }, "secretKey": { "kind": "property", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" } }, + "headers": { + "CamelAwsEventbridgeOperation": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The operation we want to perform" }, + "CamelAwsEventbridgeRuleName": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The name of the rule." }, + "CamelAwsEventbridgeRuleNamePrefix": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The prefix matching the rule name." }, + "CamelAwsEventbridgeEventPattern": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The event pattern." }, + "CamelAwsEventbridgeTargets": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "Collection<Target>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The targets to update or add to the rule." }, + "CamelAwsEventbridgeTargetsIds": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "Collection<String>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The IDs of the targets to remove from the rule." }, + "CamelAwsEventbridgeTargetArn": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The Amazon Resource Name (ARN) of the target resource." } + }, "properties": { "eventbusNameOrArn": { "kind": "path", "displayName": "Eventbus Name Or Arn", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Event bus name or ARN" }, "eventbridgeClient": { "kind": "parameter", "displayName": "Eventbridge Client", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "software.amazon.awssdk.services.eventbridge.EventBridgeClient", "deprecated": false, "deprecationNote": "", "autowired": true, "secret": false, "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": "To use a existing configured A [...] diff --git a/components/camel-aws/camel-aws2-eventbridge/src/main/docs/aws2-eventbridge-component.adoc b/components/camel-aws/camel-aws2-eventbridge/src/main/docs/aws2-eventbridge-component.adoc index 90ecc4e..1a9c664 100644 --- a/components/camel-aws/camel-aws2-eventbridge/src/main/docs/aws2-eventbridge-component.adoc +++ b/components/camel-aws/camel-aws2-eventbridge/src/main/docs/aws2-eventbridge-component.adoc @@ -51,7 +51,6 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: END - === Static credentials vs Default Credential Provider You have the possibility of avoiding the usage of explicit static credentials, by specifying the useDefaultCredentialsProvider option and set it to true. @@ -65,6 +64,10 @@ You have the possibility of avoiding the usage of explicit static credentials, b For more information about this you can look at https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html[AWS credentials documentation] +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END + === AWS2-Eventbridge Producer operations Camel-AWS2-Eventbridge component provides the following operation on the producer side: diff --git a/components/camel-aws/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeConstants.java b/components/camel-aws/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeConstants.java index deb3df4..028dca7 100644 --- a/components/camel-aws/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeConstants.java +++ b/components/camel-aws/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeConstants.java @@ -16,15 +16,24 @@ */ package org.apache.camel.component.aws2.eventbridge; +import org.apache.camel.spi.Metadata; + /** * Constants used in Camel AWS2 Eventbridge module */ public interface EventbridgeConstants { + @Metadata(description = "The operation we want to perform", javaType = "String") String OPERATION = "CamelAwsEventbridgeOperation"; + @Metadata(description = "The name of the rule.", javaType = "String") String RULE_NAME = "CamelAwsEventbridgeRuleName"; + @Metadata(description = "The prefix matching the rule name.", javaType = "String") String RULE_NAME_PREFIX = "CamelAwsEventbridgeRuleNamePrefix"; + @Metadata(description = "The event pattern.", javaType = "String") String EVENT_PATTERN = "CamelAwsEventbridgeEventPattern"; + @Metadata(description = "The targets to update or add to the rule.", javaType = "Collection<Target>") String TARGETS = "CamelAwsEventbridgeTargets"; + @Metadata(description = "The IDs of the targets to remove from the rule.", javaType = "Collection<String>") String TARGETS_IDS = "CamelAwsEventbridgeTargetsIds"; + @Metadata(description = "The Amazon Resource Name (ARN) of the target resource.", javaType = "String") String TARGET_ARN = "CamelAwsEventbridgeTargetArn"; } diff --git a/components/camel-aws/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeEndpoint.java b/components/camel-aws/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeEndpoint.java index 8339280..b8707ad 100644 --- a/components/camel-aws/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeEndpoint.java +++ b/components/camel-aws/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeEndpoint.java @@ -36,7 +36,8 @@ import software.amazon.awssdk.services.eventbridge.EventBridgeClient; @UriEndpoint(firstVersion = "3.6.0", scheme = "aws2-eventbridge", title = "AWS Eventbridge", syntax = "aws2-eventbridge://eventbusNameOrArn", producerOnly = true, category = { Category.CLOUD, - Category.MANAGEMENT }) + Category.MANAGEMENT }, + headersClass = EventbridgeConstants.class) public class EventbridgeEndpoint extends DefaultEndpoint { private EventBridgeClient eventbridgeClient;
