Skip to content

Commit 147fd72

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
[SEC-14142]evaluationWindow and keepAlive doc (#2093)
Co-authored-by: ci.datadog-api-spec <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent d6264e6 commit 147fd72

File tree

5 files changed

+10
-11
lines changed

5 files changed

+10
-11
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2024-08-08 20:00:58.505321",
8-
"spec_repo_commit": "643e3eaf"
7+
"regenerated": "2024-08-09 12:06:48.409820",
8+
"spec_repo_commit": "a21ba287"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-08-08 20:00:58.522985",
13-
"spec_repo_commit": "643e3eaf"
12+
"regenerated": "2024-08-09 12:06:48.426734",
13+
"spec_repo_commit": "a21ba287"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18054,8 +18054,7 @@ components:
1805418054
description: 'A time window is specified to match when at least one of the cases
1805518055
matches true. This is a sliding window
1805618056

18057-
and evaluates in real time. For third party rules, it should equal max signal
18058-
duration.'
18057+
and evaluates in real time. For third party rules, this field is not used.'
1805918058
enum:
1806018059
- 0
1806118060
- 60
@@ -18100,7 +18099,7 @@ components:
1810018099
SecurityMonitoringRuleKeepAlive:
1810118100
description: "Once a signal is generated, the signal will remain \u201Copen\u201D
1810218101
if a case is matched at least once within\nthis keep alive window. For third
18103-
party rules, it should equal max signal duration."
18102+
party rules, this field is not used."
1810418103
enum:
1810518104
- 0
1810618105
- 60

src/datadog_api_client/v2/model/security_monitoring_rule_evaluation_window.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
class SecurityMonitoringRuleEvaluationWindow(ModelSimple):
1616
"""
1717
A time window is specified to match when at least one of the cases matches true. This is a sliding window
18-
and evaluates in real time. For third party rules, it should equal max signal duration.
18+
and evaluates in real time. For third party rules, this field is not used.
1919
2020
:param value: Must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200].
2121
:type value: int

src/datadog_api_client/v2/model/security_monitoring_rule_keep_alive.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
class SecurityMonitoringRuleKeepAlive(ModelSimple):
1616
"""
1717
Once a signal is generated, the signal will remain “open” if a case is matched at least once within
18-
this keep alive window. For third party rules, it should equal max signal duration.
18+
this keep alive window. For third party rules, this field is not used.
1919
2020
:param value: Must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600].
2121
:type value: int

src/datadog_api_client/v2/model/security_monitoring_rule_options.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ def __init__(
126126
:type detection_method: SecurityMonitoringRuleDetectionMethod, optional
127127
128128
:param evaluation_window: A time window is specified to match when at least one of the cases matches true. This is a sliding window
129-
and evaluates in real time. For third party rules, it should equal max signal duration.
129+
and evaluates in real time. For third party rules, this field is not used.
130130
:type evaluation_window: SecurityMonitoringRuleEvaluationWindow, optional
131131
132132
:param hardcoded_evaluator_type: Hardcoded evaluator type.
@@ -136,7 +136,7 @@ def __init__(
136136
:type impossible_travel_options: SecurityMonitoringRuleImpossibleTravelOptions, optional
137137
138138
:param keep_alive: Once a signal is generated, the signal will remain “open” if a case is matched at least once within
139-
this keep alive window. For third party rules, it should equal max signal duration.
139+
this keep alive window. For third party rules, this field is not used.
140140
:type keep_alive: SecurityMonitoringRuleKeepAlive, optional
141141
142142
:param max_signal_duration: A signal will “close” regardless of the query being matched once the time exceeds the maximum duration.

0 commit comments

Comments
 (0)