Skip to content

Commit 9dddaa5

Browse files
committed
improve comment
Signed-off-by: Kaituo Li <[email protected]>
1 parent d77fae9 commit 9dddaa5

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

src/main/java/org/opensearch/timeseries/util/ParseUtils.java

+9-2
Original file line numberDiff line numberDiff line change
@@ -531,8 +531,15 @@ public static <ConfigType extends Config> void getConfig(
531531
}
532532

533533
/**
534-
* This method processes the GetResponse and applies the consumer function if the user has permissions
535-
* or if the filterByBackendRole is disabled. It uses a ConfigFactory to parse the correct type of Config.
534+
* Processes a GetResponse by leveraging the factory method Config.parseConfig to
535+
* appropriately parse the specified type of Config. The execution of the provided
536+
* consumer function depends on the state of the 'filterByBackendRole' setting:
537+
*
538+
* - If 'filterByBackendRole' is disabled, the consumer function will be invoked
539+
* irrespective of the user's permissions.
540+
*
541+
* - If 'filterByBackendRole' is enabled, the consumer function will only be invoked
542+
* provided the user holds the requisite permissions.
536543
*
537544
* @param <ConfigType> The type of Config to be processed in this method, which extends from the Config base type.
538545
* @param response The GetResponse from the getConfig request. This contains the information about the config that is to be processed.

0 commit comments

Comments
 (0)