Skip to content

Commit 2701861

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 39e56e6 of spec repo
1 parent 19a4754 commit 2701861

23 files changed

Lines changed: 204 additions & 56 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 57 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18908,9 +18908,6 @@ components:
1890818908
ConvertJobResultsToSignalsAttributes:
1890918909
description: Attributes for converting historical job results to signals.
1891018910
properties:
18911-
id:
18912-
description: Request ID.
18913-
type: string
1891418911
jobResultIds:
1891518912
description: Job result IDs.
1891618913
example:
@@ -37540,10 +37537,34 @@ components:
3754037537
HistoricalJobQuery:
3754137538
description: Query for selecting logs analyzed by the historical job.
3754237539
properties:
37540+
additionalFilters:
37541+
description: Additional filters appended to the query at evaluation time.
37542+
type: string
3754337543
aggregation:
3754437544
$ref: "#/components/schemas/SecurityMonitoringRuleQueryAggregation"
37545+
correlatedByFields:
37546+
description: Fields used to correlate results across queries in sequence detection rules.
37547+
items:
37548+
description: Field.
37549+
type: string
37550+
type: array
37551+
correlatedQueryIndex:
37552+
description: Zero-based index of the query to correlate with in sequence detection rules. Up to 10 queries are supported, so valid values are 0 to 9.
37553+
format: int64
37554+
maximum: 9
37555+
minimum: 0
37556+
type: integer
37557+
customQueryExtension:
37558+
description: Custom query extension used to refine the base query.
37559+
type: string
3754537560
dataSource:
3754637561
$ref: "#/components/schemas/SecurityMonitoringStandardDataSource"
37562+
datasetIds:
37563+
description: IDs of reference datasets used by this query.
37564+
items:
37565+
description: Dataset ID.
37566+
type: string
37567+
type: array
3754737568
distinctFields:
3754837569
description: Field for which the cardinality is measured. Sent as an array.
3754937570
items:
@@ -37561,6 +37582,15 @@ components:
3756137582
description: When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with `N/A`, replacing the missing values.
3756237583
example: false
3756337584
type: boolean
37585+
index:
37586+
description: Index used to load the data for this query.
37587+
type: string
37588+
indexes:
37589+
description: Indexes used to load the data for this query. Mutually exclusive with `index`.
37590+
items:
37591+
description: Index name.
37592+
type: string
37593+
type: array
3756437594
metrics:
3756537595
description: Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.
3756637596
items:
@@ -37574,6 +37604,9 @@ components:
3757437604
description: Query to run on logs.
3757537605
example: a > 3
3757637606
type: string
37607+
queryLanguage:
37608+
description: Language used to parse the query string.
37609+
type: string
3757737610
type: object
3757837611
HistoricalJobResponse:
3757937612
description: Historical job response.
@@ -37607,6 +37640,10 @@ components:
3760737640
modifiedAt:
3760837641
description: Last modification time of the job.
3760937642
type: string
37643+
progressRate:
37644+
description: Job execution progress as a value between 0 and 1. Omitted for finished jobs.
37645+
format: double
37646+
type: number
3761037647
signalOutput:
3761137648
description: Whether the job outputs signals.
3761237649
type: boolean
@@ -43137,9 +43174,10 @@ components:
4313743174
$ref: "#/components/schemas/CalculatedField"
4313843175
type: array
4313943176
cases:
43140-
description: Cases used for generating job results.
43177+
description: Cases used for generating job results. Up to 10 cases are allowed.
4314143178
items:
4314243179
$ref: "#/components/schemas/SecurityMonitoringRuleCaseCreate"
43180+
maxItems: 10
4314343181
type: array
4314443182
from:
4314543183
description: Starting time of data analyzed by the job.
@@ -43169,9 +43207,10 @@ components:
4316943207
options:
4317043208
$ref: "#/components/schemas/HistoricalJobOptions"
4317143209
queries:
43172-
description: Queries for selecting logs analyzed by the job.
43210+
description: Queries for selecting logs analyzed by the job. Up to 10 queries are allowed.
4317343211
items:
4317443212
$ref: "#/components/schemas/HistoricalJobQuery"
43213+
maxItems: 10
4317543214
type: array
4317643215
referenceTables:
4317743216
description: Reference tables used in the queries.
@@ -43185,10 +43224,11 @@ components:
4318543224
type: string
4318643225
type: array
4318743226
thirdPartyCases:
43188-
description: Cases for generating results from third-party detection method. Only available for third-party detection method.
43227+
description: Cases for generating results from third-party detection method. Only available for third-party detection method. Up to 10 cases are allowed.
4318943228
example: []
4319043229
items:
4319143230
$ref: "#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate"
43231+
maxItems: 10
4319243232
type: array
4319343233
to:
4319443234
description: Ending time of data analyzed by the job.
@@ -43210,6 +43250,12 @@ components:
4321043250
JobDefinitionFromRule:
4321143251
description: Definition of a historical job based on a security monitoring rule.
4321243252
properties:
43253+
caseIndex:
43254+
description: Zero-based index of the rule case to use as the job's signal condition. When omitted, all cases are evaluated. Up to 10 cases are supported, so valid values are 0 to 9.
43255+
format: int32
43256+
maximum: 9
43257+
minimum: 0
43258+
type: integer
4321343259
from:
4321443260
description: Starting time of data analyzed by the job.
4321543261
example: 1729843470000
@@ -70274,11 +70320,11 @@ components:
7027470320
properties:
7027570321
fromRule:
7027670322
$ref: "#/components/schemas/JobDefinitionFromRule"
70277-
id:
70278-
description: Request ID.
70279-
type: string
7028070323
jobDefinition:
7028170324
$ref: "#/components/schemas/JobDefinition"
70325+
signalOutput:
70326+
description: Whether the job outputs signals when results are converted.
70327+
type: boolean
7028270328
type: object
7028370329
RunHistoricalJobRequestData:
7028470330
description: Data for running a historical job request.
@@ -154835,7 +154881,7 @@ paths:
154835154881
**Note**: This endpoint is in beta and may be subject to changes.
154836154882
Please check the documentation regularly for updates.
154837154883
/api/v2/siem-historical-detections/histsignals/search:
154838-
get:
154884+
post:
154839154885
description: Search hist signals.
154840154886
operationId: SearchSecurityMonitoringHistsignals
154841154887
requestBody:
@@ -154887,6 +154933,7 @@ paths:
154887154933
- security_monitoring_signals_read
154888154934
summary: Search hist signals
154889154935
tags: ["Security Monitoring"]
154936+
x-codegen-request-body-name: body
154890154937
"x-permission":
154891154938
operator: OR
154892154939
permissions:

