Regenerate client from commit 57b75ade of spec repo

Author: ci.datadog-api-spec

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-08-17 14:32:08.800124",
-            "spec_repo_commit": "a957cd49"
+            "regenerated": "2022-08-17 17:26:27.093787",
+            "spec_repo_commit": "57b75ade"
         },
         "v2": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-08-17 14:32:08.814442",
-            "spec_repo_commit": "a957cd49"
+            "regenerated": "2022-08-17 17:26:27.106221",
+            "spec_repo_commit": "57b75ade"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -6133,6 +6133,17 @@ components:
           format: int64
           nullable: true
           type: integer
+        group_retention_duration:
+          description: 'The time span after which groups with missing data are dropped
+            from the monitor state.
+
+            The minimum value is one hour, and the maximum value is 72 hours.
+
+            Example values are: "60m", "1h", and "2d".
+
+            This option is only available for APM Trace Analytics, Audit Trail, CI,
+            Error Tracking, Event, Logs, and RUM monitors.'
+          type: string
         groupby_simple_monitor:
           description: Whether the log alert monitor triggers a single alert or multiple
             alerts when any group breaches a threshold.
@@ -6223,6 +6234,8 @@ components:
           description: A Boolean indicating whether this monitor notifies when data
             stops reporting.
           type: boolean
+        on_missing_data:
+          $ref: '#/components/schemas/OnMissingDataOption'
         renotify_interval:
           default: null
           description: "The number of minutes after the last notification before a
@@ -7928,6 +7941,32 @@ components:
           format: int64
           type: integer
       type: object
+    OnMissingDataOption:
+      description: 'Controls how groups or monitors are treated if an evaluation does
+        not return any data points.
+
+        The default option results in different behavior depending on the monitor
+        query type.
+
+        For monitors using Count queries, an empty monitor evaluation is treated as
+        0 and is compared to the threshold conditions.
+
+        For monitor using any query type other than Count, for example Gauge or Rate,
+        the monitor shows the last known status.
+
+        This option is only available for APM Trace Analytics, Audit Trail, CI, Error
+        Tracking, Event, Logs, and RUM monitors.'
+      enum:
+      - default
+      - show_no_data
+      - show_and_notify_no_data
+      - resolve
+      type: string
+      x-enum-varnames:
+      - DEFAULT
+      - SHOW_NO_DATA
+      - SHOW_AND_NOTIFY_NO_DATA
+      - RESOLVE
     OrgDowngradedResponse:
       description: Status of downgrade
       properties:

docs/datadog_api_client.v1.model.rst

@@ -2353,6 +2353,13 @@ notebooks\_response\_page
    :members:
    :show-inheritance:
 
+on\_missing\_data\_option
+-------------------------
+
+.. automodule:: datadog_api_client.v1.model.on_missing_data_option
+   :members:
+   :show-inheritance:
+
 org\_downgraded\_response
 -------------------------
 

examples/v1/monitors/ValidateExistingMonitor.py

@@ -9,6 +9,7 @@
 from datadog_api_client.v1.model.monitor_options import MonitorOptions
 from datadog_api_client.v1.model.monitor_thresholds import MonitorThresholds
 from datadog_api_client.v1.model.monitor_type import MonitorType
+from datadog_api_client.v1.model.on_missing_data_option import OnMissingDataOption
 
 # there is a valid "monitor" in the system
 MONITOR_ID = environ["MONITOR_ID"]
@@ -34,6 +35,7 @@
         no_data_timeframe=None,
         notify_audit=False,
         notify_no_data=False,
+        on_missing_data=OnMissingDataOption("show_and_notify_no_data"),
         renotify_interval=60,
         require_full_window=True,
         timeout_h=24,

examples/v1/monitors/ValidateMonitor.py

@@ -8,6 +8,7 @@
 from datadog_api_client.v1.model.monitor_options import MonitorOptions
 from datadog_api_client.v1.model.monitor_thresholds import MonitorThresholds
 from datadog_api_client.v1.model.monitor_type import MonitorType
