Skip to content

Commit 3067c15

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 5971a14 of spec repo
1 parent a76b93f commit 3067c15

15 files changed

Lines changed: 679 additions & 1 deletion

‎.generator/schemas/v1/openapi.yaml‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7534,6 +7534,130 @@ components:
75347534
- data_source
75357535
- query
75367536
type: object
7537+
MonitorFormulaAndFunctionDataQualityDataSource:
7538+
description: Data source for data quality queries.
7539+
enum:
7540+
- data_quality_metrics
7541+
example: data_quality_metrics
7542+
type: string
7543+
x-enum-varnames:
7544+
- DATA_QUALITY_METRICS
7545+
MonitorFormulaAndFunctionDataQualityMeasure:
7546+
description: The data quality measure to query.
7547+
enum:
7548+
- bytes
7549+
- cardinality
7550+
- custom
7551+
- freshness
7552+
- max
7553+
- mean
7554+
- min
7555+
- nullness
7556+
- percent_negative
7557+
- percent_zero
7558+
- row_count
7559+
- stddev
7560+
- sum
7561+
- uniqueness
7562+
example: row_count
7563+
type: string
7564+
x-enum-varnames:
7565+
- BYTES
7566+
- CARDINALITY
7567+
- CUSTOM
7568+
- FRESHNESS
7569+
- MAX
7570+
- MEAN
7571+
- MIN
7572+
- NULLNESS
7573+
- PERCENT_NEGATIVE
7574+
- PERCENT_ZERO
7575+
- ROW_COUNT
7576+
- STDDEV
7577+
- SUM
7578+
- UNIQUENESS
7579+
MonitorFormulaAndFunctionDataQualityModelTypeOverride:
7580+
description: Override for the model type used in anomaly detection.
7581+
enum:
7582+
- freshness
7583+
- percentage
7584+
- any
7585+
type: string
7586+
x-enum-varnames:
7587+
- FRESHNESS
7588+
- PERCENTAGE
7589+
- ANY
7590+
MonitorFormulaAndFunctionDataQualityMonitorOptions:
7591+
description: Monitor configuration options for data quality queries.
7592+
properties:
7593+
crontab_override:
7594+
description: Crontab expression to override the default schedule.
7595+
example: '* * * 10'
7596+
type: string
7597+
custom_sql:
7598+
description: Custom SQL query for the monitor.
7599+
example: SELECT COUNT(*) FROM users AS dd_value
7600+
type: string
7601+
custom_where:
7602+
description: Custom WHERE clause for the query.
7603+
example: USER_ID = 123
7604+
type: string
7605+
group_by_columns:
7606+
description: Columns to group results by.
7607+
example:
7608+
- col1
7609+
- col2
7610+
items:
7611+
type: string
7612+
type: array
7613+
model_type_override:
7614+
$ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityModelTypeOverride'
7615+
type: object
7616+
MonitorFormulaAndFunctionDataQualityQueryDefinition:
7617+
description: A formula and functions data quality query.
7618+
properties:
7619+
data_source:
7620+
$ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityDataSource'
7621+
filter:
7622+
description: 'Filter expression used to match on data entities. Uses Aastra
7623+
query syntax
7624+
7625+
e.g. search for column where `database:production AND table:users`'
7626+
example: search for column where `database:production AND table:users`
7627+
type: string
7628+
group_by:
7629+
description: Optional grouping fields for aggregation.
7630+
example:
7631+
- entity_id
7632+
items:
7633+
type: string
7634+
type: array
7635+
measure:
7636+
$ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityMeasure'
7637+
monitor_options:
7638+
$ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityMonitorOptions'
7639+
name:
7640+
description: Name of the query for use in formulas.
7641+
example: query1
7642+
type: string
7643+
schema_version:
7644+
description: Schema version for the data quality query.
7645+
example: 0.0.1
7646+
type: string
7647+
scope:
7648+
description: 'Optional scoping expression to further filter metrics. Uses
7649+
metrics filter syntax.
7650+
7651+
This is useful when an entity has been configured to emit metrics with
7652+
additional tags.'
7653+
example: env:production
7654+
type: string
7655+
required:
7656+
- name
7657+
- data_source
7658+
- measure
7659+
- filter
7660+
type: object
75377661
MonitorFormulaAndFunctionEventAggregation:
75387662
description: Aggregation methods for event platform queries.
75397663
enum:
@@ -7685,6 +7809,7 @@ components:
76857809
oneOf:
76867810
- $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition'
76877811
- $ref: '#/components/schemas/MonitorFormulaAndFunctionCostQueryDefinition'
7812+
- $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityQueryDefinition'
76887813
MonitorGroupSearchResponse:
76897814
description: The response of a monitor group search.
76907815
example:
@@ -8523,6 +8648,7 @@ components:
85238648
- database-monitoring alert
85248649
- network-performance alert
85258650
- cost alert
8651+
- data-quality alert
85268652
example: query alert
85278653
type: string
85288654
x-enum-varnames:
@@ -8545,6 +8671,7 @@ components:
85458671
- DATABASE_MONITORING_ALERT
85468672
- NETWORK_PERFORMANCE_ALERT
85478673
- COST_ALERT
8674+
- DATA_QUALITY_ALERT
85488675
MonitorUpdateRequest:
85498676
description: Object describing a monitor update request.
85508677
properties:

