Add JavaDoc comments to flytekit-api module #186
Conversation
Signed-off-by: Pablo Casares Crespo <[email protected]>
pablocasares
force-pushed
the
java-doc-flytekit-api
branch
from
d41b561 to
c60fade
Compare
| @@ -39,14 +42,14 @@ public abstract class DynamicJobSpec { | |||
| public abstract List<Binding> outputs(); | |||
|
|
|||
| /** | |||
| * Returns sub-workflows templates. | |||
| * [Optional] A complete list of task specs referenced in nodes. | |||
There was a problem hiding this comment.
Can you check here, this doesnät looks like it belongs to subworkflows
There was a problem hiding this comment.
It looks like a copy paste error (in the proto) of the field bellow. Keep the comment that it was before
Signed-off-by: Pablo Casares Crespo <[email protected]>
Signed-off-by: Pablo Casares Crespo <[email protected]>
| @@ -24,17 +24,32 @@ | |||
| @AutoValue | |||
| public abstract class Container { | |||
|
|
|||
| /** | |||
| * Command to be executed, if not provided, the default entrypoint in the container image will be | |||
There was a problem hiding this comment.
nit: to avoid misinterpretations
| * Command to be executed, if not provided, the default entrypoint in the container image will be | |
| * Command to be executed. If not provided, the default entrypoint in the container image will be |
| public class ContainerError extends RuntimeException { | ||
|
|
||
| private static final long serialVersionUID = 5162780469952221158L; | ||
| /** A simplified code for errors, so that we can provide a glossary of all possible errors. */ |
There was a problem hiding this comment.
Are there known strings that we know the full list of them? If so, can we add a link to that list?
| @@ -28,13 +28,19 @@ public static Builder builder() { | |||
|
|
|||
| @AutoValue.Builder | |||
| public abstract static class Builder { | |||
|
|
|||
| /** | |||
| * Name of the domain the resource belongs to. A domain can be considered as a subset within a | |||
There was a problem hiding this comment.
| * Name of the domain the resource belongs to. A domain can be considered as a subset within a | |
| * Name of the domain the launch plan belongs to. A domain can be considered as a subset within a |
(same below)
| public abstract String project(); | ||
|
|
||
| /** | ||
| * User provided value for the resource. The combination of project + domain + name uniquely | ||
| * identifies the resource. [Optional] - in certain contexts - like 'List API', 'Launch plans' |
There was a problem hiding this comment.
| * identifies the resource. [Optional] - in certain contexts - like 'List API', 'Launch plans' | |
| * identifies the resource. [Optional] - used in certain contexts - like 'List API', 'Launch plans' |
| public abstract List<Binding> inputs(); | ||
|
|
||
| /** | ||
| * [Optional] Specifies execution dependency for this node ensuring it will only get scheduled to | ||
| * run after all its upstream nodes have completed. This node will have an implicit dependency on |
There was a problem hiding this comment.
This node will have an implicit dependency on any node that appears in inputs field. Maybe this should be a comment for inputs() instead?
| /** | ||
| * A predefined yet extensible Task type identifier. This can be used to customize any of the | ||
| * components. If no extensions are provided in the system, Flyte will resolve this task to its | ||
| * TaskCategory and default the implementation registered for the TaskCategory. |
There was a problem hiding this comment.
I don't fully understand this part: "If no extensions are provided in the system, Flyte will resolve this task to its
- TaskCategory and default the implementation registered for the TaskCategory."
| public abstract Struct custom(); | ||
|
|
||
| /** | ||
| * Indicates whether the system should attempt to lookup this task's output to avoid duplication |
There was a problem hiding this comment.
We can also make it possible and say to re-use existing data 🙂 (or add both)
| public abstract LiteralType literalType(); | ||
|
|
||
| /** [Optional] string describing input variable. */ |
There was a problem hiding this comment.
Is Variable always used to refer to an input?
Add JavaDoc comments to flytekit-api module following the protos in flyteidl-protos module
Type