docs: update template option descriptions (#1803)

* docs: update template option descriptions ... so that it's also reflected on the README * fix: connection URI option wording Co-authored-by: Rebecca Szper <[email protected]> * fix: connection secret ID option wording Co-authored-by: Rebecca Szper <[email protected]> * fix: connection secret ID option wording Co-authored-by: Rebecca Szper <[email protected]> * fix: optionsJson wording Co-authored-by: Rebecca Szper <[email protected]> * fix: optionsJson wording Co-authored-by: Rebecca Szper <[email protected]> * fix: readQuery wording Co-authored-by: Rebecca Szper <[email protected]> * fix: inputFilePattern wording Co-authored-by: Rebecca Szper <[email protected]> * fix: inputFilePattern wording Co-authored-by: Rebecca Szper <[email protected]> * fix: reformat --------- Co-authored-by: Rebecca Szper <[email protected]>
GoogleCloudPlatform · Nov 15, 2024 · ff49726 · ff49726
1 parent 59ec2e6
commit ff49726
Showing 1 changed file with 15 additions and 12 deletions.
diff --git a/...4j/src/main/java/com/google/cloud/teleport/v2/neo4j/options/Neo4jFlexTemplateOptions.java b/...4j/src/main/java/com/google/cloud/teleport/v2/neo4j/options/Neo4jFlexTemplateOptions.java
@@ -30,7 +30,7 @@ public interface Neo4jFlexTemplateOptions extends CommonTemplateOptions {
       order = 1,
       description = "Path to the job specification file",
       helpText =
-          "The path to the job specification file, which contains the configuration for source and target metadata.")
+          "The path to the job specification file, which contains the JSON description of data sources, Neo4j targets and actions.")
   @Validation.Required
   String getJobSpecUri();
 
@@ -39,8 +39,9 @@ public interface Neo4jFlexTemplateOptions extends CommonTemplateOptions {
   @TemplateParameter.GcsReadFile(
       order = 2,
       optional = true,
-      description = "Path to the Neo4j connection metadata",
-      helpText = "The path to the Neo4j connection metadata JSON file.")
+      description =
+          "The path to the Neo4j connection JSON file, which is hosted on Google Cloud Storage.",
+      helpText = "The path to the Neo4j connection JSON file.")
   @Validation.Required(groups = "connection")
   String getNeo4jConnectionUri();
 
@@ -49,9 +50,10 @@ public interface Neo4jFlexTemplateOptions extends CommonTemplateOptions {
   @TemplateParameter.Text(
       order = 3,
       optional = true,
-      description = "Secret ID for the Neo4j connection metadata",
+      description =
+          "The secret ID for the Neo4j connection information. This value is encoded in JSON, using the same schema as the `neo4jConnectionUri`.",
       helpText =
-          "The secret ID for the Neo4j connection metadata. This is an alternative to the GCS path option.")
+          "The secret ID for the Neo4j connection metadata. You can use this value as an alternative to the `neo4jConnectionUri`.")
   @Validation.Required(groups = "connection")
   String getNeo4jConnectionSecretId();
 
@@ -60,9 +62,10 @@ public interface Neo4jFlexTemplateOptions extends CommonTemplateOptions {
   @TemplateParameter.Text(
       order = 4,
       optional = true,
-      description = "Options JSON",
-      helpText = "Options JSON. Use runtime tokens.",
-      example = "{token1:value1,token2:value2}")
+      description =
+          "A JSON object that defines named values interpolated into the specification URIs and queries. Also known as runtime tokens.",
+      helpText = "A JSON object that is also called runtime tokens",
+      example = "{token1:value1,token2:value2}. Spec can refer to $token1 and $token2.")
   @Default.String("")
   String getOptionsJson();
 
@@ -71,8 +74,8 @@ public interface Neo4jFlexTemplateOptions extends CommonTemplateOptions {
   @TemplateParameter.Text(
       order = 5,
       optional = true,
-      description = "Query SQL",
-      helpText = "Override SQL query.")
+      description = "The SQL query override for all BigQuery sources.",
+      helpText = "SQL query override.")
   @Default.String("")
   String getReadQuery();
 
@@ -81,8 +84,8 @@ public interface Neo4jFlexTemplateOptions extends CommonTemplateOptions {
   @TemplateParameter.GcsReadFile(
       order = 6,
       optional = true,
-      description = "Path to Text File",
-      helpText = "Override text file pattern",
+      description = "The text file path override for all text sources.",
+      helpText = "The text file path override",
       example = "gs://your-bucket/path/*.json")
   @Default.String("")
   String getInputFilePattern();