chamikaramj commented on code in PR #29606:
URL: https://github.com/apache/beam/pull/29606#discussion_r1414714884
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/schemas/transforms/SchemaTransformProvider.java:
##########
@@ -36,6 +36,21 @@ 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
Review Comment:
"without getting into the specifics of each configuration field" might be
too specific ? I think we should just skip these details and emphasize on the
language-neutral part.
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/schemas/transforms/SchemaTransformProvider.java:
##########
@@ -36,6 +36,21 @@ 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
Review Comment:
I think it's better to mention what should be specified here instead of
mentioning the specific use-case since we might think of other use-cases in the
future. For example,
"Return a short description regarding the {@link SchemaTransform}
represented by the current {@code SchemaTransformProvider}".
##########
sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/providers/BigQueryStorageWriteApiSchemaTransformProvider.java:
##########
@@ -98,6 +98,15 @@ public String identifier() {
return
String.format("beam:schematransform:org.apache.beam:bigquery_storage_write:v2");
}
+ @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 "
Review Comment:
"... using the BigQuery Storage Write API" ("new" is relative :) ).
May be also link to https://cloud.google.com/bigquery/docs/write-api
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/schemas/transforms/SchemaTransformProvider.java:
##########
@@ -36,6 +36,21 @@ public interface SchemaTransformProvider {
/** Returns an id that uniquely represents this transform. */
String identifier();
+ // TODO(ahmedbu98): remove default when all existing
SchemaTransformProviders implement this
Review Comment:
Don't think we need to commit this TODO.
--
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]
