Add num_flex_logs_retention_days field to logs_indexes api spec (#1967)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-08-26 18:14:52.742428",
-            "spec_repo_commit": "0857d88a"
+            "regenerated": "2024-08-27 12:12:28.154237",
+            "spec_repo_commit": "09daef2e"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-08-26 18:14:52.760097",
-            "spec_repo_commit": "0857d88a"
+            "regenerated": "2024-08-27 12:12:28.172796",
+            "spec_repo_commit": "09daef2e"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -5576,11 +5576,27 @@ components:
           description: The name of the index.
           example: main
           type: string
+        num_flex_logs_retention_days:
+          description: 'The total number of days logs are stored in Standard and Flex
+            Tier before being deleted from the index.
+
+            If Standard Tier is enabled on this index, logs are first retained in
+            Standard Tier for the number of days specified through `num_retention_days`,
+
+            and then stored in Flex Tier until the number of days specified in `num_flex_logs_retention_days`
+            is reached.
+
+            The available values depend on retention plans specified in your organization''s
+            contract/subscriptions.'
+          example: 360
+          format: int64
+          type: integer
         num_retention_days:
-          description: 'The number of days before logs are deleted from this index.
-            Available values depend on
+          description: 'The number of days logs are stored in Standard Tier before
+            aging into the Flex Tier or being deleted from the index.
 
-            retention plans specified in your organization''s contract/subscriptions.'
+            The available values depend on retention plans specified in your organization''s
+            contract/subscriptions.'
           example: 15
           format: int64
           type: integer
@@ -5639,17 +5655,35 @@ components:
           type: array
         filter:
           $ref: '#/components/schemas/LogsFilter'
-        num_retention_days:
-          description: 'The number of days before logs are deleted from this index.
-            Available values depend on
+        num_flex_logs_retention_days:
+          description: 'The total number of days logs are stored in Standard and Flex
+            Tier before being deleted from the index.
+
+            If Standard Tier is enabled on this index, logs are first retained in
+            Standard Tier for the number of days specified through `num_retention_days`,
 
-            retention plans specified in your organization''s contract/subscriptions.
+            and then stored in Flex Tier until the number of days specified in `num_flex_logs_retention_days`
+            is reached.
+
+            The available values depend on retention plans specified in your organization''s
+            contract/subscriptions.
+
+
+            **Note**: Changing this value affects all logs already in this index.
+            It may also affect billing.'
+          example: 360
+          format: int64
+          type: integer
+        num_retention_days:
+          description: 'The number of days logs are stored in Standard Tier before
+            aging into the Flex Tier or being deleted from the index.
 
+            The available values depend on retention plans specified in your organization''s
+            contract/subscriptions.
 
-            **Note:** Changing the retention for an index adjusts the length of retention
-            for all logs
 
-            already in this index. It may also affect billing.'
+            **Note**: Changing this value affects all logs already in this index.
+            It may also affect billing.'
           example: 15
           format: int64
           type: integer

examples/v1/logs-indexes/CreateLogsIndex.rb

@@ -23,6 +23,7 @@
     query: "source:python",
   }),
   name: "main",
+  num_flex_logs_retention_days: 360,
   num_retention_days: 15,
 })
 p api_instance.create_logs_index(body)

examples/v1/logs-indexes/UpdateLogsIndex.rb

@@ -23,6 +23,7 @@
   filter: DatadogAPIClient::V1::LogsFilter.new({
     query: "source:python",
   }),
+  num_flex_logs_retention_days: 360,
   num_retention_days: 15,
 })
 p api_instance.update_logs_index("name", body)

features/v1/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, "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}
+    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_flex_logs_retention_days": 360, "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, "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}
+    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_flex_logs_retention_days": 360, "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, "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}
+    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_flex_logs_retention_days": 360, "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, "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}
+    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_flex_logs_retention_days": 360, "num_retention_days": 15}
     When the request is sent
     Then the response status is 200 OK
 

lib/datadog_api_client/v1/models/logs_index.rb

@@ -45,8 +45,14 @@ class LogsIndex
     # The name of the index.
     attr_reader :name
 
-    # The number of days before logs are deleted from this index. Available values depend on
-    # retention plans specified in your organization's contract/subscriptions.
+    # The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.
+    # If Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through `num_retention_days`,
+    # and then stored in Flex Tier until the number of days specified in `num_flex_logs_retention_days` is reached.
+    # The available values depend on retention plans specified in your organization's contract/subscriptions.
+    attr_accessor :num_flex_logs_retention_days
+
+    # The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.
+    # The available values depend on retention plans specified in your organization's contract/subscriptions.
     attr_accessor :num_retention_days
 
     attr_accessor :additional_properties
