File tree Expand file tree Collapse file tree 1 file changed +10
-0
lines changed
proto/frequenz/dispatch/v1 Expand file tree Collapse file tree 1 file changed +10
-0
lines changed Original file line number Diff line number Diff line change @@ -71,9 +71,19 @@ message Dispatch {
7171 DispatchComponentSelector selector = 8 ;
7272
7373 // The "active" status
74+ // An active dispatch is eligible for processing, either immediately or at a scheduled
75+ // time in the future, including recurring dispatches. If a dispatch is set to
76+ // inactive, it won't be processed even if it matches all other conditions, allowing
77+ // for temporary disabling of dispatches without deletion.
7478 bool is_active = 9 ;
7579
7680 // The "dry run" status
81+ // A dry run dispatch is executed for logging and monitoring purposes
82+ // without affecting the microgrid components. This is useful, for example,
83+ // in scenarios where a user may want to test dispatch behavior without
84+ // actually affecting any component states.
85+ // Notably, a dispatch can be both "dry run" and "active," allowing for
86+ // the system to generate logs and observe behavior without making actual changes.
7787 bool is_dry_run = 10 ;
7888
7989 // The dispatch payload
You can’t perform that action at this time.
0 commit comments