Skip to content

Commit 5208931

Browse files
committed
Update docstring
1 parent 20b1d44 commit 5208931

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

contentctl/objects/correlation_search.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -923,6 +923,8 @@ def validate_ara_events(self) -> None:
923923
"""
924924
Validate the risk and notable events created by the saved search.
925925
An exception is raised if the validation fails for either risk or notable events.
926+
927+
:raises ValidationFailed: If the expected risk events are not found or validation fails.
926928
"""
927929
# Validate risk events
928930
if self.has_risk_analysis_action:
@@ -967,6 +969,11 @@ def dispatch_and_validate(self, elapsed_sleep_time: dict[str, int]) -> None:
967969
968970
Dispatches the saved search and validates the risk/notable events created by it. If any
969971
validation fails, raises a ValidationFailed exception.
972+
973+
:param elapsed_sleep_time: Dictionary tracking the total elapsed sleep time across retries.
974+
:type elapsed_sleep_time: dict[str, int]
975+
976+
:raises ValidationFailed: If validation of risk/notable events fails after all retries.
970977
"""
971978
self.dispatch()
972979

0 commit comments

Comments
 (0)