gemini-code-assist[bot] commented on PR #37759: URL: https://github.com/apache/beam/pull/37759#issuecomment-3995930505
## Summary of Changes Hello, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the Javadoc quality across the Apache Beam codebase by resolving all instances of the `MissingSummary` Error Prone warning. The changes ensure that all public API elements have clear and concise summary descriptions, improving code readability and maintainability for developers. The update impacts various modules, including Dataflow runners, I/O connectors, extensions, and core SDK components, standardizing documentation practices. ### Highlights * **Error Prone `MissingSummary` Fixes**: Addressed all outstanding `MissingSummary` warnings reported by Error Prone across the codebase. This ensures that every Javadoc comment has a proper summary fragment, typically the first sentence, describing the objective of the method or class. * **Javadoc Formatting Improvements**: Converted standalone `@return`, `@see`, and `@param` Javadoc blocks into complete descriptive sentences. This also included ensuring constructors, getters, and standard methods have a clear, standalone opening description before listing annotations. * **Error Prone Configuration Update**: Removed the `MissingSummary` check from the list of ignored Error Prone warnings in the `BeamModulePlugin.groovy` file, enabling its enforcement. 🧠**New Feature in Public Preview:** You can now enable **Memory** to help **Gemini Code Assist** learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. **Click [here](https://codeassist.google/code-review/login) to enable Memory in your admin console.** <details> <summary><b>Changelog</b></summary> * **buildSrc/src/main/groovy/org/apache/beam/gradle/BeamModulePlugin.groovy** * Removed 'MissingSummary' from the list of ignored Error Prone checks. * **it/google-cloud-platform/src/main/java/org/apache/beam/it/gcp/datastream/DatastreamResourceManager.java** * Refactored Javadoc for `buildSourceConfig` to include a summary sentence. * Refactored Javadoc for `createGCSDestinationConnectionProfile` to include a summary sentence. * Refactored Javadoc for `buildGCSDestinationConfig` to include a summary sentence. * Refactored Javadoc for `createBQDestinationConnectionProfile` to include a summary sentence. * Refactored Javadoc for `buildBQDestinationConfig` to include a summary sentence. * Refactored Javadoc for `createStream` to include a summary sentence. * **it/truthmatchers/src/main/java/org/apache/beam/it/truthmatchers/ListAccumulator.java** * Refactored Javadoc for `getBackingList` to include a summary sentence. * **runners/core-java/src/main/java/org/apache/beam/runners/core/DoFnRunner.java** * Refactored Javadoc for `getFn` to include a summary sentence. * **runners/core-java/src/main/java/org/apache/beam/runners/core/PushbackSideInputDoFnRunner.java** * Refactored Javadoc for `getFn` to include a summary sentence. * **runners/core-java/src/main/java/org/apache/beam/runners/core/metrics/BoundedTrieData.java** * Refactored Javadoc for `isEmpty` to include a summary sentence. * **runners/core-java/src/main/java/org/apache/beam/runners/core/metrics/MonitoringInfoMetricName.java** * Refactored Javadoc for `getUrn` to include a summary sentence. * **runners/core-java/src/main/java/org/apache/beam/runners/core/metrics/SimpleStateRegistry.java** * Refactored Javadoc for `getExecutionTimeMonitoringInfos` to include a summary sentence. * **runners/core-java/src/main/java/org/apache/beam/runners/core/triggers/AfterWatermarkStateMachine.java** * Refactored Javadoc for `AfterWatermarkEarlyAndLate` to use a descriptive sentence with `@see`. * **runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/PackageUtil.java** * Refactored Javadoc for `getSource` to include a summary sentence. * Refactored Javadoc for `getBytes` to include a summary sentence. * Refactored Javadoc for `getDestination` to include a summary sentence. * Refactored Javadoc for `getSize` to include a summary sentence. * Refactored Javadoc for `getHash` to include a summary sentence. * **runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/BatchModeExecutionContext.java** * Added a summary sentence to the Javadoc for `switchStateKey`. * **runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/MetricsToPerStepNamespaceMetricsConverter.java** * Refactored Javadoc for `convert` to include a summary sentence. * **runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/StreamingStepMetricsContainer.java** * Refactored Javadoc for `extractPerWorkerMetricUpdates` to include a summary sentence. * **runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/util/ThreadLocalByteStringOutputStream.java** * Refactored Javadoc for `acquire` to include a summary sentence. * **runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/util/common/worker/WorkProgressUpdater.java** * Added a summary sentence to the Javadoc for `setWorker`. * **runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/windmill/client/AbstractWindmillStream.java** * Added a summary sentence to the Javadoc for an abstract method. * **runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/windmill/state/WindmillTagEncodingV1.java** * Refactored Javadoc for `instance` to include a summary sentence. * **runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/windmill/state/WindmillTagEncodingV2.java** * Refactored Javadoc for `instance` to include a summary sentence. * **runners/java-fn-execution/src/main/java/org/apache/beam/runners/fnexecution/control/ProcessBundleDescriptors.java** * Added a summary sentence to the Javadoc for `ExecutableProcessBundleDescriptor`. * **runners/java-job-service/src/main/java/org/apache/beam/runners/jobsubmission/JobInvocation.java** * Refactored Javadoc for `getId` to include a summary sentence. * **runners/samza/src/main/java/org/apache/beam/runners/samza/runtime/ClassicBundleManager.java** * Refactored Javadoc to include a summary sentence before `@inheritDoc`. * **runners/samza/src/main/java/org/apache/beam/runners/samza/translation/ConfigBuilder.java** * Refactored Javadoc for `build` to include a summary sentence. * **runners/spark/src/main/java/org/apache/beam/runners/spark/translation/SparkInputDataProcessor.java** * Refactored Javadoc for `getOutputManager` to include a summary sentence. * **sdks/java/core/src/main/java/org/apache/beam/sdk/PipelineResult.java** * Refactored Javadoc for `isTerminal` to include a summary sentence. * Refactored Javadoc for `hasReplacementJob` to include a summary sentence. * **sdks/java/core/src/main/java/org/apache/beam/sdk/coders/CannotProvideCoderException.java** * Refactored Javadoc for `getReason` to include a summary sentence. * **sdks/java/core/src/main/java/org/apache/beam/sdk/io/CompressedSource.java** * Refactored Javadoc for `CompressionMode` enum values to use descriptive sentences with `@see`. * **sdks/java/core/src/main/java/org/apache/beam/sdk/io/FileBasedSink.java** * Refactored Javadoc for `CompressionType` enum values to use descriptive sentences with `@see`. * Refactored Javadoc for `getSuggestedFilenameSuffix` to include a summary sentence. * Refactored Javadoc for `create` to include a summary sentence. * **sdks/java/core/src/main/java/org/apache/beam/sdk/io/TFRecordIO.java** * Refactored Javadoc for `CompressionType` enum values to use descriptive sentences with `@see`. * Refactored Javadoc for `matches` to use a descriptive sentence with `@see`. * **sdks/java/core/src/main/java/org/apache/beam/sdk/io/TextIO.java** * Refactored Javadoc for `CompressionType` enum values to use descriptive sentences with `@see`. * Refactored Javadoc for `matches` to use a descriptive sentence with `@see`. * **sdks/java/core/src/main/java/org/apache/beam/sdk/io/TextSource.java** * Refactored Javadoc for `KMPDelimiterFinder` to use a descriptive sentence with `@see`. * **sdks/java/core/src/main/java/org/apache/beam/sdk/metrics/BoundedTrieResult.java** * Refactored Javadoc for `empty` to include a summary sentence. * **sdks/java/core/src/main/java/org/apache/beam/sdk/metrics/StringSetResult.java** * Refactored Javadoc for `empty` to include a summary sentence. * **sdks/java/core/src/main/java/org/apache/beam/sdk/runners/AppliedPTransform.java** * Refactored Javadoc for `getMainInputs` to include a summary sentence. * **sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/GroupIntoBatches.java** * Refactored Javadoc for `withSize` to use a descriptive sentence with `@see`. * Refactored Javadoc for `withByteSize` to use a descriptive sentence with `@see`. * Refactored Javadoc for `withByteSize` (overloaded) to use a descriptive sentence with `@see`. * **sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/Redistribute.java** * Refactored Javadoc for `arbitrarily` to include a summary sentence. * Refactored Javadoc for `byKey` to include a summary sentence. * Added a summary sentence to the Javadoc for `RedistributeByKey` class. * **sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/reflect/ByteBuddyDoFnInvokerFactory.java** * Refactored Javadoc for `newByteBuddyInvoker` to include a summary sentence (both overloads). * **sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/reflect/DoFnSignatures.java** * Refactored Javadoc for `signatureForDoFn` to include a summary sentence. * Refactored Javadoc for `getSignature` to include a summary sentence. * **sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/AfterWatermark.java** * Refactored Javadoc for `AfterWatermarkEarlyAndLate` to use a descriptive sentence with `@see`. * Refactored Javadoc for `mayFinish` to include a summary sentence. * **sdks/java/core/src/main/java/org/apache/beam/sdk/util/MutationDetector.java** * Refactored Javadoc for `verifyUnmodified` to include a summary sentence. * **sdks/java/core/src/main/java/org/apache/beam/sdk/util/construction/PTransformReplacements.java** * Added a summary sentence to the Javadoc for the `PTransformReplacements` class. * **sdks/java/core/src/main/java/org/apache/beam/sdk/values/WindowedValues.java** * Refactored Javadoc for `getWindow` to include a summary sentence. * **sdks/java/extensions/euphoria/src/main/java/org/apache/beam/sdk/extensions/euphoria/core/annotation/operator/Basic.java** * Refactored Javadoc for `state` to include a summary sentence. * Refactored Javadoc for `repartitions` to include a summary sentence. * **sdks/java/extensions/euphoria/src/main/java/org/apache/beam/sdk/extensions/euphoria/core/annotation/operator/Derived.java** * Refactored Javadoc for `state` to include a summary sentence. * Refactored Javadoc for `repartitions` to include a summary sentence. * **sdks/java/extensions/euphoria/src/main/java/org/apache/beam/sdk/extensions/euphoria/core/annotation/operator/Recommended.java** * Refactored Javadoc for `reason` to include a summary sentence. * Refactored Javadoc for `state` to include a summary sentence. * Refactored Javadoc for `repartitions` to include a summary sentence. * **sdks/java/extensions/euphoria/src/main/java/org/apache/beam/sdk/extensions/euphoria/core/client/lib/Split.java** * Refactored Javadoc for `positive` to include a summary sentence. * Refactored Javadoc for `negative` to include a summary sentence. * **sdks/java/extensions/euphoria/src/main/java/org/apache/beam/sdk/extensions/euphoria/core/client/operator/AssignEventTime.java** * Refactored Javadoc for `using` (both overloads) to use descriptive sentences with `@see`. * Refactored Javadoc for `getEventTimeExtractor` to include a summary sentence. * **sdks/java/extensions/euphoria/src/main/java/org/apache/beam/sdk/extensions/euphoria/core/client/operator/ReduceByKey.java** * Refactored Javadoc for `identity` to include a summary sentence. * Refactored Javadoc for `valueDesc` to include a summary sentence. * **sdks/java/extensions/google-cloud-platform-core/src/main/java/org/apache/beam/sdk/extensions/gcp/util/CustomHttpErrors.java** * Refactored Javadoc for `getCustomError` to include a summary sentence. * **sdks/java/extensions/google-cloud-platform-core/src/main/java/org/apache/beam/sdk/extensions/gcp/util/GceMetadataUtil.java** * Added a summary sentence to the Javadoc for the `GceMetadataUtil` class. * **sdks/java/extensions/google-cloud-platform-core/src/main/java/org/apache/beam/sdk/extensions/gcp/util/HttpCallCustomError.java** * Refactored Javadoc for `customError` to include a summary sentence. * **sdks/java/extensions/google-cloud-platform-core/src/main/java/org/apache/beam/sdk/extensions/gcp/util/HttpCallMatcher.java** * Refactored Javadoc for `matchResponse` to include a summary sentence. * **sdks/java/extensions/google-cloud-platform-core/src/main/java/org/apache/beam/sdk/extensions/gcp/util/RetryHttpRequestInitializer.java** * Added a summary sentence to the Javadoc for `setWriteTimeout`. * Added a summary sentence to the Javadoc for `setReadTimeout`. * **sdks/java/extensions/kafka-factories/src/main/java/org/apache/beam/sdk/extensions/kafka/factories/FileAwareFactoryFn.java** * Added a summary sentence to the Javadoc for `downloadAndProcessExtraFiles`. * **sdks/java/extensions/ml/src/main/java/org/apache/beam/sdk/extensions/ml/DLPDeidentifyText.java** * Refactored Javadoc for various getters and setters to include summary sentences. * **sdks/java/extensions/ml/src/main/java/org/apache/beam/sdk/extensions/ml/DLPInspectText.java** * Refactored Javadoc for various getters and setters to include summary sentences. * **sdks/java/extensions/ml/src/main/java/org/apache/beam/sdk/extensions/ml/DLPReidentifyText.java** * Refactored Javadoc for various getters and setters to include summary sentences. * **sdks/java/extensions/ml/src/main/java/org/apache/beam/sdk/extensions/ml/RecommendationAICreateCatalogItem.java** * Refactored Javadoc for `projectId` and `catalogName` getters and setters to include summary sentences. * **sdks/java/extensions/ml/src/main/java/org/apache/beam/sdk/extensions/ml/RecommendationAIImportCatalogItems.java** * Refactored Javadoc for various getters and setters to include summary sentences. * **sdks/java/extensions/ml/src/main/java/org/apache/beam/sdk/extensions/ml/RecommendationAIImportUserEvents.java** * Refactored Javadoc for various getters and setters to include summary sentences. * **sdks/java/extensions/ml/src/main/java/org/apache/beam/sdk/extensions/ml/RecommendationAIPredict.java** * Refactored Javadoc for various getters and setters to include summary sentences. * **sdks/java/extensions/ml/src/main/java/org/apache/beam/sdk/extensions/ml/RecommendationAIWriteUserEvent.java** * Refactored Javadoc for various getters and setters to include summary sentences. * **sdks/java/extensions/ordered/src/main/java/org/apache/beam/sdk/extensions/ordered/ContiguousSequenceRange.java** * Refactored Javadoc for `getStart`, `getEnd`, and `getTimestamp` to include summary sentences. * **sdks/java/extensions/ordered/src/main/java/org/apache/beam/sdk/extensions/ordered/OrderedEventProcessorResult.java** * Refactored Javadoc for `processingStatuses`, `output`, `unprocessedEvents`, and `latestContiguousRange` to include summary sentences. * **sdks/java/extensions/ordered/src/main/java/org/apache/beam/sdk/extensions/ordered/OrderedProcessingHandler.java** * Refactored Javadoc for `getEventExaminer` to include a summary sentence. * **sdks/java/extensions/ordered/src/main/java/org/apache/beam/sdk/extensions/ordered/OrderedProcessingStatus.java** * Refactored Javadoc for various getters to include summary sentences. * **sdks/java/extensions/ordered/src/main/java/org/apache/beam/sdk/extensions/ordered/ProcessorDoFn.java** * Refactored Javadoc for `checkForFirstOrLastEvent` to include a summary sentence. * **sdks/java/extensions/sketching/src/main/java/org/apache/beam/sdk/extensions/sketching/ApproximateDistinct.java** * Refactored Javadoc for `relativeErrorForPrecision` to include a summary sentence. * **sdks/java/harness/src/main/java/org/apache/beam/fn/harness/data/PTransformFunctionRegistry.java** * Refactored Javadoc for `getFunctions` to include a summary sentence. * **sdks/java/harness/src/main/java/org/apache/beam/fn/harness/logging/QuotaEvent.java** * Added summary sentences to the Javadoc for `withMessageText`, `withFullResourceName`, `withQuotaName`, and `withOperation`. * **sdks/java/io/amazon-web-services2/src/main/java/org/apache/beam/sdk/io/aws2/kinesis/KinesisRecord.java** * Refactored Javadoc for `getUniqueId`, `getSequenceNumber`, `getApproximateArrivalTimestamp`, and `getData` to include summary sentences. * **sdks/java/io/cassandra/src/main/java/org/apache/beam/sdk/io/cassandra/RingRange.java** * Refactored Javadoc for `isWrapping` to include a summary sentence. * **sdks/java/io/common/src/main/java/org/apache/beam/sdk/io/common/NetworkTestHelper.java** * Refactored Javadoc for `getAvailableLocalPort` to include a summary sentence. * **sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/BigQuerySinkMetrics.java** * Refactored Javadoc for `createRPCRequestCounter`, `appendRowsRowStatusCounter`, and `throttledTimeCounter` to include summary sentences. * **sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/BigQueryUtils.java** * Refactored Javadoc for `toTableReference`, `toTableSpec`, `readCallMetric`, and `writeCallMetric` to include summary sentences. * **sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/changestreams/dao/MetadataTableAdminDao.java** * Refactored Javadoc for `doesMetadataTableExist` to include a summary sentence. * **sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/changestreams/dao/MetadataTableDao.java** * Refactored Javadoc for `getChangeStreamNamePrefix`, `readNewPartitionsIncludingDeleted`, and `readNewPartitions` to include summary sentences. * **sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/firestore/FirestoreDoFn.java** * Refactored Javadoc for `setup`, `startBundle`, `FinishBundle` (both in `ImplicitlyWindowedFirestoreDoFn` and `ExplicitlyWindowedFirestoreDoFn`) to use descriptive sentences with `@see`. * **sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/firestore/RpcQos.java** * Refactored Javadoc for `getBufferedElementsCount`, `getBufferedElementsBytes`, `isFull`, and `getValue` to include summary sentences. * **sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/FhirIO.java** * Refactored Javadoc for `exportResources` to use a descriptive sentence with `@see`. * **sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/spanner/OrderedCode.java** * Refactored Javadoc for `writeSignedNumIncreasing` to use a descriptive sentence with `@see`. * **sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcUtil.java** * Refactored Javadoc for `getPartitionsHelper` to include a summary sentence. * **sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIOReadImplementationCompatibility.java** * Refactored Javadoc for `supports` and `supportsOnly` to include summary sentences. * **sdks/java/io/sparkreceiver/3/src/main/java/org/apache/beam/sdk/io/sparkreceiver/HasOffset.java** * Added a summary sentence to the Javadoc for `setStartOffset`. * Refactored Javadoc for `getEndOffset` to include a summary sentence. * **sdks/java/io/sparkreceiver/3/src/main/java/org/apache/beam/sdk/io/sparkreceiver/ReceiverBuilder.java** * Refactored Javadoc for `build` to include a summary sentence. * **sdks/java/io/xml/src/main/java/org/apache/beam/sdk/io/xml/XmlIO.java** * Refactored Javadoc for `CompressionType` enum values to use descriptive sentences with `@see`. * Refactored Javadoc for `matches` to use a descriptive sentence with `@see`. * **sdks/java/testing/nexmark/src/main/java/org/apache/beam/sdk/nexmark/NexmarkQueryName.java** * Refactored Javadoc for `fromId` to include a summary sentence. </details> <details> <summary><b>Using Gemini Code Assist</b></summary> <br> The full guide for Gemini Code Assist can be found on our [documentation page](https://developers.google.com/gemini-code-assist/docs/review-github-code), here are some quick tips. <b>Invoking Gemini</b> You can request assistance from Gemini at any point by creating a comment using either `/gemini <command>` or `@gemini-code-assist <command>`. Below is a summary of the supported commands on the current page. Feature | Command | Description --- | --- | --- Code Review | `/gemini review` | Performs a code review for the current pull request in its current state. Pull Request Summary | `/gemini summary` | Provides a summary of the current pull request in its current state. Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. Help | `/gemini help` | Displays a list of available commands. <b>Customization</b> To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a `.gemini/` folder in the base of the repository. Detailed instructions can be found [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github). <b>Limitations & Feedback</b> Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up [here](https://google.qualtrics.com/jfe/form/SV_2cyuGuTWsEw84yG). <b>You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the [Gemini Code Assist IDE Extension](https://cloud.google.com/products/gemini/code-assist).</b> </details> [^1]: Review the [Privacy Notices](https://policies.google.com/privacy), [Generative AI Prohibited Use Policy](https://policies.google.com/terms/generative-ai/use-policy), [Terms of Service](https://policies.google.com/terms), and learn how to configure Gemini Code Assist in GitHub [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github). Gemini can make mistakes, so double check it and [use code with caution](https://support.google.com/legal/answer/13505487). -- 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]
