Skip to content

Security Monitoring - expand learningDuration and forgetAfter to support up to 30 days #3421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Security Monitoring - expand learningDuration and forgetAfter to support up to 30 days #3421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 4 additions & 22 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62071,35 +62071,17 @@ components:
type: object
SecurityMonitoringRuleNewValueOptionsForgetAfter:
description: The duration in days after which a learned value is forgotten.
enum:
- 1
- 2
- 7
- 14
- 21
- 28
format: int32
maximum: 30
minimum: 1
type: integer
x-enum-varnames:
- ONE_DAY
- TWO_DAYS
- ONE_WEEK
- TWO_WEEKS
- THREE_WEEKS
- FOUR_WEEKS
SecurityMonitoringRuleNewValueOptionsLearningDuration:
default: 0
description: "The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned."
enum:
- 0
- 1
- 7
format: int32
maximum: 30
minimum: 0
type: integer
x-enum-varnames:
- ZERO_DAYS
- ONE_DAY
- SEVEN_DAYS
SecurityMonitoringRuleNewValueOptionsLearningMethod:
default: duration
description: The learning method used to determine when signals should be generated for values that weren't learned.
Expand Down
14 changes: 0 additions & 14 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27864,20 +27864,6 @@ datadog\_api\_client.v2.model.security\_monitoring\_rule\_new\_value\_options mo
:members:
:show-inheritance:

datadog\_api\_client.v2.model.security\_monitoring\_rule\_new\_value\_options\_forget\_after module
---------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.security_monitoring_rule_new_value_options_forget_after
:members:
:show-inheritance:

datadog\_api\_client.v2.model.security\_monitoring\_rule\_new\_value\_options\_learning\_duration module
--------------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.security_monitoring_rule_new_value_options_learning_duration
:members:
:show-inheritance:

datadog\_api\_client.v2.model.security\_monitoring\_rule\_new\_value\_options\_learning\_method module
------------------------------------------------------------------------------------------------------

Expand Down
10 changes: 2 additions & 8 deletions examples/v2/security-monitoring/ValidateSecurityMonitoringRule_2609327779.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,6 @@
SecurityMonitoringRuleMaxSignalDuration,
)
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options import SecurityMonitoringRuleNewValueOptions
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options_forget_after import (
SecurityMonitoringRuleNewValueOptionsForgetAfter,
)
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options_learning_duration import (
SecurityMonitoringRuleNewValueOptionsLearningDuration,
)
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options_learning_method import (
SecurityMonitoringRuleNewValueOptionsLearningMethod,
)
Expand Down Expand Up @@ -55,9 +49,9 @@
max_signal_duration=SecurityMonitoringRuleMaxSignalDuration.TEN_MINUTES,
detection_method=SecurityMonitoringRuleDetectionMethod.NEW_VALUE,
new_value_options=SecurityMonitoringRuleNewValueOptions(
forget_after=SecurityMonitoringRuleNewValueOptionsForgetAfter.ONE_WEEK,
forget_after=7,
instantaneous_baseline=True,
learning_duration=SecurityMonitoringRuleNewValueOptionsLearningDuration.ONE_DAY,
learning_duration=1,
learning_threshold=SecurityMonitoringRuleNewValueOptionsLearningThreshold.ZERO_OCCURRENCES,
learning_method=SecurityMonitoringRuleNewValueOptionsLearningMethod.DURATION,
),
Expand Down
35 changes: 17 additions & 18 deletions src/datadog_api_client/v2/model/security_monitoring_rule_new_value_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,6 @@


if TYPE_CHECKING:
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options_forget_after import (
SecurityMonitoringRuleNewValueOptionsForgetAfter,
)
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options_learning_duration import (
SecurityMonitoringRuleNewValueOptionsLearningDuration,
)
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options_learning_method import (
SecurityMonitoringRuleNewValueOptionsLearningMethod,
)
Expand All @@ -29,14 +23,19 @@


class SecurityMonitoringRuleNewValueOptions(ModelNormal):
validations = {
"forget_after": {
"inclusive_maximum": 30,
"inclusive_minimum": 1,
},
"learning_duration": {
"inclusive_maximum": 30,
"inclusive_minimum": 0,
},
}

