chamikaramj commented on code in PR #29606:
URL: https://github.com/apache/beam/pull/29606#discussion_r1419733774
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/schemas/transforms/SchemaTransformProvider.java:
##########
@@ -36,16 +36,10 @@ public interface SchemaTransformProvider {
/** Returns an id that uniquely represents this transform. */
String identifier();
- // TODO(ahmedbu98): remove default when all existing
SchemaTransformProviders implement this
- // method
/**
- * Returns a description which will be used to generate documentation for
remote SDKs. This is
- * reserved for how to build and use this SchemaTransform without getting
into the specifics of
- * each configuration field (that can go in the {@link
- * org.apache.beam.sdk.schemas.annotations.SchemaFieldDescription}
annotations). Potentially
- * include what the transform does, what the expected input/output
PCollections look like, and any
- * interesting use-cases. Please keep the language generic (i.e. not
specific to any programming
- * language). May be markdown formatted.
+ * Returns a description regarding the {@link SchemaTransform} represented
by this {@link
+ * SchemaTransformProvider}. Please keep the language generic (i.e. not
specific to any
Review Comment:
s/the/this
##########
sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/providers/BigQueryStorageWriteApiSchemaTransformProvider.java:
##########
@@ -101,9 +101,10 @@ public String identifier() {
@Override
public String description() {
return String.format(
- "Writes data to BigQuery using the new Storage Write API.\n\nThis
expects a single PCollection of Beam Rows "
- + "and outputs two dead-letter queues (DLQ) that contain failed
rows. The first DLQ has tag [%s] and contains "
- + "the failed rows. The second DLQ has tag [%s] and contains
failed rows and along with their respective errors.",
+ "Writes data to BigQuery using the Storage Write API
(https://cloud.google.com/bigquery/docs/write-api)."
+ + "\n\nThis expects a single PCollection of Beam Rows and outputs
two dead-letter queues (DLQ) that "
Review Comment:
{@PCollection} pf Beam {@code Row}s
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/schemas/transforms/SchemaTransformProvider.java:
##########
@@ -36,16 +36,10 @@ public interface SchemaTransformProvider {
/** Returns an id that uniquely represents this transform. */
String identifier();
- // TODO(ahmedbu98): remove default when all existing
SchemaTransformProviders implement this
- // method
/**
- * Returns a description which will be used to generate documentation for
remote SDKs. This is
- * reserved for how to build and use this SchemaTransform without getting
into the specifics of
- * each configuration field (that can go in the {@link
- * org.apache.beam.sdk.schemas.annotations.SchemaFieldDescription}
annotations). Potentially
- * include what the transform does, what the expected input/output
PCollections look like, and any
- * interesting use-cases. Please keep the language generic (i.e. not
specific to any programming
- * language). May be markdown formatted.
+ * Returns a description regarding the {@link SchemaTransform} represented
by this {@link
+ * SchemaTransformProvider}. Please keep the language generic (i.e. not
specific to any
+ * programming language). May be markdown formatted.
Review Comment:
"The returned text may be markdown formatted."
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
