[GitHub] [beam] andreigurau commented on a diff in pull request #26384: Add field annotations for high-priority Syndeo schema transforms

["andreigurau (via GitHub)" <gi...@apache.org>]

andreigurau commented on code in PR #26384:
URL: https://github.com/apache/beam/pull/26384#discussion_r1179231773


##########
sdks/java/io/file-schema-transform/src/main/java/org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformConfiguration.java:
##########
@@ -51,43 +52,41 @@ public static XmlConfiguration.Builder xmlConfigurationBuilder() {
         .setCharset(StandardCharsets.UTF_8.name());
   }
 
-  /**
-   * The format of the file content. Used as String key lookup of {@link
-   * FileWriteSchemaTransformFormatProviders#loadProviders()}.
-   */
+  @SchemaFieldDescription(
+      "The format of the file content. Value must be one of: \"avro\", \"csv\", \"json\", \"parquet\", \"xml\"")
   public abstract String getFormat();
 
-  /** A common prefix to use for all generated filenames. */
+  @SchemaFieldDescription("A common prefix to use for all generated filenames.")
   public abstract String getFilenamePrefix();
 
-  /**
-   * The compression of all generated shard files. By default, appends the respective extension to
-   * the filename. See {@link org.apache.beam.sdk.io.Compression} for expected values.
-   */
+  /** See {@link org.apache.beam.sdk.io.Compression} for expected values. */
+  @SchemaFieldDescription(
+      "The compression of all generated shard files. By default, appends the respective extension to the filename.")

Review Comment:
   done



##########
sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/providers/BigQueryDirectReadSchemaTransformProvider.java:
##########
@@ -123,15 +124,22 @@ public static Builder builder() {
           .Builder();
     }
 
+    @SchemaFieldDescription("The SQL query to be executed to read from the BigQuery table.")
     @Nullable
     public abstract String getQuery();
 
+    @SchemaFieldDescription(
+        "The BigQuery table to read from. Format: [${PROJECT}:]${DATASET}.${TABLE}")

Review Comment:
   done



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org