src/datadog_api_client/v2/api/security_monitoring_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3448,7 +3448,7 @@ def __init__(self, api_client=None):
34483448
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
34493449
"endpoint_path": "/api/v2/siem-historical-detections/histsignals/search",
34503450
"operation_id": "search_security_monitoring_histsignals",
3451-
"http_method": "GET",
3451+
"http_method": "POST",
34523452
"version": "v2",
34533453
},
34543454
params_map={

src/datadog_api_client/v2/model/convert_job_results_to_signals_attributes.py

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@
33
# Copyright 2019-Present Datadog, Inc.
44
from __future__ import annotations
55

6-
from typing import List, Union, TYPE_CHECKING
6+
from typing import List, TYPE_CHECKING
77

88
from datadog_api_client.model_utils import (
99
ModelNormal,
1010
cached_property,
11-
unset,
12-
UnsetType,
1311
)
1412

1513

@@ -23,15 +21,13 @@ def openapi_types(_):
2321
from datadog_api_client.v2.model.security_monitoring_rule_severity import SecurityMonitoringRuleSeverity
2422

2523
return {
26-
"id": (str,),
2724
"job_result_ids": ([str],),
2825
"notifications": ([str],),
2926
"signal_message": (str,),
3027
"signal_severity": (SecurityMonitoringRuleSeverity,),
3128
}
3229

3330
attribute_map = {
34-
"id": "id",
3531
"job_result_ids": "jobResultIds",
3632
"notifications": "notifications",
3733
"signal_message": "signalMessage",
@@ -44,15 +40,11 @@ def __init__(
4440
notifications: List[str],
4541
signal_message: str,
4642
signal_severity: SecurityMonitoringRuleSeverity,
47-
id: Union[str, UnsetType] = unset,
4843
**kwargs,
4944
):
5045
"""
5146
Attributes for converting historical job results to signals.
5247
53-
:param id: Request ID.
54-
:type id: str, optional
55-
5648
:param job_result_ids: Job result IDs.
5749
:type job_result_ids: [str]
5850
@@ -65,8 +57,6 @@ def __init__(
6557
:param signal_severity: Severity of the Security Signal.
6658
:type signal_severity: SecurityMonitoringRuleSeverity
6759
"""
68-
if id is not unset:
69-
kwargs["id"] = id
7060
super().__init__(kwargs)
7161

7262
self_.job_result_ids = job_result_ids

src/datadog_api_client/v2/model/historical_job_query.py

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@
2323

2424

2525
class HistoricalJobQuery(ModelNormal):
26+
validations = {
27+
"correlated_query_index": {
28+
"inclusive_maximum": 9,
29+
"inclusive_minimum": 0,
30+
},
31+
}
32+
2633
@cached_property
2734
def openapi_types(_):
2835
from datadog_api_client.v2.model.security_monitoring_rule_query_aggregation import (
@@ -33,48 +40,87 @@ def openapi_types(_):
3340
)
3441

3542
return {
43+
"additional_filters": (str,),
3644
"aggregation": (SecurityMonitoringRuleQueryAggregation,),
45+
"correlated_by_fields": ([str],),
46+
"correlated_query_index": (int,),
47+
"custom_query_extension": (str,),
3748
"data_source": (SecurityMonitoringStandardDataSource,),
49+
"dataset_ids": ([str],),
3850
"distinct_fields": ([str],),
3951
"group_by_fields": ([str],),
4052
"has_optional_group_by_fields": (bool,),
53+
"index": (str,),
54+
"indexes": ([str],),
4155
"metrics": ([str],),
4256
"name": (str,),
4357
"query": (str,),
58+
"query_language": (str,),
4459
}
4560

4661
attribute_map = {
62+
"additional_filters": "additionalFilters",
4763
"aggregation": "aggregation",
64+
"correlated_by_fields": "correlatedByFields",
65+
"correlated_query_index": "correlatedQueryIndex",
66+
"custom_query_extension": "customQueryExtension",
4867
"data_source": "dataSource",
68+
"dataset_ids": "datasetIds",
4969
"distinct_fields": "distinctFields",
5070
"group_by_fields": "groupByFields",
5171
"has_optional_group_by_fields": "hasOptionalGroupByFields",
72+
"index": "index",
73+
"indexes": "indexes",
5274
"metrics": "metrics",
5375
"name": "name",
5476
"query": "query",
77+
"query_language": "queryLanguage",
5578
}
5679

5780
def __init__(
5881
self_,
82+
additional_filters: Union[str, UnsetType] = unset,
5983
aggregation: Union[SecurityMonitoringRuleQueryAggregation, UnsetType] = unset,
84+
correlated_by_fields: Union[List[str], UnsetType] = unset,
85+
correlated_query_index: Union[int, UnsetType] = unset,
86+
custom_query_extension: Union[str, UnsetType] = unset,
6087
data_source: Union[SecurityMonitoringStandardDataSource, UnsetType] = unset,
88+
dataset_ids: Union[List[str], UnsetType] = unset,
6189
distinct_fields: Union[List[str], UnsetType] = unset,
6290
group_by_fields: Union[List[str], UnsetType] = unset,
6391
has_optional_group_by_fields: Union[bool, UnsetType] = unset,
92+
index: Union[str, UnsetType] = unset,
93+
indexes: Union[List[str], UnsetType] = unset,
6494
metrics: Union[List[str], UnsetType] = unset,
6595
name: Union[str, UnsetType] = unset,
6696
query: Union[str, UnsetType] = unset,
97+
query_language: Union[str, UnsetType] = unset,
6798
**kwargs,
6899
):
69100
"""
70101
Query for selecting logs analyzed by the historical job.
71102
103+
:param additional_filters: Additional filters appended to the query at evaluation time.
104+
:type additional_filters: str, optional
105+
72106
:param aggregation: The aggregation type.
73107
:type aggregation: SecurityMonitoringRuleQueryAggregation, optional
74108
109+
:param correlated_by_fields: Fields used to correlate results across queries in sequence detection rules.
110+
:type correlated_by_fields: [str], optional
111+
112+
:param correlated_query_index: Zero-based index of the query to correlate with in sequence detection rules. Up to 10 queries are supported, so valid values are 0 to 9.
113+
:type correlated_query_index: int, optional
114+
115+
:param custom_query_extension: Custom query extension used to refine the base query.
116+
:type custom_query_extension: str, optional
117+
75118
:param data_source: Source of events, either logs, audit trail, security signals, or Datadog events. ``app_sec_spans`` is deprecated in favor of ``spans``.
76119
:type data_source: SecurityMonitoringStandardDataSource, optional
77120
121+
:param dataset_ids: IDs of reference datasets used by this query.
122+
:type dataset_ids: [str], optional
123+
78124
:param distinct_fields: Field for which the cardinality is measured. Sent as an array.
79125
:type distinct_fields: [str], optional
80126
@@ -84,6 +130,12 @@ def __init__(
84130
:param has_optional_group_by_fields: When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with ``N/A`` , replacing the missing values.
85131
:type has_optional_group_by_fields: bool, optional
86132
133+
:param index: Index used to load the data for this query.
134+
:type index: str, optional
135+
136+
:param indexes: Indexes used to load the data for this query. Mutually exclusive with ``index``.
137+
:type indexes: [str], optional
138+
87139
:param metrics: Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.
88140
:type metrics: [str], optional
89141
@@ -92,21 +144,40 @@ def __init__(
92144
93145
:param query: Query to run on logs.
94146
:type query: str, optional
147+
148+
:param query_language: Language used to parse the query string.
149+
:type query_language: str, optional
95150
"""
151+
if additional_filters is not unset:
152+
kwargs["additional_filters"] = additional_filters
96153
if aggregation is not unset:
97154
kwargs["aggregation"] = aggregation
155+
if correlated_by_fields is not unset:
156+
kwargs["correlated_by_fields"] = correlated_by_fields
157+
if correlated_query_index is not unset:
158+
kwargs["correlated_query_index"] = correlated_query_index
159+
if custom_query_extension is not unset:
160+
kwargs["custom_query_extension"] = custom_query_extension
98161
if data_source is not unset:
99162
kwargs["data_source"] = data_source
163+
if dataset_ids is not unset:
164+
kwargs["dataset_ids"] = dataset_ids
100165
if distinct_fields is not unset:
101166
kwargs["distinct_fields"] = distinct_fields
102167
if group_by_fields is not unset:
103168
kwargs["group_by_fields"] = group_by_fields
104169
if has_optional_group_by_fields is not unset:
105170
kwargs["has_optional_group_by_fields"] = has_optional_group_by_fields
171+
if index is not unset:
172+
kwargs["index"] = index
173+
if indexes is not unset:
174+
kwargs["indexes"] = indexes
106175
if metrics is not unset:
107176
kwargs["metrics"] = metrics
108177
if name is not unset:
109178
kwargs["name"] = name
110179
if query is not unset:
111180
kwargs["query"] = query
181+
if query_language is not unset:
182+
kwargs["query_language"] = query_language
112183
super().__init__(kwargs)

0 commit comments

Comments
 (0)