Modified parameters descriptions as per public doc

v1/src/main/java/com/google/cloud/teleport/templates/common/JavascriptTextTransformer.java

@@ -78,7 +78,8 @@ public interface JavascriptTextTransformerOptions extends PipelineOptions {
         optional = true,
         description = "JavaScript UDF path in Cloud Storage",
         helpText =
-            "The Cloud Storage URI of the .js file that defines the JavaScript user-defined function (UDF) you want to use. For example, `gs://my-bucket/my-udfs/my_file.js`.")
+            "The Cloud Storage URI of the .js file that defines the JavaScript user-defined function "
+                + "(UDF) to use. For example, `gs://my-bucket/my-udfs/my_file.js`.")
     ValueProvider<String> getJavascriptTextTransformGcsPath();
 
     void setJavascriptTextTransformGcsPath(ValueProvider<String> javascriptTextTransformGcsPath);
@@ -89,8 +90,10 @@ public interface JavascriptTextTransformerOptions extends PipelineOptions {
         regexes = {"[a-zA-Z0-9_]+"},
         description = "JavaScript UDF name",
         helpText =
-            "The name of the JavaScript user-defined function (UDF) to use. For example, if your JavaScript function code is `myTransform(inJson) { /*...do stuff...*/ }`, then the function name is `myTransform`. For sample JavaScript UDFs, see UDF Examples (https://github.com/GoogleCloudPlatform/DataflowTemplates#udf-examples).",
-        example = "transform_udf1")
+            "The name of the JavaScript user-defined function (UDF) to use. For example, if your "
+                + "JavaScript function code is `myTransform(inJson) { /*...do stuff...*/ }`, then the function name "
+                + "is `myTransform`. For sample JavaScript UDFs, see "
+                + "UDF Examples (https://github.com/GoogleCloudPlatform/DataflowTemplates#udf-examples).")
     ValueProvider<String> getJavascriptTextTransformFunctionName();
 
     void setJavascriptTextTransformFunctionName(

v2/bigtable-common/src/main/java/com/google/cloud/teleport/v2/bigtable/options/BigtableCommonOptions.java

@@ -165,8 +165,7 @@ interface ReadOptions extends BigtableCommonOptions {
         order = 3,
         optional = true,
         description = "Source Cloud Bigtable Project ID",
-        helpText =
-            "The Bigtable project ID. The default is the project of the Dataflow job.")
+        helpText = "The Bigtable project ID. The default is the project for the Dataflow job.")
     @Default.String("")
     String getBigtableReadProjectId();
 
@@ -192,8 +191,7 @@ interface ReadChangeStreamOptions extends BigtableCommonOptions.ReadOptions {
         order = 1,
         optional = true,
         description = "Cloud Bigtable change streams metadata instance ID",
-        helpText =
-            "The Bigtable change streams metadata instance ID.")
+        helpText = "The Bigtable change streams metadata instance ID.")
     @Default.String("")
     String getBigtableChangeStreamMetadataInstanceId();
 
@@ -214,7 +212,8 @@ interface ReadChangeStreamOptions extends BigtableCommonOptions.ReadOptions {
         order = 3,
         regexes = {"[a-z][a-z0-9\\-_]+[a-z0-9]"},
         description = "Cloud Bigtable application profile ID",
-        helpText = "The Bigtable application profile ID. The application profile must use single-cluster routing and allow single-row transactions.")
+        helpText =
+            "The Bigtable application profile ID. The application profile must use single-cluster routing and allow single-row transactions.")
     @Validation.Required
     String getBigtableChangeStreamAppProfile();
 
@@ -226,7 +225,7 @@ interface ReadChangeStreamOptions extends BigtableCommonOptions.ReadOptions {
         description =
             "Bigtable change streams charset name when reading values and column qualifiers",
         helpText =
-            "The Bigtable change streams charset name when reading rowkeys, values, and column qualifiers. This option is used when message encoding is JSON.")
+            "The Bigtable change streams charset name when reading values and column qualifiers.")
     @Default.String("UTF-8")
     String getBigtableChangeStreamCharset();
 
@@ -237,8 +236,9 @@ interface ReadChangeStreamOptions extends BigtableCommonOptions.ReadOptions {
         optional = true,
         description = "The timestamp to read change streams from",
         helpText =
-            "The starting timestamp (https://tools.ietf.org/html/rfc3339), inclusive, to use for reading change streams. "
-                + "For example, `2022-05-05T07:59:59Z`. Defaults to the timestamp of the pipeline start time.")
+            "The starting timestamp (https://tools.ietf.org/html/rfc3339), inclusive, to use "
+                + "for reading change streams. For example, `2022-05-05T07:59:59Z`. "
+                + "Defaults to the timestamp of the pipeline start time.")
     @Default.String("")
     String getBigtableChangeStreamStartTimestamp();
 
