Skip to content
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.

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

Add Default Rule ID in SignalRuleResponseQuery #1196

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.4",
"regenerated": "2022-10-06 09:26:36.587132",
"spec_repo_commit": "c520a0fb"
"regenerated": "2022-10-07 13:12:58.196696",
"spec_repo_commit": "a09fec54"
},
"v2": {
"apigentools_version": "1.6.4",
"regenerated": "2022-10-06 09:26:36.625426",
"spec_repo_commit": "c520a0fb"
"regenerated": "2022-10-07 13:12:58.212913",
"spec_repo_commit": "a09fec54"
}
}
}
41 changes: 38 additions & 3 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7850,7 +7850,7 @@ components:
- message
type: object
SecurityMonitoringSignalRuleQuery:
description: Query for matching rule on signals
description: Query for matching rule on signals.
properties:
aggregation:
$ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
Expand All @@ -7877,7 +7877,7 @@ components:
type: string
ruleId:
description: Rule ID to match on signals.
example: d3f-ru1-e1d
example: org-ru1-e1d
type: string
required:
- ruleId
Expand Down Expand Up @@ -7931,7 +7931,7 @@ components:
queries:
description: Queries for selecting logs which are part of the rule.
items:
$ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery'
$ref: '#/components/schemas/SecurityMonitoringSignalRuleResponseQuery'
type: array
tags:
description: Tags for generated signals.
Expand All @@ -7949,6 +7949,41 @@ components:
description: The version of the rule.
format: int64
type: integer
SecurityMonitoringSignalRuleResponseQuery:
description: Query for matching rule on signals.
properties:
aggregation:
$ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
correlatedByFields:
description: Fields to group by.
items:
description: Field.
type: string
type: array
correlatedQueryIndex:
description: Index of the rule query used to retrieve the correlated field.
format: int32
maximum: 9
type: integer
defaultRuleId:
description: Default Rule ID to match on signals.
example: d3f-ru1-e1d
type: string
metrics:
description: Group of target fields to aggregate over when using the new
value aggregations.
items:
description: Field.
type: string
type: array
name:
description: Name of the query.
type: string
ruleId:
description: Rule ID to match on signals.
example: org-ru1-e1d
type: string
type: object
SecurityMonitoringSignalRuleType:
description: The rule type.
enum:
Expand Down
7 changes: 7 additions & 0 deletions docs/datadog_api_client.v2.model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3557,6 +3557,13 @@ security\_monitoring\_signal\_rule\_response
:members:
:show-inheritance:

security\_monitoring\_signal\_rule\_response\_query
---------------------------------------------------

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

security\_monitoring\_signal\_rule\_type
----------------------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def openapi_types(_):

def __init__(self_, rule_id, *args, **kwargs):
"""
Query for matching rule on signals
Query for matching rule on signals.

:param aggregation: The aggregation type.
:type aggregation: SecurityMonitoringRuleQueryAggregation, optional
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ def openapi_types(_):
from datadog_api_client.v2.model.security_monitoring_rule_case import SecurityMonitoringRuleCase
from datadog_api_client.v2.model.security_monitoring_filter import SecurityMonitoringFilter
from datadog_api_client.v2.model.security_monitoring_rule_options import SecurityMonitoringRuleOptions
from datadog_api_client.v2.model.security_monitoring_signal_rule_query import SecurityMonitoringSignalRuleQuery
from datadog_api_client.v2.model.security_monitoring_signal_rule_response_query import (
SecurityMonitoringSignalRuleResponseQuery,
)
from datadog_api_client.v2.model.security_monitoring_signal_rule_type import SecurityMonitoringSignalRuleType

return {
Expand All @@ -31,7 +33,7 @@ def openapi_types(_):
"message": (str,),
"name": (str,),
"options": (SecurityMonitoringRuleOptions,),
"queries": ([SecurityMonitoringSignalRuleQuery],),
"queries": ([SecurityMonitoringSignalRuleResponseQuery],),
"tags": ([str],),
"type": (SecurityMonitoringSignalRuleType,),
"update_author_id": (int,),
Expand Down Expand Up @@ -99,7 +101,7 @@ def __init__(self_, *args, **kwargs):
:type options: SecurityMonitoringRuleOptions, optional

:param queries: Queries for selecting logs which are part of the rule.
:type queries: [SecurityMonitoringSignalRuleQuery], optional
:type queries: [SecurityMonitoringSignalRuleResponseQuery], optional

:param tags: Tags for generated signals.
:type tags: [str], optional
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
# This product includes software developed at Datadog (https://www.datadoghq.com/).
# Copyright 2019-Present Datadog, Inc.


from datadog_api_client.model_utils import (
ModelNormal,
cached_property,
)


class SecurityMonitoringSignalRuleResponseQuery(ModelNormal):
validations = {
"correlated_query_index": {
"inclusive_maximum": 9,
},
}

@cached_property
def openapi_types(_):
from datadog_api_client.v2.model.security_monitoring_rule_query_aggregation import (
SecurityMonitoringRuleQueryAggregation,
)

return {
"aggregation": (SecurityMonitoringRuleQueryAggregation,),
"correlated_by_fields": ([str],),
"correlated_query_index": (int,),
"default_rule_id": (str,),
"metrics": ([str],),
"name": (str,),
"rule_id": (str,),
}

attribute_map = {
"aggregation": "aggregation",
"correlated_by_fields": "correlatedByFields",
"correlated_query_index": "correlatedQueryIndex",
"default_rule_id": "defaultRuleId",
"metrics": "metrics",
"name": "name",
"rule_id": "ruleId",
}

def __init__(self_, *args, **kwargs):
"""
Query for matching rule on signals.

:param aggregation: The aggregation type.
:type aggregation: SecurityMonitoringRuleQueryAggregation, optional

:param correlated_by_fields: Fields to group by.
:type correlated_by_fields: [str], optional

:param correlated_query_index: Index of the rule query used to retrieve the correlated field.
:type correlated_query_index: int, optional

:param default_rule_id: Default Rule ID to match on signals.
:type default_rule_id: str, optional

:param metrics: Group of target fields to aggregate over when using the new value aggregations.
:type metrics: [str], optional

:param name: Name of the query.
:type name: str, optional

:param rule_id: Rule ID to match on signals.
:type rule_id: str, optional
"""
super().__init__(kwargs)

self_._check_pos_args(args)
3 changes: 3 additions & 0 deletions src/datadog_api_client/v2/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,9 @@
)
from datadog_api_client.v2.model.security_monitoring_signal_rule_query import SecurityMonitoringSignalRuleQuery
from datadog_api_client.v2.model.security_monitoring_signal_rule_response import SecurityMonitoringSignalRuleResponse
from datadog_api_client.v2.model.security_monitoring_signal_rule_response_query import (
SecurityMonitoringSignalRuleResponseQuery,
)
from datadog_api_client.v2.model.security_monitoring_signal_rule_type import SecurityMonitoringSignalRuleType
from datadog_api_client.v2.model.security_monitoring_signal_state import SecurityMonitoringSignalState
from datadog_api_client.v2.model.security_monitoring_signal_state_update_attributes import (
Expand Down