Skip to content
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
578 changes: 183 additions & 395 deletions .generator/schemas/v2/openapi.yaml

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/datadog_api_client.v2.api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,13 @@ datadog\_api\_client.v2.api.data\_deletion\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.data\_observability\_api module
-----------------------------------------------------------

.. automodule:: datadog_api_client.v2.api.data_observability_api
:members:
:show-inheritance:

datadog\_api\_client.v2.api.datasets\_api module
------------------------------------------------

Expand Down Expand Up @@ -711,13 +718,6 @@ datadog\_api\_client.v2.api.rum\_retention\_filters\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.rum\_retention\_filters\_hardcoded\_api module
--------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.api.rum_retention_filters_hardcoded_api
:members:
:show-inheritance:

datadog\_api\_client.v2.api.salesforce\_integration\_api module
---------------------------------------------------------------

Expand Down
147 changes: 49 additions & 98 deletions docs/datadog_api_client.v2.model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10987,6 +10987,20 @@ datadog\_api\_client.v2.model.data\_export\_config module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.data\_observability\_monitor\_run\_status module
------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.data\_observability\_monitor\_run\_type module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.data\_relationships\_teams module
---------------------------------------------------------------

Expand Down Expand Up @@ -15789,6 +15803,27 @@ datadog\_api\_client.v2.model.get\_data\_deletions\_response\_body module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.get\_data\_observability\_monitor\_run\_status\_response module
---------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.get\_data\_observability\_monitor\_run\_status\_response\_attributes module
---------------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.get\_data\_observability\_monitor\_run\_status\_response\_data module
---------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.get\_device\_attributes module
------------------------------------------------------------

Expand Down Expand Up @@ -32925,104 +32960,6 @@ datadog\_api\_client.v2.model.rum\_group\_by\_total module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_hardcoded\_cross\_product\_sampling module
-----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_hardcoded\_cross\_product\_sampling\_editability module
------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_hardcoded\_cross\_product\_sampling\_update module
-------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_attributes module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_data module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_event\_type module
-----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_meta module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_meta\_source module
------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_response module
--------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_type module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_update\_attributes module
------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_update\_data module
------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_update\_request module
---------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filters\_response module
---------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_metric\_compute module
---------------------------------------------------------

Expand Down Expand Up @@ -33548,6 +33485,20 @@ datadog\_api\_client.v2.model.rum\_warning module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.run\_data\_observability\_monitor\_response module
--------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.run\_data\_observability\_monitor\_response\_data module
--------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.run\_historical\_job\_request module
------------------------------------------------------------------

Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

2 changes: 2 additions & 0 deletions src/datadog_api_client/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -482,6 +482,8 @@ def __init__(
"v2.update_dashboard_secure_embed": False,
"v2.get_dashboard_usage": False,
"v2.list_dashboards_usage": False,
"v2.get_data_observability_monitor_run_status": False,
"v2.run_data_observability_monitor": False,
"v2.create_dataset": False,
"v2.delete_dataset": False,
"v2.get_all_datasets": False,
Expand Down
104 changes: 104 additions & 0 deletions src/datadog_api_client/v2/api/data_observability_api.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# 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 __future__ import annotations

from typing import Any, Dict

from datadog_api_client.api_client import ApiClient, Endpoint as _Endpoint
from datadog_api_client.configuration import Configuration
from datadog_api_client.v2.model.get_data_observability_monitor_run_status_response import (
GetDataObservabilityMonitorRunStatusResponse,
)
from datadog_api_client.v2.model.run_data_observability_monitor_response import RunDataObservabilityMonitorResponse


class DataObservabilityApi:
"""
Manage and run data observability monitors.
"""

def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient(Configuration())
self.api_client = api_client

self._get_data_observability_monitor_run_status_endpoint = _Endpoint(
settings={
"response_type": (GetDataObservabilityMonitorRunStatusResponse,),
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
"endpoint_path": "/api/v2/data-observability/monitors/runs/{run_id}/status",
"operation_id": "get_data_observability_monitor_run_status",
"http_method": "GET",
"version": "v2",
},
params_map={
"run_id": {
"required": True,
"openapi_types": (str,),
"attribute": "run_id",
"location": "path",
},
},
headers_map={
"accept": ["application/json"],
},
api_client=api_client,
)

self._run_data_observability_monitor_endpoint = _Endpoint(
settings={
"response_type": (RunDataObservabilityMonitorResponse,),
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
"endpoint_path": "/api/v2/data-observability/monitors/{monitor_id}/run",
"operation_id": "run_data_observability_monitor",
"http_method": "POST",
"version": "v2",
},
params_map={
"monitor_id": {
"required": True,
"openapi_types": (int,),
"attribute": "monitor_id",
"location": "path",
},
},
headers_map={
"accept": ["application/json"],
},
api_client=api_client,
)

def get_data_observability_monitor_run_status(
self,
run_id: str,
) -> GetDataObservabilityMonitorRunStatusResponse:
"""Get data observability monitor run status.

Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.

:param run_id: The ID of the monitor run to retrieve status for.
:type run_id: str
:rtype: GetDataObservabilityMonitorRunStatusResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["run_id"] = run_id

return self._get_data_observability_monitor_run_status_endpoint.call_with_http_info(**kwargs)

def run_data_observability_monitor(
self,
monitor_id: int,
) -> RunDataObservabilityMonitorResponse:
"""Run a data observability monitor.

Manually triggers a run for a data observability monitor. Only monitors that are not scheduled (manually-runnable) can be triggered this way.

:param monitor_id: The ID of the data observability monitor to run.
:type monitor_id: int
:rtype: RunDataObservabilityMonitorResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["monitor_id"] = monitor_id

return self._run_data_observability_monitor_endpoint.call_with_http_info(**kwargs)
Loading
Loading