gemini-code-assist[bot] commented on code in PR #37933:
URL: https://github.com/apache/beam/pull/37933#discussion_r3118191177
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java:
##########
@@ -700,6 +704,12 @@ public interface MultiOutputReceiver {
* <li>If one of its arguments is tagged with the {@link Element}
annotation, then it will be
* passed the current element being processed. The argument type must
match the input type
* of this DoFn exactly, or both types must have equivalent schemas
registered.
+ * <li>If one of its arguments is tagged with the {@link RecordId}
annotation, then it will be
Review Comment:
The Javadoc refers to `RecordId`, but the annotation defined in this PR is
named `CurrentRecordId`. This mismatch will cause broken Javadoc links and
confusion for users attempting to use the new parameter.
```suggestion
* <li>If one of its arguments is tagged with the {@link
CurrentRecordId} annotation, then it will be
```
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java:
##########
@@ -608,8 +610,10 @@ public interface MultiOutputReceiver {
*
* <p>The method annotated with {@code @OnTimerFamily} may have parameters
according to the same
* logic as {@link ProcessElement}, but limited to the {@link
BoundedWindow}, {@link State}
- * subclasses, and {@link org.apache.beam.sdk.state.TimerMap}. State and
timer parameters must be
- * annotated with their {@link StateId} and {@link TimerId} respectively.
+ * subclasses, {@link org.apache.beam.sdk.state.TimerMap}, {@link
Timestamp}, {@link Key}, {@link
Review Comment:
The Javadoc for `@OnTimerFamily` is missing `{@link FireTimestamp}` in the
list of supported parameters. Since it is included in the reflection logic for
allowed parameters in `DoFnSignatures`, it should be documented here for
consistency with the `@OnTimer` documentation.
```suggestion
* subclasses, {@link org.apache.beam.sdk.state.TimerMap}, {@link
FireTimestamp}, {@link Timestamp}, {@link Key}, {@link
```
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java:
##########
@@ -700,6 +704,12 @@ public interface MultiOutputReceiver {
* <li>If one of its arguments is tagged with the {@link Element}
annotation, then it will be
* passed the current element being processed. The argument type must
match the input type
* of this DoFn exactly, or both types must have equivalent schemas
registered.
+ * <li>If one of its arguments is tagged with the {@link RecordId}
annotation, then it will be
+ * passed the record id of the current element being processed; the
argument must be of type
+ * {@link String}.
+ * <li>If one of its arguments is tagged with the {@link RecordOffset}
annotation, then it will
Review Comment:
The Javadoc refers to `RecordOffset`, but the annotation defined in this PR
is named `CurrentRecordOffset`. Please update the Javadoc to match the actual
annotation name.
```suggestion
* <li>If one of its arguments is tagged with the {@link
CurrentRecordOffset} annotation, then it will
```
--
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]
