sijie commented on a change in pull request #2179: Issue 2081: Improve
documentation about `--inputs` and `--customSerdeInputs` for pulsar functions
URL: https://github.com/apache/incubator-pulsar/pull/2179#discussion_r203204228
##########
File path:
pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java
##########
@@ -222,15 +222,27 @@ void processArguments() throws Exception {
description = "Path to the main Python file for the function
(if the function is written in Python)",
listConverter = StringConverter.class)
protected String pyFile;
- @Parameter(names = "--inputs", description = "The function's input
topic or topics (multiple topics can be specified as a comma-separated list)")
+ @Parameter(
+ names = "--inputs",
+ description =
+ "The function's input topic or topics (multiple topics can be
specified as a comma-separated list)."
+ + " A default SerDe is used for serializing/deserializing
messages. If you want to use your own SerDe,"
+ + " specify the topic and the SerDe class in
[--customSerDeInputs]. The total list of input topics is"
+ + " a union of [--inputs] and
([--topicsPattern]/[--customSerDeInputs])."
+ + " A topic should only be specified in either [--inputs] or
[--customSerDeInputs].")
Review comment:
if you are specifying a topic, it can only be in one place, either --inputs
or --customSerDeInputs.
If you are specifying a topic pattern, it has to be in --topicsPattern; if
you are using a topic pattern and want to use a customized serde, the topic
pattern needs to be specified in --customerSerDeInputs.
any suggestions on improving this?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
