From 79a88798cb0229973c27e95141ca4f89acf64808 Mon Sep 17 00:00:00 2001
From: Shounak kulkarni <shounakmk219@gmail.com>
Date: Thu, 16 Jan 2025 22:22:42 +0530
Subject: [PATCH] add java docs

---
 .../helix/core/minion/TaskSchedulingContext.java       | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/pinot-controller/src/main/java/org/apache/pinot/controller/helix/core/minion/TaskSchedulingContext.java b/pinot-controller/src/main/java/org/apache/pinot/controller/helix/core/minion/TaskSchedulingContext.java
index ebec6a1e64f7..da524a267ac9 100644
--- a/pinot-controller/src/main/java/org/apache/pinot/controller/helix/core/minion/TaskSchedulingContext.java
+++ b/pinot-controller/src/main/java/org/apache/pinot/controller/helix/core/minion/TaskSchedulingContext.java
@@ -6,6 +6,16 @@
 import java.util.Set;
 
 
+/**
+ * Wrapper class to manage all the inputs passed to schedule a task on minion
+ * _tableToTaskNamesMap is a map of table name and its consecutive task types for which task needs to be scheduled
+ * <p>
+ * Few special cases to note :
+ * <li>If the value for a table name entry is null or empty set then
+ *    it will end up scheduling all the configured tasks on that table.
+ * <li>If the _tableToTaskNamesMap is empty then it will end up scheduling
+ *    all the configured tasks for all the tables.
+ */
 public class TaskSchedulingContext {
   private Map<String, Set<String>> _tableToTaskNamesMap;
   private String _triggeredBy;