@@ -62,6 +68,7 @@ def self.attribute_map
         :'filter' => :'filter',
         :'is_rate_limited' => :'is_rate_limited',
         :'name' => :'name',
+        :'num_flex_logs_retention_days' => :'num_flex_logs_retention_days',
         :'num_retention_days' => :'num_retention_days'
       }
     end
@@ -77,6 +84,7 @@ def self.openapi_types
         :'filter' => :'LogsFilter',
         :'is_rate_limited' => :'Boolean',
         :'name' => :'String',
+        :'num_flex_logs_retention_days' => :'Integer',
         :'num_retention_days' => :'Integer'
       }
     end
@@ -129,6 +137,10 @@ def initialize(attributes = {})
         self.name = attributes[:'name']
       end
 
+      if attributes.key?(:'num_flex_logs_retention_days')
+        self.num_flex_logs_retention_days = attributes[:'num_flex_logs_retention_days']
+      end
+
       if attributes.key?(:'num_retention_days')
         self.num_retention_days = attributes[:'num_retention_days']
       end
@@ -211,6 +223,7 @@ def ==(o)
           filter == o.filter &&
           is_rate_limited == o.is_rate_limited &&
           name == o.name &&
+          num_flex_logs_retention_days == o.num_flex_logs_retention_days &&
           num_retention_days == o.num_retention_days
           additional_properties == o.additional_properties
     end
@@ -219,7 +232,7 @@ def ==(o)
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [daily_limit, daily_limit_reset, daily_limit_warning_threshold_percentage, exclusion_filters, filter, is_rate_limited, name, num_retention_days].hash
+      [daily_limit, daily_limit_reset, daily_limit_warning_threshold_percentage, exclusion_filters, filter, is_rate_limited, name, num_flex_logs_retention_days, num_retention_days].hash
     end
   end
 end

lib/datadog_api_client/v1/models/logs_index_update_request.rb

@@ -43,11 +43,18 @@ class LogsIndexUpdateRequest
     # Filter for logs.
     attr_reader :filter
 
-    # The number of days before logs are deleted from this index. Available values depend on
-    # retention plans specified in your organization's contract/subscriptions.
+    # The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.
+    # If Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through `num_retention_days`,
+    # and then stored in Flex Tier until the number of days specified in `num_flex_logs_retention_days` is reached.
+    # The available values depend on retention plans specified in your organization's contract/subscriptions.
     #
-    # **Note:** Changing the retention for an index adjusts the length of retention for all logs
-    # already in this index. It may also affect billing.
+    # **Note**: Changing this value affects all logs already in this index. It may also affect billing.
+    attr_accessor :num_flex_logs_retention_days
+
+    # The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.
+    # The available values depend on retention plans specified in your organization's contract/subscriptions.
+    #
+    # **Note**: Changing this value affects all logs already in this index. It may also affect billing.
     attr_accessor :num_retention_days
 
     attr_accessor :additional_properties
@@ -62,6 +69,7 @@ def self.attribute_map
         :'disable_daily_limit' => :'disable_daily_limit',
         :'exclusion_filters' => :'exclusion_filters',
         :'filter' => :'filter',
+        :'num_flex_logs_retention_days' => :'num_flex_logs_retention_days',
         :'num_retention_days' => :'num_retention_days'
       }
     end
@@ -76,6 +84,7 @@ def self.openapi_types
         :'disable_daily_limit' => :'Boolean',
         :'exclusion_filters' => :'Array<LogsExclusion>',
         :'filter' => :'LogsFilter',
+        :'num_flex_logs_retention_days' => :'Integer',
         :'num_retention_days' => :'Integer'
       }
     end
@@ -124,6 +133,10 @@ def initialize(attributes = {})
         self.filter = attributes[:'filter']
       end
 
+      if attributes.key?(:'num_flex_logs_retention_days')
+        self.num_flex_logs_retention_days = attributes[:'num_flex_logs_retention_days']
+      end
+
       if attributes.key?(:'num_retention_days')
         self.num_retention_days = attributes[:'num_retention_days']
       end
@@ -194,6 +207,7 @@ def ==(o)
           disable_daily_limit == o.disable_daily_limit &&
           exclusion_filters == o.exclusion_filters &&
           filter == o.filter &&
+          num_flex_logs_retention_days == o.num_flex_logs_retention_days &&
           num_retention_days == o.num_retention_days
           additional_properties == o.additional_properties
     end
@@ -202,7 +216,7 @@ def ==(o)
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [daily_limit, daily_limit_reset, daily_limit_warning_threshold_percentage, disable_daily_limit, exclusion_filters, filter, num_retention_days].hash
+      [daily_limit, daily_limit_reset, daily_limit_warning_threshold_percentage, disable_daily_limit, exclusion_filters, filter, num_flex_logs_retention_days, num_retention_days].hash
     end
   end
 end