@cached_property
def openapi_types(_):
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options_forget_after import (
SecurityMonitoringRuleNewValueOptionsForgetAfter,
)
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options_learning_duration import (
SecurityMonitoringRuleNewValueOptionsLearningDuration,
)
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options_learning_method import (
SecurityMonitoringRuleNewValueOptionsLearningMethod,
)
Expand All @@ -45,9 +44,9 @@ def openapi_types(_):
)

return {
"forget_after": (SecurityMonitoringRuleNewValueOptionsForgetAfter,),
"forget_after": (int,),
"instantaneous_baseline": (bool,),
"learning_duration": (SecurityMonitoringRuleNewValueOptionsLearningDuration,),
"learning_duration": (int,),
"learning_method": (SecurityMonitoringRuleNewValueOptionsLearningMethod,),
"learning_threshold": (SecurityMonitoringRuleNewValueOptionsLearningThreshold,),
}
Expand All @@ -62,9 +61,9 @@ def openapi_types(_):

def __init__(
self_,
forget_after: Union[SecurityMonitoringRuleNewValueOptionsForgetAfter, UnsetType] = unset,
forget_after: Union[int, UnsetType] = unset,
instantaneous_baseline: Union[bool, UnsetType] = unset,
learning_duration: Union[SecurityMonitoringRuleNewValueOptionsLearningDuration, UnsetType] = unset,
learning_duration: Union[int, UnsetType] = unset,
learning_method: Union[SecurityMonitoringRuleNewValueOptionsLearningMethod, UnsetType] = unset,
learning_threshold: Union[SecurityMonitoringRuleNewValueOptionsLearningThreshold, UnsetType] = unset,
**kwargs,
Expand All @@ -73,14 +72,14 @@ def __init__(
Options on new value detection method.

:param forget_after: The duration in days after which a learned value is forgotten.
:type forget_after: SecurityMonitoringRuleNewValueOptionsForgetAfter, optional
:type forget_after: int, optional

:param instantaneous_baseline: When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.
:type instantaneous_baseline: bool, optional

:param learning_duration: The duration in days during which values are learned, and after which signals will be generated for values that
weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned.
:type learning_duration: SecurityMonitoringRuleNewValueOptionsLearningDuration, optional
:type learning_duration: int, optional

:param learning_method: The learning method used to determine when signals should be generated for values that weren't learned.
:type learning_method: SecurityMonitoringRuleNewValueOptionsLearningMethod, optional
Expand Down
50 changes: 0 additions & 50 deletions src/datadog_api_client/v2/model/security_monitoring_rule_new_value_options_forget_after.py
View file
Open in desktop

This file was deleted.

46 changes: 0 additions & 46 deletions ...tadog_api_client/v2/model/security_monitoring_rule_new_value_options_learning_duration.py
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions src/datadog_api_client/v2/models/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5637,12 +5637,6 @@
SecurityMonitoringRuleMaxSignalDuration,
)
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options import SecurityMonitoringRuleNewValueOptions
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options_forget_after import (
SecurityMonitoringRuleNewValueOptionsForgetAfter,
)
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options_learning_duration import (
SecurityMonitoringRuleNewValueOptionsLearningDuration,
)
from datadog_api_client.v2.model.security_monitoring_rule_new_value_options_learning_method import (
SecurityMonitoringRuleNewValueOptionsLearningMethod,
)
Expand Down Expand Up @@ -11165,8 +11159,6 @@
"SecurityMonitoringRuleKeepAlive",
"SecurityMonitoringRuleMaxSignalDuration",
"SecurityMonitoringRuleNewValueOptions",
"SecurityMonitoringRuleNewValueOptionsForgetAfter",
"SecurityMonitoringRuleNewValueOptionsLearningDuration",
"SecurityMonitoringRuleNewValueOptionsLearningMethod",
"SecurityMonitoringRuleNewValueOptionsLearningThreshold",
"SecurityMonitoringRuleOptions",
Expand Down
Loading