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 2020/09/25 09:49:16 UTC

[camel] 06/06: Camel-AWS2-Eventbridge: Regen docs

This is an automated email from the ASF dual-hosted git repository.

acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git

commit 07e6e8d421766785be105415770c8018730e84dc
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Fri Sep 25 11:48:00 2020 +0200

    Camel-AWS2-Eventbridge: Regen docs
---
 .../camel/catalog/docs/aws2-eventbridge-component.adoc | 18 ++++++++++++++++++
 .../EventbridgeDescribeRuleLocalstackTest.java         |  9 ++++-----
 .../modules/ROOT/pages/aws2-eventbridge-component.adoc | 18 ++++++++++++++++++
 3 files changed, 40 insertions(+), 5 deletions(-)

diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-eventbridge-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-eventbridge-component.adoc
index dab7287..ccbdb2f 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-eventbridge-component.adoc
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-eventbridge-component.adoc
@@ -129,6 +129,7 @@ Camel-AWS2-Eventbridge component provides the following operation on the produce
 - enableRule
 - disableRule
 - listRules
+- describeRule
 
 - PutRule: this operation create a rule related to an eventbus
 
@@ -257,6 +258,23 @@ This operation will disable the firstrule rule from the test eventbus.
 
 This operation will list all the rules with prefix first from the test eventbus.
 
+- DescribeRule: this operation will describe a specified rule related to an eventbus
+
+[source,java]
+--------------------------------------------------------------------------------
+  from("direct:start").process(new Processor() {
+                    
+      @Override
+      public void process(Exchange exchange) throws Exception {
+          exchange.getIn().setHeader(EventbridgeConstants.RULE_NAME, "firstrule");
+      }
+  })
+  .to("aws2-eventbridge://test?operation=describeRule")
+  .to("mock:result");
+--------------------------------------------------------------------------------
+
+This operation will describe the firstrule rule from the test eventbus.
+
 == Automatic detection of EventbridgeClient client in registry
 
 The component is capable of detecting the presence of an EventbridgeClient bean into the registry.
diff --git a/components/camel-aws2-eventbridge/src/test/java/org/apache/camel/component/aws2/eventbridge/localstack/EventbridgeDescribeRuleLocalstackTest.java b/components/camel-aws2-eventbridge/src/test/java/org/apache/camel/component/aws2/eventbridge/localstack/EventbridgeDescribeRuleLocalstackTest.java
index 63297fb..7e6c068 100644
--- a/components/camel-aws2-eventbridge/src/test/java/org/apache/camel/component/aws2/eventbridge/localstack/EventbridgeDescribeRuleLocalstackTest.java
+++ b/components/camel-aws2-eventbridge/src/test/java/org/apache/camel/component/aws2/eventbridge/localstack/EventbridgeDescribeRuleLocalstackTest.java
@@ -16,9 +16,6 @@
  */
 package org.apache.camel.component.aws2.eventbridge.localstack;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
-
 import java.util.ArrayList;
 import java.util.List;
 
@@ -30,10 +27,12 @@ import org.apache.camel.builder.RouteBuilder;
 import org.apache.camel.component.aws2.eventbridge.EventbridgeConstants;
 import org.apache.camel.component.mock.MockEndpoint;
 import org.junit.jupiter.api.Test;
-
 import software.amazon.awssdk.services.eventbridge.model.DescribeRuleResponse;
 import software.amazon.awssdk.services.eventbridge.model.Target;
 
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
 public class EventbridgeDescribeRuleLocalstackTest extends Aws2EventbridgeBaseTest {
 
     @EndpointInject
@@ -66,7 +65,7 @@ public class EventbridgeDescribeRuleLocalstackTest extends Aws2EventbridgeBaseTe
                 exchange.getIn().setHeader(EventbridgeConstants.TARGETS, targets);
             }
         });
-        
+
         template.send("direct:describe-rule", new Processor() {
 
             @Override
diff --git a/docs/components/modules/ROOT/pages/aws2-eventbridge-component.adoc b/docs/components/modules/ROOT/pages/aws2-eventbridge-component.adoc
index 9979dd4..c465236 100644
--- a/docs/components/modules/ROOT/pages/aws2-eventbridge-component.adoc
+++ b/docs/components/modules/ROOT/pages/aws2-eventbridge-component.adoc
@@ -131,6 +131,7 @@ Camel-AWS2-Eventbridge component provides the following operation on the produce
 - enableRule
 - disableRule
 - listRules
+- describeRule
 
 - PutRule: this operation create a rule related to an eventbus
 
@@ -259,6 +260,23 @@ This operation will disable the firstrule rule from the test eventbus.
 
 This operation will list all the rules with prefix first from the test eventbus.
 
+- DescribeRule: this operation will describe a specified rule related to an eventbus
+
+[source,java]
+--------------------------------------------------------------------------------
+  from("direct:start").process(new Processor() {
+                    
+      @Override
+      public void process(Exchange exchange) throws Exception {
+          exchange.getIn().setHeader(EventbridgeConstants.RULE_NAME, "firstrule");
+      }
+  })
+  .to("aws2-eventbridge://test?operation=describeRule")
+  .to("mock:result");
+--------------------------------------------------------------------------------
+
+This operation will describe the firstrule rule from the test eventbus.
+
 == Automatic detection of EventbridgeClient client in registry
 
 The component is capable of detecting the presence of an EventbridgeClient bean into the registry.