Add daily limit reset options to logs indexes api (#1842)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 61a5d213e844 · 2024-01-22T19:33:07.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-01-19 16:38:24.372553",
-            "spec_repo_commit": "80f33fd7"
+            "regenerated": "2024-01-22 19:09:10.417108",
+            "spec_repo_commit": "7def3c63"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-01-19 16:38:24.402441",
-            "spec_repo_commit": "80f33fd7"
+            "regenerated": "2024-01-22 19:09:10.431037",
+            "spec_repo_commit": "7def3c63"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -5193,6 +5193,21 @@ components:
       type: string
       x-enum-varnames:
       - CATEGORY_PROCESSOR
+    LogsDailyLimitReset:
+      description: Object containing options to override the default daily limit reset
+        time.
+      properties:
+        reset_time:
+          description: String in `HH:00` format representing the time of day the daily
+            limit should be reset. The hours must be between 00 and 23 (inclusive).
+          example: '14:00'
+          type: string
+        reset_utc_offset:
+          description: String in `(-|+)HH:00` format representing the UTC offset to
+            apply to the given reset time. The hours must be between -12 and +14 (inclusive).
+          example: +02:00
+          type: string
+      type: object
     LogsDateRemapper:
       description: "As Datadog receives logs, it timestamps them using the value(s)
         from any of these default attributes.\n\n  - `timestamp`\n  - `date`\n  -
@@ -5407,6 +5422,16 @@ components:
           example: 300000000
           format: int64
           type: integer
+        daily_limit_reset:
+          $ref: '#/components/schemas/LogsDailyLimitReset'
+        daily_limit_warning_threshold_percentage:
+          description: A percentage threshold of the daily quota at which a Datadog
+            warning event is generated.
+          example: 70
+          format: double
+          maximum: 99.99
+          minimum: 50
+          type: number
         exclusion_filters:
           description: 'An array of exclusion objects. The logs are tested against
             the query of each filter,
@@ -5462,6 +5487,16 @@ components:
           example: 300000000
           format: int64
           type: integer
+        daily_limit_reset:
+          $ref: '#/components/schemas/LogsDailyLimitReset'
+        daily_limit_warning_threshold_percentage:
+          description: A percentage threshold of the daily quota at which a Datadog
+            warning event is generated.
+          example: 70
+          format: double
+          maximum: 99.99
+          minimum: 50
+          type: number
         disable_daily_limit:
           description: 'If true, sets the `daily_limit` value to null and the index
             is not limited on a daily basis (any
diff --git a/docs/datadog_api_client.v1.model.rst b/docs/datadog_api_client.v1.model.rst
@@ -1618,6 +1618,13 @@ logs\_category\_processor\_type
    :members:
    :show-inheritance:
 
+logs\_daily\_limit\_reset
+-------------------------
+
+.. automodule:: datadog_api_client.v1.model.logs_daily_limit_reset
+   :members:
+   :show-inheritance:
+
 logs\_date\_remapper
 --------------------
 
diff --git a/examples/v1/logs-indexes/CreateLogsIndex.py b/examples/v1/logs-indexes/CreateLogsIndex.py
@@ -4,13 +4,19 @@
 
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v1.api.logs_indexes_api import LogsIndexesApi
+from datadog_api_client.v1.model.logs_daily_limit_reset import LogsDailyLimitReset
 from datadog_api_client.v1.model.logs_exclusion import LogsExclusion
 from datadog_api_client.v1.model.logs_exclusion_filter import LogsExclusionFilter
 from datadog_api_client.v1.model.logs_filter import LogsFilter
 from datadog_api_client.v1.model.logs_index import LogsIndex
 
 body = LogsIndex(
     daily_limit=300000000,
+    daily_limit_reset=LogsDailyLimitReset(
+        reset_time="14:00",
+        reset_utc_offset="+02:00",
+    ),
+    daily_limit_warning_threshold_percentage=70.0,
     exclusion_filters=[
         LogsExclusion(
             filter=LogsExclusionFilter(
diff --git a/examples/v1/logs-indexes/UpdateLogsIndex.py b/examples/v1/logs-indexes/UpdateLogsIndex.py
@@ -4,13 +4,19 @@
 
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v1.api.logs_indexes_api import LogsIndexesApi
+from datadog_api_client.v1.model.logs_daily_limit_reset import LogsDailyLimitReset
 from datadog_api_client.v1.model.logs_exclusion import LogsExclusion
 from datadog_api_client.v1.model.logs_exclusion_filter import LogsExclusionFilter
 from datadog_api_client.v1.model.logs_filter import LogsFilter
 from datadog_api_client.v1.model.logs_index_update_request import LogsIndexUpdateRequest
 
 body = LogsIndexUpdateRequest(
     daily_limit=300000000,
+    daily_limit_reset=LogsDailyLimitReset(
+        reset_time="14:00",
+        reset_utc_offset="+02:00",
+    ),
+    daily_limit_warning_threshold_percentage=70.0,
     disable_daily_limit=False,
     exclusion_filters=[
         LogsExclusion(
diff --git a/src/datadog_api_client/v1/model/logs_daily_limit_reset.py b/src/datadog_api_client/v1/model/logs_daily_limit_reset.py
@@ -0,0 +1,45 @@
+# 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 Union
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+class LogsDailyLimitReset(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        return {
+            "reset_time": (str,),
+            "reset_utc_offset": (str,),
+        }
+
+    attribute_map = {
+        "reset_time": "reset_time",
+        "reset_utc_offset": "reset_utc_offset",
+    }
+
+    def __init__(
+        self_, reset_time: Union[str, UnsetType] = unset, reset_utc_offset: Union[str, UnsetType] = unset, **kwargs
+    ):
+        """
+        Object containing options to override the default daily limit reset time.
+
+        :param reset_time: String in ``HH:00`` format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive).
+        :type reset_time: str, optional
+
+        :param reset_utc_offset: String in ``(-|+)HH:00`` format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive).
+        :type reset_utc_offset: str, optional
+        """
+        if reset_time is not unset:
+            kwargs["reset_time"] = reset_time
+        if reset_utc_offset is not unset:
+            kwargs["reset_utc_offset"] = reset_utc_offset
+        super().__init__(kwargs)
diff --git a/src/datadog_api_client/v1/model/logs_index.py b/src/datadog_api_client/v1/model/logs_index.py
@@ -14,18 +14,29 @@
 
 
 if TYPE_CHECKING:
+    from datadog_api_client.v1.model.logs_daily_limit_reset import LogsDailyLimitReset
     from datadog_api_client.v1.model.logs_exclusion import LogsExclusion
     from datadog_api_client.v1.model.logs_filter import LogsFilter
 
 
 class LogsIndex(ModelNormal):
+    validations = {
+        "daily_limit_warning_threshold_percentage": {
+            "inclusive_maximum": 99.99,
+            "inclusive_minimum": 50,
+        },
+    }
+
     @cached_property
     def openapi_types(_):
+        from datadog_api_client.v1.model.logs_daily_limit_reset import LogsDailyLimitReset
         from datadog_api_client.v1.model.logs_exclusion import LogsExclusion
         from datadog_api_client.v1.model.logs_filter import LogsFilter
 
         return {
             "daily_limit": (int,),
+            "daily_limit_reset": (LogsDailyLimitReset,),
+            "daily_limit_warning_threshold_percentage": (float,),
             "exclusion_filters": ([LogsExclusion],),
             "filter": (LogsFilter,),
             "is_rate_limited": (bool,),
@@ -35,6 +46,8 @@ def openapi_types(_):
 
     attribute_map = {
         "daily_limit": "daily_limit",
+        "daily_limit_reset": "daily_limit_reset",
+        "daily_limit_warning_threshold_percentage": "daily_limit_warning_threshold_percentage",
         "exclusion_filters": "exclusion_filters",
         "filter": "filter",
         "is_rate_limited": "is_rate_limited",
@@ -50,6 +63,8 @@ def __init__(
         filter: LogsFilter,
         name: str,
         daily_limit: Union[int, UnsetType] = unset,
+        daily_limit_reset: Union[LogsDailyLimitReset, UnsetType] = unset,
+        daily_limit_warning_threshold_percentage: Union[float, UnsetType] = unset,
         exclusion_filters: Union[List[LogsExclusion], UnsetType] = unset,
         is_rate_limited: Union[bool, UnsetType] = unset,
         num_retention_days: Union[int, UnsetType] = unset,
@@ -61,6 +76,12 @@ def __init__(
         :param daily_limit: The number of log events you can send in this index per day before you are rate-limited.
         :type daily_limit: int, optional
 
+        :param daily_limit_reset: Object containing options to override the default daily limit reset time.
+        :type daily_limit_reset: LogsDailyLimitReset, optional
+
+        :param daily_limit_warning_threshold_percentage: A percentage threshold of the daily quota at which a Datadog warning event is generated.
+        :type daily_limit_warning_threshold_percentage: float, optional
+
         :param exclusion_filters: An array of exclusion objects. The logs are tested against the query of each filter,
             following the order of the array. Only the first matching active exclusion matters,
             others (if any) are ignored.
@@ -82,6 +103,10 @@ def __init__(
         """
         if daily_limit is not unset:
             kwargs["daily_limit"] = daily_limit
+        if daily_limit_reset is not unset:
+            kwargs["daily_limit_reset"] = daily_limit_reset
+        if daily_limit_warning_threshold_percentage is not unset:
+            kwargs["daily_limit_warning_threshold_percentage"] = daily_limit_warning_threshold_percentage
         if exclusion_filters is not unset:
             kwargs["exclusion_filters"] = exclusion_filters
         if is_rate_limited is not unset:
diff --git a/src/datadog_api_client/v1/model/logs_index_update_request.py b/src/datadog_api_client/v1/model/logs_index_update_request.py
@@ -14,18 +14,29 @@
 
 
 if TYPE_CHECKING:
+    from datadog_api_client.v1.model.logs_daily_limit_reset import LogsDailyLimitReset
     from datadog_api_client.v1.model.logs_exclusion import LogsExclusion
     from datadog_api_client.v1.model.logs_filter import LogsFilter
 
 
 class LogsIndexUpdateRequest(ModelNormal):
+    validations = {
+        "daily_limit_warning_threshold_percentage": {
+            "inclusive_maximum": 99.99,
+            "inclusive_minimum": 50,
+        },
+    }
+
     @cached_property
     def openapi_types(_):
+        from datadog_api_client.v1.model.logs_daily_limit_reset import LogsDailyLimitReset
         from datadog_api_client.v1.model.logs_exclusion import LogsExclusion
         from datadog_api_client.v1.model.logs_filter import LogsFilter
 
         return {
             "daily_limit": (int,),
+            "daily_limit_reset": (LogsDailyLimitReset,),
+            "daily_limit_warning_threshold_percentage": (float,),
             "disable_daily_limit": (bool,),
             "exclusion_filters": ([LogsExclusion],),
             "filter": (LogsFilter,),
@@ -34,6 +45,8 @@ def openapi_types(_):
 
     attribute_map = {
         "daily_limit": "daily_limit",
+        "daily_limit_reset": "daily_limit_reset",
+        "daily_limit_warning_threshold_percentage": "daily_limit_warning_threshold_percentage",
         "disable_daily_limit": "disable_daily_limit",
         "exclusion_filters": "exclusion_filters",
         "filter": "filter",
@@ -44,6 +57,8 @@ def __init__(
         self_,
         filter: LogsFilter,
         daily_limit: Union[int, UnsetType] = unset,
+        daily_limit_reset: Union[LogsDailyLimitReset, UnsetType] = unset,
+        daily_limit_warning_threshold_percentage: Union[float, UnsetType] = unset,
         disable_daily_limit: Union[bool, UnsetType] = unset,
         exclusion_filters: Union[List[LogsExclusion], UnsetType] = unset,
         num_retention_days: Union[int, UnsetType] = unset,
@@ -55,6 +70,12 @@ def __init__(
         :param daily_limit: The number of log events you can send in this index per day before you are rate-limited.
         :type daily_limit: int, optional
 
+        :param daily_limit_reset: Object containing options to override the default daily limit reset time.
+        :type daily_limit_reset: LogsDailyLimitReset, optional
+
+        :param daily_limit_warning_threshold_percentage: A percentage threshold of the daily quota at which a Datadog warning event is generated.
+        :type daily_limit_warning_threshold_percentage: float, optional
+
         :param disable_daily_limit: If true, sets the ``daily_limit`` value to null and the index is not limited on a daily basis (any
             specified ``daily_limit`` value in the request is ignored). If false or omitted, the index's current
             ``daily_limit`` is maintained.
@@ -77,6 +98,10 @@ def __init__(
         """
         if daily_limit is not unset:
             kwargs["daily_limit"] = daily_limit
+        if daily_limit_reset is not unset:
+            kwargs["daily_limit_reset"] = daily_limit_reset
+        if daily_limit_warning_threshold_percentage is not unset:
+            kwargs["daily_limit_warning_threshold_percentage"] = daily_limit_warning_threshold_percentage
         if disable_daily_limit is not unset:
             kwargs["disable_daily_limit"] = disable_daily_limit
         if exclusion_filters is not unset:
diff --git a/src/datadog_api_client/v1/models/__init__.py b/src/datadog_api_client/v1/models/__init__.py
@@ -263,6 +263,7 @@
 from datadog_api_client.v1.model.logs_category_processor import LogsCategoryProcessor
 from datadog_api_client.v1.model.logs_category_processor_category import LogsCategoryProcessorCategory
 from datadog_api_client.v1.model.logs_category_processor_type import LogsCategoryProcessorType
+from datadog_api_client.v1.model.logs_daily_limit_reset import LogsDailyLimitReset
 from datadog_api_client.v1.model.logs_date_remapper import LogsDateRemapper
 from datadog_api_client.v1.model.logs_date_remapper_type import LogsDateRemapperType
 from datadog_api_client.v1.model.logs_exclusion import LogsExclusion
@@ -1196,6 +1197,7 @@
     "LogsCategoryProcessor",
     "LogsCategoryProcessorCategory",
     "LogsCategoryProcessorType",
+    "LogsDailyLimitReset",
     "LogsDateRemapper",
     "LogsDateRemapperType",
     "LogsExclusion",
diff --git a/tests/v1/features/logs_indexes.feature b/tests/v1/features/logs_indexes.feature
@@ -12,14 +12,14 @@ Feature: Logs Indexes
   @generated @skip @team:DataDog/logs-backend
   Scenario: Create an index returns "Invalid Parameter Error" response
     Given new "CreateLogsIndex" request
-    And body with value {"daily_limit": 300000000, "exclusion_filters": [{"filter": {"query": "*", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "name": "main", "num_retention_days": 15}
+    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "exclusion_filters": [{"filter": {"query": "*", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "name": "main", "num_retention_days": 15}
     When the request is sent
     Then the response status is 400 Invalid Parameter Error
 
   @generated @skip @team:DataDog/logs-backend
   Scenario: Create an index returns "OK" response
     Given new "CreateLogsIndex" request
-    And body with value {"daily_limit": 300000000, "exclusion_filters": [{"filter": {"query": "*", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "name": "main", "num_retention_days": 15}
+    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "exclusion_filters": [{"filter": {"query": "*", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "name": "main", "num_retention_days": 15}
     When the request is sent
     Then the response status is 200 OK
 
@@ -53,15 +53,15 @@ Feature: Logs Indexes
   Scenario: Update an index returns "Invalid Parameter Error" response
     Given new "UpdateLogsIndex" request
     And request contains "name" parameter from "REPLACE.ME"
-    And body with value {"daily_limit": 300000000, "disable_daily_limit": false, "exclusion_filters": [{"filter": {"query": "*", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "num_retention_days": 15}
+    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "disable_daily_limit": false, "exclusion_filters": [{"filter": {"query": "*", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "num_retention_days": 15}
     When the request is sent
     Then the response status is 400 Invalid Parameter Error
 
   @generated @skip @team:DataDog/logs-backend
   Scenario: Update an index returns "OK" response
     Given new "UpdateLogsIndex" request
     And request contains "name" parameter from "REPLACE.ME"
-    And body with value {"daily_limit": 300000000, "disable_daily_limit": false, "exclusion_filters": [{"filter": {"query": "*", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "num_retention_days": 15}
+    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "disable_daily_limit": false, "exclusion_filters": [{"filter": {"query": "*", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "num_retention_days": 15}
     When the request is sent
     Then the response status is 200 OK
 

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.6",`
`7`		`- "regenerated": "2024-01-19 16:38:24.372553",`
`8`		`- "spec_repo_commit": "80f33fd7"`
	`7`	`+ "regenerated": "2024-01-22 19:09:10.417108",`
	`8`	`+ "spec_repo_commit": "7def3c63"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2024-01-19 16:38:24.402441",`
`13`		`- "spec_repo_commit": "80f33fd7"`
	`12`	`+ "regenerated": "2024-01-22 19:09:10.431037",`
	`13`	`+ "spec_repo_commit": "7def3c63"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`