Skip to content

Commit 7b103c0

Browse files
author
zhilingc
committed
Add javadocs for RunnerConfig class
1 parent 0f8b97d commit 7b103c0

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

core/src/main/java/feast/core/job/option/RunnerConfig.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,23 @@
2222
import java.util.List;
2323
import java.util.Map;
2424

25+
/**
26+
* Value class containing the application-default configuration for a runner.
27+
* When a job is started by core, all fields in the object will be converted into
28+
* --key=value args to seed the beam pipeline options.
29+
*
30+
*/
2531
public abstract class RunnerConfig {
32+
33+
/**
34+
* Converts the fields in this class to a list of --key=value args to be
35+
* passed to a {@link org.apache.beam.sdk.options.PipelineOptionsFactory}.
36+
*
37+
* Ignores values that are proto-default (e.g. empty string, 0).
38+
*
39+
* @return Array of string args in the format --key=value.
40+
* @throws IllegalAccessException
41+
*/
2642
public String[] toArgs() throws IllegalAccessException {
2743
List<String> args = new ArrayList<>();
2844
for (Field field : this.getClass().getFields()) {

0 commit comments

Comments
 (0)