+from datadog_api_client.v1.model.on_missing_data_option import OnMissingDataOption
 
 body = Monitor(
     name="Example-Validate_a_monitor_returns_OK_response",
@@ -30,6 +31,7 @@
         no_data_timeframe=None,
         notify_audit=False,
         notify_no_data=False,
+        on_missing_data=OnMissingDataOption("show_and_notify_no_data"),
         renotify_interval=60,
         require_full_window=True,
         timeout_h=24,

examples/v1/monitors/ValidateMonitor_4247196452.py

@@ -0,0 +1,51 @@
+"""
+Validate a multi-alert monitor returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.monitors_api import MonitorsApi
+from datadog_api_client.v1.model.monitor import Monitor
+from datadog_api_client.v1.model.monitor_options import MonitorOptions
+from datadog_api_client.v1.model.monitor_thresholds import MonitorThresholds
+from datadog_api_client.v1.model.monitor_type import MonitorType
+from datadog_api_client.v1.model.on_missing_data_option import OnMissingDataOption
+
+body = Monitor(
+    name="Example-Validate_a_multi_alert_monitor_returns_OK_response",
+    type=MonitorType("log alert"),
+    query='logs("service:foo AND type:error").index("main").rollup("count").by("source").last("5m") > 2',
+    message="some message Notify: @hipchat-channel",
+    tags=[
+        "test:examplevalidateamultialertmonitorreturnsokresponse",
+        "env:ci",
+    ],
+    priority=3,
+    options=MonitorOptions(
+        enable_logs_sample=True,
+        escalation_message="the situation has escalated",
+        evaluation_delay=700,
+        group_retention_duration="2d",
+        groupby_simple_monitor=False,
+        include_tags=True,
+        locked=False,
+        new_host_delay=600,
+        no_data_timeframe=None,
+        notify_audit=False,
+        notify_no_data=False,
+        on_missing_data=OnMissingDataOption("show_and_notify_no_data"),
+        renotify_interval=60,
+        require_full_window=True,
+        timeout_h=24,
+        thresholds=MonitorThresholds(
+            critical=2.0,
+            warning=1.0,
+        ),
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = MonitorsApi(api_client)
+    response = api_instance.validate_monitor(body=body)
+
+    print(response)

src/datadog_api_client/v1/model/monitor_options.py

@@ -22,6 +22,7 @@ class MonitorOptions(ModelNormal):
     def openapi_types(_):
         from datadog_api_client.v1.model.monitor_options_aggregation import MonitorOptionsAggregation
         from datadog_api_client.v1.model.monitor_device_id import MonitorDeviceID
+        from datadog_api_client.v1.model.on_missing_data_option import OnMissingDataOption
         from datadog_api_client.v1.model.monitor_renotify_status_type import MonitorRenotifyStatusType
         from datadog_api_client.v1.model.monitor_threshold_window_options import MonitorThresholdWindowOptions
         from datadog_api_client.v1.model.monitor_thresholds import MonitorThresholds
@@ -35,6 +36,7 @@ def openapi_types(_):
             "enable_logs_sample": (bool,),
             "escalation_message": (str,),
             "evaluation_delay": (int, none_type),
+            "group_retention_duration": (str,),
             "groupby_simple_monitor": (bool,),
             "include_tags": (bool,),
             "locked": (bool,),
@@ -45,6 +47,7 @@ def openapi_types(_):
             "no_data_timeframe": (int, none_type),
             "notify_audit": (bool,),
             "notify_no_data": (bool,),
+            "on_missing_data": (OnMissingDataOption,),
             "renotify_interval": (int, none_type),
             "renotify_occurrences": (int, none_type),
             "renotify_statuses": ([MonitorRenotifyStatusType], none_type),
@@ -70,6 +73,7 @@ def openapi_types(_):
         "enable_logs_sample": "enable_logs_sample",
         "escalation_message": "escalation_message",
         "evaluation_delay": "evaluation_delay",
+        "group_retention_duration": "group_retention_duration",
         "groupby_simple_monitor": "groupby_simple_monitor",
         "include_tags": "include_tags",
         "locked": "locked",
@@ -80,6 +84,7 @@ def openapi_types(_):
         "no_data_timeframe": "no_data_timeframe",
         "notify_audit": "notify_audit",
         "notify_no_data": "notify_no_data",
+        "on_missing_data": "on_missing_data",
         "renotify_interval": "renotify_interval",
         "renotify_occurrences": "renotify_occurrences",
         "renotify_statuses": "renotify_statuses",
@@ -120,6 +125,12 @@ def __init__(self, *args, **kwargs):
             This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.
         :type evaluation_delay: int, none_type, optional
 
+        :param group_retention_duration: The time span after which groups with missing data are dropped from the monitor state.
+            The minimum value is one hour, and the maximum value is 72 hours.
+            Example values are: "60m", "1h", and "2d".
+            This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
+        :type group_retention_duration: str, optional
+
         :param groupby_simple_monitor: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold.
         :type groupby_simple_monitor: bool, optional
 
@@ -168,6 +179,13 @@ def __init__(self, *args, **kwargs):
         :param notify_no_data: A Boolean indicating whether this monitor notifies when data stops reporting.
         :type notify_no_data: bool, optional
 
+        :param on_missing_data: Controls how groups or monitors are treated if an evaluation does not return any data points.
+            The default option results in different behavior depending on the monitor query type.
+            For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.
+            For monitor using any query type other than Count, for example Gauge or Rate, the monitor shows the last known status.
+            This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
+        :type on_missing_data: OnMissingDataOption, optional
+
         :param renotify_interval: The number of minutes after the last notification before a monitor re-notifies on the current status.
             It only re-notifies if it’s not resolved.
         :type renotify_interval: int, none_type, optional

src/datadog_api_client/v1/model/on_missing_data_option.py

@@ -0,0 +1,37 @@
+# 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 (
+    ModelSimple,
+    cached_property,
+)
+
+
+class OnMissingDataOption(ModelSimple):
+    """
+    Controls how groups or monitors are treated if an evaluation does not return any data points.
+        The default option results in different behavior depending on the monitor query type.
+        For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.
+        For monitor using any query type other than Count, for example Gauge or Rate, the monitor shows the last known status.
+        This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
+
+    :param value: Must be one of ["default", "show_no_data", "show_and_notify_no_data", "resolve"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "value": {
+            "DEFAULT": "default",
+            "SHOW_NO_DATA": "show_no_data",
+            "SHOW_AND_NOTIFY_NO_DATA": "show_and_notify_no_data",
+            "RESOLVE": "resolve",
+        },
+    }
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }

