Add javadoc

apache · Jan 30, 2025 · e6225e5 · e6225e5
1 parent 062419f
commit e6225e5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/...rc/main/java/org/apache/pinot/segment/local/utils/SegmentStarTreePreprocessThrottler.java b/...rc/main/java/org/apache/pinot/segment/local/utils/SegmentStarTreePreprocessThrottler.java
@@ -30,6 +30,10 @@
 import org.slf4j.LoggerFactory;
 
 
+/**
+ * Used to throttle the total concurrent startree index rebuilds that can happen on a given Pinot server.
+ * Code paths that do no need to rebuild the index or which don't happen on the server need not utilize this throttler.
+ */
 public class SegmentStarTreePreprocessThrottler implements PinotClusterConfigChangeListener {
   private static final Logger LOGGER = LoggerFactory.getLogger(SegmentStarTreePreprocessThrottler.class);