feat(docs): add full examples for pulsar tasks

kestra-io · Sep 1, 2024 · f3ad98e · f3ad98e
1 parent b6e8269
commit f3ad98e
Show file tree

Hide file tree

Showing 4 changed files with 81 additions and 52 deletions.
diff --git a/src/main/java/io/kestra/plugin/pulsar/Consume.java b/src/main/java/io/kestra/plugin/pulsar/Consume.java
@@ -30,12 +30,19 @@
 @Plugin(
     examples = {
         @Example(
-            code = {
-                "uri: pulsar://localhost:26650",
-                "topic: test_kestra",
-                "deserializer: JSON",
-                "subscriptionName: kestra_flow"
-            }
+            full = true,
+            code = """
+                id: pulsar_consume
+                namespace: company.name
+
+                tasks:
+                  - id: consume
+                    type: io.kestra.plugin.pulsar.Consume
+                    uri: pulsar://localhost:26650
+                    topic: test_kestra
+                    deserializer: JSON
+                    subscriptionName: kestra_flow
+                """
         )
     }
 )

diff --git a/src/main/java/io/kestra/plugin/pulsar/Produce.java b/src/main/java/io/kestra/plugin/pulsar/Produce.java
@@ -27,40 +27,43 @@
         @Example(
             title = "Read a CSV file, transform it to the right format, and publish it to Pulsar topic.",
             full = true,
-            code = {
-                "id: produce",
-                "namespace: company.team",
-                "inputs:",
-                "  - type: FILE",
-                "    id: file",
-                "",
-                "tasks:",
-                "  - id: csv_reader",
-                "    type: io.kestra.plugin.serdes.csv.CsvToIon",
-                "    from: \"{{ inputs.file }}\"",
-                "  - id: file_transform",
-                "    type: io.kestra.plugin.scripts.nashorn.FileTransform",
-                "    from: \"{{ outputs.csv_reader.uri }}\"",
-                "    script: |",
-                "      var result = {",
-                "        \"key\": row.id,",
-                "        \"value\": {",
-                "          \"username\": row.username,",
-                "          \"tweet\": row.tweet",
-                "        },",
-                "        \"eventTime\": row.timestamp,",
-                "        \"properties\": {",
-                "          \"key\": \"value\"",
-                "        }",
-                "      };",
-                "      row = result",
-                "  - id: produce",
-                "    type: io.kestra.plugin.pulsar.Produce",
-                "    from: \"{{ outputs.file_transform.uri }}\"",
-                "    uri: pulsar://localhost:26650",
-                "    serializer: JSON",
-                "    topic: test_kestra",
-            }
+            code = """
+                id: produce
+                namespace: company.team
+                
+                inputs:
+                  - type: FILE
+                    id: file
+                
+                tasks:
+                  - id: csv_reader
+                    type: io.kestra.plugin.serdes.csv.CsvToIon
+                    from: "{{ inputs.file }}"
+                
+                  - id: file_transform
+                    type: io.kestra.plugin.scripts.nashorn.FileTransform
+                    from: {{ outputs.csv_reader.uri }}"
+                    script: |
+                      var result = {
+                        "key": row.id,
+                        "value": {
+                          "username": row.username,
+                          "tweet": row.tweet
+                        },
+                        "eventTime": row.timestamp,
+                        "properties": {
+                          "key": "value"
+                        }
+                      };
+                      row = result
+                
+                  - id: produce
+                    type: io.kestra.plugin.pulsar.Produce
+                    from: "{{ outputs.file_transform.uri }}"
+                    uri: pulsar://localhost:26650
+                    serializer: JSON
+                    topic: test_kestra
+            """
         )
     }
 )

diff --git a/src/main/java/io/kestra/plugin/pulsar/Reader.java b/src/main/java/io/kestra/plugin/pulsar/Reader.java
@@ -31,11 +31,18 @@
 @Plugin(
     examples = {
         @Example(
-            code = {
-                "uri: pulsar://localhost:26650",
-                "topic: test_kestra",
-                "deserializer: JSON",
-            }
+            full = true,
+            code = """
+                id: pulsar_reader
+                namespace: company.name
+
+                tasks:
+                  - id: reader
+                    type: io.kestra.plugin.pulsar.Reader
+                    uri: pulsar://localhost:26650
+                    topic: test_kestra
+                    deserializer: JSON
+                """
         )
     }
 )

diff --git a/src/main/java/io/kestra/plugin/pulsar/Trigger.java b/src/main/java/io/kestra/plugin/pulsar/Trigger.java
@@ -30,13 +30,25 @@
 @Plugin(
     examples = {
         @Example(
-            code = {
-                "interval: PT30S",
-                "topic: kestra_trigger",
-                "uri: pulsar://localhost:26650",
-                "deserializer: JSON",
-                "subscriptionName: kestra_trigger_sub",
-            }
+            full = true,
+            code = """
+                id: pulsar_trigger
+                namespace: company.name
+
+                tasks:
+                  - id: log
+                    type: io.kestra.plugin.core.log.Log
+                    message: "{{ trigger.value }}"
+
+                triggers:
+                  - id: trigger
+                    type: io.kestra.plugin.pulsar.Trigger
+                    interval: PT30S
+                    topic: kestra_trigger
+                    uri: pulsar://localhost:26650
+                    deserializer: JSON
+                    subscriptionName: kestra_trigger_sub
+                """
         )
     }
 )