src/datadog_api_client/v1/models/__init__.py

@@ -382,6 +382,7 @@
 from datadog_api_client.v1.model.notebooks_response_data_attributes import NotebooksResponseDataAttributes
 from datadog_api_client.v1.model.notebooks_response_meta import NotebooksResponseMeta
 from datadog_api_client.v1.model.notebooks_response_page import NotebooksResponsePage
+from datadog_api_client.v1.model.on_missing_data_option import OnMissingDataOption
 from datadog_api_client.v1.model.org_downgraded_response import OrgDowngradedResponse
 from datadog_api_client.v1.model.organization import Organization
 from datadog_api_client.v1.model.organization_billing import OrganizationBilling

tests/v1/cassettes/test_scenarios/test_check_if_a_monitor_can_be_deleted_returns_ok_response.frozen

@@ -1 +1 @@
-2022-01-06T00:50:53.019Z
+2022-08-15T18:04:41.604Z

tests/v1/cassettes/test_scenarios/test_check_if_a_monitor_can_be_deleted_returns_ok_response.yaml

@@ -1,9 +1,9 @@
 interactions:
 - request:
-    body: '{"message":"some message Notify: @hipchat-channel","name":"Test-Check_if_a_monitor_can_be_deleted_returns_OK_response-1641430253","options":{"enable_logs_sample":true,"escalation_message":"the
-      situation has escalated","evaluation_delay":700,"groupby_simple_monitor":true,"include_tags":true,"locked":false,"new_host_delay":600,"no_data_timeframe":null,"notify_audit":false,"notify_no_data":false,"renotify_interval":60,"require_full_window":true,"thresholds":{"critical":2,"warning":1},"timeout_h":24},"priority":3,"query":"logs(\"service:foo
+    body: '{"message":"some message Notify: @hipchat-channel","name":"Test-Check_if_a_monitor_can_be_deleted_returns_OK_response-1660586681","options":{"enable_logs_sample":true,"escalation_message":"the
+      situation has escalated","evaluation_delay":700,"groupby_simple_monitor":true,"include_tags":true,"locked":false,"new_host_delay":600,"no_data_timeframe":null,"notify_audit":false,"notify_no_data":false,"on_missing_data":"show_and_notify_no_data","renotify_interval":60,"require_full_window":true,"thresholds":{"critical":2,"warning":1},"timeout_h":24},"priority":3,"query":"logs(\"service:foo
       AND type:error\").index(\"main\").rollup(\"count\").by(\"source\").last(\"5m\")
-      > 2","tags":["test:testcheckifamonitorcanbedeletedreturnsokresponse1641430253","env:ci"],"type":"log
+      > 2","tags":["test:testcheckifamonitorcanbedeletedreturnsokresponse1660586681","env:ci"],"type":"log
       alert"}'
     headers:
       accept:
@@ -14,11 +14,11 @@ interactions:
     uri: https://api.datadoghq.com/api/v1/monitor
   response:
     body:
-      string: '{"restricted_roles":null,"tags":["test:testcheckifamonitorcanbedeletedreturnsokresponse1641430253","env:ci"],"deleted":null,"query":"logs(\"service:foo
+      string: '{"restricted_roles":null,"tags":["test:testcheckifamonitorcanbedeletedreturnsokresponse1660586681","env:ci"],"deleted":null,"query":"logs(\"service:foo
         AND type:error\").index(\"main\").rollup(\"count\").by(\"source\").last(\"5m\")
-        > 2","message":"some message Notify: @hipchat-channel","id":59800600,"multi":true,"name":"Test-Check_if_a_monitor_can_be_deleted_returns_OK_response-1641430253","created":"2022-01-06T00:50:53.280971+00:00","created_at":1641430253000,"creator":{"id":1445416,"handle":"[email protected]","name":null,"email":"[email protected]"},"org_id":321813,"modified":"2022-01-06T00:50:53.280971+00:00","priority":3,"overall_state_modified":null,"overall_state":"No
-        Data","type":"log alert","options":{"notify_audit":false,"locked":false,"timeout_h":24,"renotify_interval":60,"include_tags":true,"no_data_timeframe":null,"silenced":{},"new_host_delay":600,"require_full_window":true,"notify_no_data":false,"enable_logs_sample":true,"groupby_simple_monitor":true,"escalation_message":"the
-        situation has escalated","evaluation_delay":700,"thresholds":{"critical":2,"warning":1}}}'
+        > 2","message":"some message Notify: @hipchat-channel","id":80119046,"multi":true,"name":"Test-Check_if_a_monitor_can_be_deleted_returns_OK_response-1660586681","created":"2022-08-15T18:04:41.951170+00:00","created_at":1660586681000,"creator":{"id":1445416,"handle":"[email protected]","name":null,"email":"[email protected]"},"org_id":321813,"modified":"2022-08-15T18:04:41.951170+00:00","priority":3,"overall_state_modified":null,"overall_state":"No
+        Data","type":"log alert","options":{"notify_audit":false,"locked":false,"timeout_h":24,"renotify_interval":60,"include_tags":true,"no_data_timeframe":null,"silenced":{},"new_host_delay":600,"on_missing_data":"show_and_notify_no_data","require_full_window":true,"notify_no_data":false,"enable_logs_sample":true,"groupby_simple_monitor":true,"escalation_message":"the
+        situation has escalated","evaluation_delay":700,"thresholds":{"critical":2.0,"warning":1.0}}}'
     headers:
       content-type:
       - application/json
@@ -31,10 +31,10 @@ interactions:
       accept:
       - application/json
     method: GET
-    uri: https://api.datadoghq.com/api/v1/monitor/can_delete?monitor_ids=59800600
+    uri: https://api.datadoghq.com/api/v1/monitor/can_delete?monitor_ids=80119046
   response:
     body:
-      string: '{"errors":null,"data":{"ok":[59800600]}}'
+      string: '{"errors":null,"data":{"ok":[80119046]}}'
     headers:
       content-type:
       - application/json
@@ -47,10 +47,10 @@ interactions:
       accept:
       - application/json
     method: DELETE
-    uri: https://api.datadoghq.com/api/v1/monitor/59800600
+    uri: https://api.datadoghq.com/api/v1/monitor/80119046
   response:
     body:
-      string: '{"deleted_monitor_id":59800600}'
+      string: '{"deleted_monitor_id":80119046}'
     headers:
       content-type:
       - application/json

tests/v1/cassettes/test_scenarios/test_create_a_new_dashboard_with_alert_graph_widget.frozen

@@ -1 +1 @@
-2022-01-06T00:50:25.975Z
+2022-08-15T18:04:35.875Z