[pulsar] branch master updated: [fix][Admin CLI docs] Sync the description and default value of `--processing-guarantees` (#15775)

[li...@apache.org]

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

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


The following commit(s) were added to refs/heads/master by this push:
     new 386cd4db9b8 [fix][Admin CLI docs] Sync the description and default value of `--processing-guarantees` (#15775)
386cd4db9b8 is described below

commit 386cd4db9b8f6ae49cfbe3760496ebd12cc7f40a
Author: momo-jun <60...@users.noreply.github.com>
AuthorDate: Fri Sep 2 17:43:02 2022 +0800

    [fix][Admin CLI docs] Sync the description and default value of `--processing-guarantees` (#15775)
---
 .../src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java     | 6 ++++--
 .../src/main/java/org/apache/pulsar/admin/cli/CmdSinks.java         | 5 ++++-
 .../src/main/java/org/apache/pulsar/admin/cli/CmdSources.java       | 6 +++++-
 3 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java
index 43d13bc97dd..e1872fbe9c6 100644
--- a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java
+++ b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java
@@ -290,8 +290,10 @@ public class CmdFunctions extends CmdBase {
                 + "applied to the function", hidden = true)
         protected FunctionConfig.ProcessingGuarantees deprecatedProcessingGuarantees;
         @Parameter(names = "--processing-guarantees",
-                description = "The processing guarantees (aka delivery semantics) applied to the function"
-                        + " #Java, Python, Go")
+                description = "The processing guarantees (as known as delivery semantics) applied to the function."
+                    + " Available values are: `ATLEAST_ONCE`, `ATMOST_ONCE`, `EFFECTIVELY_ONCE`."
+                    + " If it is not specified, the `ATLEAST_ONCE` delivery guarantee is used."
+                    + " #Java, Python, Go")
         protected FunctionConfig.ProcessingGuarantees processingGuarantees;
         // for backwards compatibility purposes
         @Parameter(names = "--userConfig", description = "User-defined config key/values", hidden = true)
diff --git a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdSinks.java b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdSinks.java
index 7aae6ece799..183071c5d4a 100644
--- a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdSinks.java
+++ b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdSinks.java
@@ -343,7 +343,10 @@ public class CmdSinks extends CmdBase {
                 description = "The processing guarantees (aka delivery semantics) applied to the sink", hidden = true)
         protected FunctionConfig.ProcessingGuarantees deprecatedProcessingGuarantees;
         @Parameter(names = "--processing-guarantees",
-                description = "The processing guarantees (aka delivery semantics) applied to the sink")
+                description = "The processing guarantees (as known as delivery semantics) applied to the sink."
+                    + " The '--processing-guarantees' implementation in Pulsar also relies on sink implementation."
+                    + " The available values are `ATLEAST_ONCE`, `ATMOST_ONCE`, `EFFECTIVELY_ONCE`."
+                    + " If it is not specified, `ATLEAST_ONCE` delivery guarantee is used.")
         protected FunctionConfig.ProcessingGuarantees processingGuarantees;
         @Parameter(names = "--retainOrdering", description = "Sink consumes and sinks messages in order", hidden = true)
         protected Boolean deprecatedRetainOrdering;
diff --git a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdSources.java b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdSources.java
index d97c09161b3..26c61587b95 100644
--- a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdSources.java
+++ b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdSources.java
@@ -297,7 +297,11 @@ public class CmdSources extends CmdBase {
                 description = "The processing guarantees (aka delivery semantics) applied to the Source", hidden = true)
         protected FunctionConfig.ProcessingGuarantees deprecatedProcessingGuarantees;
         @Parameter(names = "--processing-guarantees",
-                description = "The processing guarantees (aka delivery semantics) applied to the source")
+                description = "The processing guarantees (as known as delivery semantics) applied to the source."
+                    + " A source connector receives messages from external system and writes messages to a Pulsar"
+                    + " topic. The '--processing-guarantees' is used to ensure the processing guarantees for writing"
+                    + " messages to the Pulsar topic. The available values are `ATLEAST_ONCE`, `ATMOST_ONCE`,"
+                    + " `EFFECTIVELY_ONCE`. If it is not specified, `ATLEAST_ONCE` delivery guarantee is used.")
         protected FunctionConfig.ProcessingGuarantees processingGuarantees;
 
         @Parameter(names = { "-o", "--destinationTopicName" },