‎docs/datadog_api_client.v1.model.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2293,6 +2293,41 @@ datadog\_api\_client.v1.model.monitor\_formula\_and\_function\_cost\_query\_defi
22932293
:members:
22942294
:show-inheritance:
22952295

2296+
datadog\_api\_client.v1.model.monitor\_formula\_and\_function\_data\_quality\_data\_source module
2297+
-------------------------------------------------------------------------------------------------
2298+
2299+
.. automodule:: datadog_api_client.v1.model.monitor_formula_and_function_data_quality_data_source
2300+
:members:
2301+
:show-inheritance:
2302+
2303+
datadog\_api\_client.v1.model.monitor\_formula\_and\_function\_data\_quality\_measure module
2304+
--------------------------------------------------------------------------------------------
2305+
2306+
.. automodule:: datadog_api_client.v1.model.monitor_formula_and_function_data_quality_measure
2307+
:members:
2308+
:show-inheritance:
2309+
2310+
datadog\_api\_client.v1.model.monitor\_formula\_and\_function\_data\_quality\_model\_type\_override module
2311+
----------------------------------------------------------------------------------------------------------
2312+
2313+
.. automodule:: datadog_api_client.v1.model.monitor_formula_and_function_data_quality_model_type_override
2314+
:members:
2315+
:show-inheritance:
2316+
2317+
datadog\_api\_client.v1.model.monitor\_formula\_and\_function\_data\_quality\_monitor\_options module
2318+
-----------------------------------------------------------------------------------------------------
2319+
2320+
.. automodule:: datadog_api_client.v1.model.monitor_formula_and_function_data_quality_monitor_options
2321+
:members:
2322+
:show-inheritance:
2323+
2324+
datadog\_api\_client.v1.model.monitor\_formula\_and\_function\_data\_quality\_query\_definition module
2325+
------------------------------------------------------------------------------------------------------
2326+
2327+
.. automodule:: datadog_api_client.v1.model.monitor_formula_and_function_data_quality_query_definition
2328+
:members:
2329+
:show-inheritance:
2330+
22962331
datadog\_api\_client.v1.model.monitor\_formula\_and\_function\_event\_aggregation module
22972332
----------------------------------------------------------------------------------------
22982333

