[
https://issues.apache.org/jira/browse/FLINK-2017?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14708000#comment-14708000
]
Martin Liesenberg commented on FLINK-2017:
------------------------------------------
Hi,
I'd like to work on this ticket, but before I'll start, I though it's best to
check my understanding with the expectations, just to make sure we are on the
same page.
So the user can define a list of required parameters which are encapsulated in
a new class. Once the parameters are defined, they can be checked against a
list of provided parameters. Should check return a boolean or void and throw an
Exception if not all are provided?
I imagine the printHelp method to produce output similar to what is shown if
"grep --help" is called in the command line in linux. Does that sound sensible?
The checkAndPopulate method updates the parameter object and returns void,
right?
One last thing, I couldnt find the ParameterUtil class used after the
definition of the required parameters in the above test case. Is it mean to be
ParameterTool?
Looking forward to your comments.
Best regards, Martin
> Add predefined required parameters to ParameterTool
> ---------------------------------------------------
>
> Key: FLINK-2017
> URL: https://issues.apache.org/jira/browse/FLINK-2017
> Project: Flink
> Issue Type: Improvement
> Affects Versions: 0.9
> Reporter: Robert Metzger
> Labels: starter
>
> In FLINK-1525 we've added the {{ParameterTool}}.
> During the PR review, there was a request for required parameters.
> This issue is about implementing a facility to define required parameters.
> The tool should also be able to print a help menu with a list of all
> parameters.
> This test case shows my initial ideas how to design the API
> {code}
> @Test
> public void requiredParameters() {
> RequiredParameters required = new RequiredParameters();
> Option input = required.add("input").alt("i").help("Path to
> input file or directory"); // parameter with long and short variant
> required.add("output"); // parameter only with long variant
> Option parallelism =
> required.add("parallelism").alt("p").type(Integer.class); // parameter with
> type
> Option spOption =
> required.add("sourceParallelism").alt("sp").defaultValue(12).help("Number
> specifying the number of parallel data source instances"); // parameter with
> default value, specifying the type.
> Option executionType =
> required.add("executionType").alt("et").defaultValue("pipelined").choices("pipelined",
> "batch");
> ParameterUtil parameter = ParameterUtil.fromArgs(new
> String[]{"-i", "someinput", "--output", "someout", "-p", "15"});
> required.check(parameter);
> required.printHelp();
> required.checkAndPopulate(parameter);
> String inputString = input.get();
> int par = parallelism.getInteger();
> String output = parameter.get("output");
> int sourcePar = parameter.getInteger(spOption.getName());
> }
> {code}
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