@@ -248,8 +248,7 @@ interface ReadChangeStreamOptions extends BigtableCommonOptions.ReadOptions {
         order = 6,
         optional = true,
         description = "Cloud Bigtable change streams column families to ignore",
-        helpText =
-            "A comma-separated list of column family name changes to ignore.")
+        helpText = "A comma-separated list of column family name changes to ignore.")
     @Default.String("")
     String getBigtableChangeStreamIgnoreColumnFamilies();
 
@@ -270,8 +269,9 @@ interface ReadChangeStreamOptions extends BigtableCommonOptions.ReadOptions {
         optional = true,
         description = "A unique name of the client pipeline",
         helpText =
-            "A unique name for the client pipeline. Lets you resume processing from the point at which a previously running pipeline stopped. Defaults "
-                + "to the automatically generated name. To find the value, see the Dataflow job logs. ")
+            "A unique name for the client pipeline. Lets you resume processing "
+                + "from the point at which a previously running pipeline stopped. "
+                + "Defaults to an automatically generated name. See the Dataflow job logs for the value used.")
     String getBigtableChangeStreamName();
 
     void setBigtableChangeStreamName(String value);
@@ -281,10 +281,12 @@ interface ReadChangeStreamOptions extends BigtableCommonOptions.ReadOptions {
         optional = true,
         description = "Resume streaming with the same change stream name",
         helpText =
-            "When set to true, a new pipeline resumes processing from the point when a previously running pipeline with the same "
-                + "`bigtableChangeStreamName` value stopped. If the pipeline with the given `bigtableChangeStreamName` value has never run, a new pipeline doesn't "
-                + "start. When set to `false`, a new pipeline starts. If a pipeline with the same `bigtableChangeStreamName` value has already run "
-                + "for the given source, a new pipeline doesn't start. Defaults to `false`.")
+            "When set to `true`, a new pipeline resumes processing from the point at which a previously "
+                + "running pipeline with the same `bigtableChangeStreamName` value stopped. If the "
+                + "pipeline with the given `bigtableChangeStreamName` value has never run, a new pipeline "
+                + "doesn't start. When set to `false`, a new pipeline starts. If a pipeline with the "
+                + "same `bigtableChangeStreamName` value has already run for the given source, "
+                + "a new pipeline doesn't start. Defaults to `false`.")
     @Default.Boolean(false)
     Boolean getBigtableChangeStreamResume();
 

v2/common/src/main/java/com/google/cloud/teleport/v2/options/BigQueryStorageApiStreamingOptions.java

@@ -26,8 +26,10 @@ public interface BigQueryStorageApiStreamingOptions extends BigQueryOptions {
       optional = true,
       description = "Use BigQuery Storage Write API",
       helpText =
-          "If true, the pipeline uses the Storage Write API (https://cloud.google.com/bigquery/docs/write-api). The default value is `false`." 
-              + " For more information, see Using the Storage Write API (https://beam.apache.org/documentation/io/built-in/google-bigquery/#storage-write-api).")
+          "If true, the pipeline uses the "
+              + "BigQuery Storage Write API (https://cloud.google.com/bigquery/docs/write-api). "
+              + "The default value is `false`. For more information, "
+              + "see Using the Storage Write API (https://beam.apache.org/documentation/io/built-in/google-bigquery/#storage-write-api).")
   @Default.Boolean(false)
   @Override
   Boolean getUseStorageWriteApi();
@@ -49,8 +51,9 @@ public interface BigQueryStorageApiStreamingOptions extends BigQueryOptions {
       optional = true,
       description = "Number of streams for BigQuery Storage Write API",
       helpText =
-          "When using the Storage Write API, specifies the number of write streams. If `useStorageWriteApi` is `true` and"
-              + " `useStorageWriteApiAtLeastOnce` is `false`, then you must set this parameter.")
+          "When using the Storage Write API, specifies the number of write streams. "
+              + "If `useStorageWriteApi` is `true` and `useStorageWriteApiAtLeastOnce` is `false`, "
+              + "then you must set this parameter.")
   @Override
   @Default.Integer(0)
   Integer getNumStorageWriteApiStreams();
@@ -60,8 +63,9 @@ public interface BigQueryStorageApiStreamingOptions extends BigQueryOptions {
       optional = true,
       description = "Triggering frequency in seconds for BigQuery Storage Write API",
       helpText =
-          "Optional: When using the Storage Write API, specifies the triggering frequency, in seconds. If"
-              + " `useStorageWriteApi` is `true` and `useStorageWriteApiAtLeastOnce` is `false`, then you must set this parameter.")
+          "When using the Storage Write API, specifies the triggering frequency, "
+              + "in seconds. If `useStorageWriteApi` is `true` and `useStorageWriteApiAtLeastOnce` is `false`, "
+              + "then you must set this parameter.")
   @Override
   Integer getStorageWriteApiTriggeringFrequencySec();
 }

v2/jdbc-to-googlecloud/src/main/java/com/google/cloud/teleport/v2/options/JdbcToBigQueryOptions.java