‎examples/v1/monitors/CreateMonitor_3626832481.py‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
"""
2+
Create a Data Quality monitor returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v1.api.monitors_api import MonitorsApi
7+
from datadog_api_client.v1.model.monitor import Monitor
8+
from datadog_api_client.v1.model.monitor_formula_and_function_data_quality_data_source import (
9+
MonitorFormulaAndFunctionDataQualityDataSource,
10+
)
11+
from datadog_api_client.v1.model.monitor_formula_and_function_data_quality_measure import (
12+
MonitorFormulaAndFunctionDataQualityMeasure,
13+
)
14+
from datadog_api_client.v1.model.monitor_formula_and_function_data_quality_query_definition import (
15+
MonitorFormulaAndFunctionDataQualityQueryDefinition,
16+
)
17+
from datadog_api_client.v1.model.monitor_options import MonitorOptions
18+
from datadog_api_client.v1.model.monitor_thresholds import MonitorThresholds
19+
from datadog_api_client.v1.model.monitor_type import MonitorType
20+
21+
body = Monitor(
22+
name="Example-Monitor",
23+
type=MonitorType.DATA_QUALITY_ALERT,
24+
query='formula("query1").last("5m") > 100',
25+
message="Data quality alert triggered",
26+
tags=[
27+
"test:examplemonitor",
28+
"env:ci",
29+
],
30+
priority=3,
31+
options=MonitorOptions(
32+
thresholds=MonitorThresholds(
33+
critical=100.0,
34+
),
35+
variables=[
36+
MonitorFormulaAndFunctionDataQualityQueryDefinition(
37+
name="query1",
38+
data_source=MonitorFormulaAndFunctionDataQualityDataSource.DATA_QUALITY_METRICS,
39+
measure=MonitorFormulaAndFunctionDataQualityMeasure.ROW_COUNT,
40+
filter="search for column where `database:production AND table:users`",
41+
group_by=[
42+
"entity_id",
43+
],
44+
),
45+
],
46+
),
47+
)
48+
49+
configuration = Configuration()
50+
with ApiClient(configuration) as api_client:
51+
api_instance = MonitorsApi(api_client)
52+
response = api_instance.create_monitor(body=body)
53+
54+
print(response)

‎src/datadog_api_client/v1/model/monitor_formula_and_function_data_quality_data_source.py‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
2+
# This product includes software developed at Datadog (https://www.datadoghq.com/).
3+
# Copyright 2019-Present Datadog, Inc.
4+
from __future__ import annotations
5+
6+
7+
from datadog_api_client.model_utils import (
8+
ModelSimple,
9+
cached_property,
10+
)
11+
12+
from typing import ClassVar
13+
14+
15+
class MonitorFormulaAndFunctionDataQualityDataSource(ModelSimple):
16+
"""
17+
Data source for data quality queries.
18+
19+
:param value: If omitted defaults to "data_quality_metrics". Must be one of ["data_quality_metrics"].
20+
:type value: str
21+
"""
22+
23+
allowed_values = {
24+
"data_quality_metrics",
25+
}
26+
DATA_QUALITY_METRICS: ClassVar["MonitorFormulaAndFunctionDataQualityDataSource"]
27+
28+
@cached_property
29+
def openapi_types(_):
30+
return {
31+
"value": (str,),
32+
}
33+
34+
35+
MonitorFormulaAndFunctionDataQualityDataSource.DATA_QUALITY_METRICS = MonitorFormulaAndFunctionDataQualityDataSource(
36+
"data_quality_metrics"
37+
)

‎src/datadog_api_client/v1/model/monitor_formula_and_function_data_quality_measure.py‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
2+
# This product includes software developed at Datadog (https://www.datadoghq.com/).
3+
# Copyright 2019-Present Datadog, Inc.
4+
from __future__ import annotations
5+
6+
7+
from datadog_api_client.model_utils import (
8+
ModelSimple,
9+
cached_property,
10+
)
11+
12+
from typing import ClassVar
13+
14+
15+
class MonitorFormulaAndFunctionDataQualityMeasure(ModelSimple):
16+
"""
17+
The data quality measure to query.
18+
19+
:param value: Must be one of ["bytes", "cardinality", "custom", "freshness", "max", "mean", "min", "nullness", "percent_negative", "percent_zero", "row_count", "stddev", "sum", "uniqueness"].
20+
:type value: str
21+
"""
22+
23+
allowed_values = {
24+
"bytes",
25+
"cardinality",
26+
"custom",
27+
"freshness",
28+
"max",
29+
"mean",
30+
"min",
31+
"nullness",
32+
"percent_negative",
33+
"percent_zero",
34+
"row_count",
35+
"stddev",
36+
"sum",
37+
"uniqueness",
38+
}
39+
BYTES: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
40+
CARDINALITY: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
41+
CUSTOM: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
42+
FRESHNESS: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
43+
MAX: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
44+
MEAN: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
45+
MIN: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
46+
NULLNESS: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
47+
PERCENT_NEGATIVE: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
48+
PERCENT_ZERO: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
49+
ROW_COUNT: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
50+
STDDEV: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
51+
SUM: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
52+
UNIQUENESS: ClassVar["MonitorFormulaAndFunctionDataQualityMeasure"]
53+
54+
@cached_property
55+
def openapi_types(_):
56+
return {
57+
"value": (str,),
58+
}
59+
60+
61+
MonitorFormulaAndFunctionDataQualityMeasure.BYTES = MonitorFormulaAndFunctionDataQualityMeasure("bytes")
62+
MonitorFormulaAndFunctionDataQualityMeasure.CARDINALITY = MonitorFormulaAndFunctionDataQualityMeasure("cardinality")
63+
MonitorFormulaAndFunctionDataQualityMeasure.CUSTOM = MonitorFormulaAndFunctionDataQualityMeasure("custom")
64+
MonitorFormulaAndFunctionDataQualityMeasure.FRESHNESS = MonitorFormulaAndFunctionDataQualityMeasure("freshness")
65+
MonitorFormulaAndFunctionDataQualityMeasure.MAX = MonitorFormulaAndFunctionDataQualityMeasure("max")
66+
MonitorFormulaAndFunctionDataQualityMeasure.MEAN = MonitorFormulaAndFunctionDataQualityMeasure("mean")
67+
MonitorFormulaAndFunctionDataQualityMeasure.MIN = MonitorFormulaAndFunctionDataQualityMeasure("min")
68+
MonitorFormulaAndFunctionDataQualityMeasure.NULLNESS = MonitorFormulaAndFunctionDataQualityMeasure("nullness")
69+
MonitorFormulaAndFunctionDataQualityMeasure.PERCENT_NEGATIVE = MonitorFormulaAndFunctionDataQualityMeasure(
70+
"percent_negative"
71+
)
72+
MonitorFormulaAndFunctionDataQualityMeasure.PERCENT_ZERO = MonitorFormulaAndFunctionDataQualityMeasure("percent_zero")
73+
MonitorFormulaAndFunctionDataQualityMeasure.ROW_COUNT = MonitorFormulaAndFunctionDataQualityMeasure("row_count")
74+
MonitorFormulaAndFunctionDataQualityMeasure.STDDEV = MonitorFormulaAndFunctionDataQualityMeasure("stddev")
75+
MonitorFormulaAndFunctionDataQualityMeasure.SUM = MonitorFormulaAndFunctionDataQualityMeasure("sum")
76+
MonitorFormulaAndFunctionDataQualityMeasure.UNIQUENESS = MonitorFormulaAndFunctionDataQualityMeasure("uniqueness")

0 commit comments

Comments
 (0)