@@ -54,8 +54,11 @@ public interface JdbcToBigQueryOptions
       },
       groupName = "Source",
       description = "JDBC connection URL string.",
-      helpText = "The JDBC connection URL string. You can pass in this value as a string that's encrypted with a Cloud KMS key and then Base64-encoded. Remove whitespace characters from the Base64-encoded string.",
-      example = "jdbc:oracle:thin:@some-host:port:sid")
+      helpText =
+          "The JDBC connection URL string. You can pass in this "
+              + "value as a string that's encrypted with a Cloud KMS key and then Base64-encoded. "
+              + "Remove whitespace characters from the Base64-encoded string.",
+      example = "jdbc:mysql://some-host:3306/sampledb")
   String getConnectionURL();
 
   void setConnectionURL(String connectionURL);
@@ -66,7 +69,12 @@ public interface JdbcToBigQueryOptions
       regexes = {"^[a-zA-Z0-9_;!*&=@#-:\\/]+$"},
       groupName = "Source",
       description = "JDBC connection property string.",
-      helpText = "The properties string to use for the JDBC connection. The format of the string must be `[propertyName=property;]*`.",
+      helpText =
+          "Optional: The properties string to use for the JDBC connection. The format of the string must "
+              + "be `[propertyName=property;]*`."
+              + "For more information, see "
+              + "Configuration Properties (https://dev.mysql.com/doc/connector-j/8.1/en/connector-j-reference-configuration-properties.html) "
+              + "in the MySQL documentation.",
       example = "unicode=true;characterEncoding=UTF-8")
   String getConnectionProperties();
 
@@ -79,7 +87,8 @@ public interface JdbcToBigQueryOptions
       groupName = "Source",
       description = "JDBC connection username.",
       helpText =
-          "The username to use for the JDBC connection. You can pass in this value as a string that's encrypted with a Cloud KMS key and then Base64-encoded. Remove whitespace characters from the Base64-encoded string.")
+          "The username to use for the JDBC connection. You can pass in this value as a string that's encrypted with a Cloud KMS "
+              + "key and then Base64-encoded.")
   String getUsername();
 
   void setUsername(String username);
@@ -90,7 +99,8 @@ public interface JdbcToBigQueryOptions
       groupName = "Source",
       description = "JDBC connection password.",
       helpText =
-          "The password to use for the JDBC connection. You can pass in this value as a string that's encrypted with a Cloud KMS key and then Base64-encoded. Remove whitespace characters from the Base64-encoded string.")
+          "The password to use for the JDBC connection. You can pass in this value as a string that's encrypted with a Cloud KMS "
+              + "key and then Base64-encoded.")
   String getPassword();
 
   void setPassword(String password);
@@ -101,7 +111,9 @@ public interface JdbcToBigQueryOptions
       regexes = {"^.+$"},
       groupName = "Source",
       description = "JDBC source SQL query",
-      helpText = "Optional when using partitions. The query to run on the source to extract the data. Either query OR both table AND PartitionColumn must be specified.",
+      helpText =
+          "The query to run on the source to extract the data."
+              + "Required when not using partitions.",
       example = "select * from sampledb.sample_table")
   String getQuery();
 
@@ -113,7 +125,8 @@ public interface JdbcToBigQueryOptions
       order = 8,
       groupName = "Target",
       description = "BigQuery output table",
-      helpText = "The BigQuery output table location.",
+      helpText =
+          "The BigQuery output table location, in the format <PROJECT_ID>:<DATASET_NAME>.<TABLE_NAME>.",
       example = "<my-project>:<my-dataset>.<my-table>")
   String getOutputTable();
 
@@ -174,7 +187,8 @@ public interface JdbcToBigQueryOptions
       groupName = "Source",
       description = "The name of a column of numeric type that will be used for partitioning.",
       helpText =
-          "Required when using partitions. The name of a column to use for partitioning. Only numeric columns are supported.")
+          "The name of a column to use for partitioning. Only numeric columns are supported. "
+              + "Required when using partitions.")
   String getPartitionColumn();
 
   void setPartitionColumn(String partitionColumn);
@@ -185,8 +199,9 @@ public interface JdbcToBigQueryOptions
       groupName = "Source",
       description = "Name of the table in the external database.",
       helpText =
-          "Required when using partitions. The table to extract the data from. This parameter also accepts a subquery in parentheses.",
-      example = "(select id, name from Person) as subq")
+          "The table to extract the data from. This parameter also accepts a subquery in parentheses. "
+              + "Required when using partitions.",
+      example = "Person or (select id, name from Person) as subq")
   String getTable();
 
   void setTable(String table);
@@ -197,7 +212,7 @@ public interface JdbcToBigQueryOptions
       groupName = "Source",
       description = "The number of partitions.",
       helpText =
-          "The number of partitions to use. If not specified, a conservative number is assumed by the worker.")
+          "The number of partitions to use. If not specified, the worker uses a conservative number of partitions.")
   Integer getNumPartitions();
 
   void setNumPartitions(Integer numPartitions);