Add num_flex_logs_retention_days field to logs_indexes api spec (#253)

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:57.005234",
-            "spec_repo_commit": "0857d88a"
+            "regenerated": "2024-08-27 12:12:32.673802",
+            "spec_repo_commit": "09daef2e"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-08-26 18:14:57.023212",
-            "spec_repo_commit": "0857d88a"
+            "regenerated": "2024-08-27 12:12:32.691295",
+            "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.rs

@@ -22,6 +22,7 @@ async fn main() {
     .daily_limit_warning_threshold_percentage(70.0 as f64)
     .exclusion_filters(vec![LogsExclusion::new("payment".to_string())
         .filter(LogsExclusionFilter::new(1.0).query("*".to_string()))])
+    .num_flex_logs_retention_days(360)
     .num_retention_days(15);
     let configuration = datadog::Configuration::new();
     let api = LogsIndexesAPI::with_config(configuration);

examples/v1_logs-indexes_UpdateLogsIndex.rs

@@ -20,6 +20,7 @@ async fn main() {
         .disable_daily_limit(false)
         .exclusion_filters(vec![LogsExclusion::new("payment".to_string())
             .filter(LogsExclusionFilter::new(1.0).query("*".to_string()))])
+        .num_flex_logs_retention_days(360)
         .num_retention_days(15);
     let configuration = datadog::Configuration::new();
     let api = LogsIndexesAPI::with_config(configuration);

src/datadogV1/model/model_logs_index.rs

@@ -35,8 +35,14 @@ pub struct LogsIndex {
     /// The name of the index.
     #[serde(rename = "name")]
     pub name: String,
-    /// 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.
+    #[serde(rename = "num_flex_logs_retention_days")]
+    pub num_flex_logs_retention_days: Option<i64>,
+    /// 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.
     #[serde(rename = "num_retention_days")]
     pub num_retention_days: Option<i64>,
     #[serde(flatten)]
@@ -56,6 +62,7 @@ impl LogsIndex {
             filter,
             is_rate_limited: None,
             name,
+            num_flex_logs_retention_days: None,
             num_retention_days: None,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
@@ -90,6 +97,11 @@ impl LogsIndex {
         self
     }
 
+    pub fn num_flex_logs_retention_days(mut self, value: i64) -> Self {
+        self.num_flex_logs_retention_days = Some(value);
+        self
+    }
+
     pub fn num_retention_days(mut self, value: i64) -> Self {
         self.num_retention_days = Some(value);
         self
@@ -130,6 +142,7 @@ impl<'de> Deserialize<'de> for LogsIndex {
                 let mut filter: Option<crate::datadogV1::model::LogsFilter> = None;
                 let mut is_rate_limited: Option<bool> = None;
                 let mut name: Option<String> = None;
+                let mut num_flex_logs_retention_days: Option<i64> = None;
                 let mut num_retention_days: Option<i64> = None;
                 let mut additional_properties: std::collections::BTreeMap<
                     String,
@@ -180,6 +193,13 @@ impl<'de> Deserialize<'de> for LogsIndex {
                         "name" => {
                             name = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
+                        "num_flex_logs_retention_days" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            num_flex_logs_retention_days =
+                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "num_retention_days" => {
                             if v.is_null() {
                                 continue;
@@ -205,6 +225,7 @@ impl<'de> Deserialize<'de> for LogsIndex {
                     filter,
                     is_rate_limited,
                     name,
+                    num_flex_logs_retention_days,
                     num_retention_days,
                     additional_properties,
                     _unparsed,

src/datadogV1/model/model_logs_index_update_request.rs

@@ -33,11 +33,18 @@ pub struct LogsIndexUpdateRequest {
     /// Filter for logs.
     #[serde(rename = "filter")]
     pub filter: crate::datadogV1::model::LogsFilter,
-    /// 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.
+    #[serde(rename = "num_flex_logs_retention_days")]
+    pub num_flex_logs_retention_days: Option<i64>,
+    /// 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.
     #[serde(rename = "num_retention_days")]
     pub num_retention_days: Option<i64>,
     #[serde(flatten)]
@@ -56,6 +63,7 @@ impl LogsIndexUpdateRequest {
             disable_daily_limit: None,
             exclusion_filters: None,
             filter,
+            num_flex_logs_retention_days: None,
             num_retention_days: None,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
@@ -90,6 +98,11 @@ impl LogsIndexUpdateRequest {
         self
     }
 
+    pub fn num_flex_logs_retention_days(mut self, value: i64) -> Self {
+        self.num_flex_logs_retention_days = Some(value);
+        self
+    }
+
     pub fn num_retention_days(mut self, value: i64) -> Self {
         self.num_retention_days = Some(value);
         self
@@ -129,6 +142,7 @@ impl<'de> Deserialize<'de> for LogsIndexUpdateRequest {
                 let mut exclusion_filters: Option<Vec<crate::datadogV1::model::LogsExclusion>> =
                     None;
                 let mut filter: Option<crate::datadogV1::model::LogsFilter> = None;
+                let mut num_flex_logs_retention_days: Option<i64> = None;
                 let mut num_retention_days: Option<i64> = None;
                 let mut additional_properties: std::collections::BTreeMap<
                     String,
@@ -176,6 +190,13 @@ impl<'de> Deserialize<'de> for LogsIndexUpdateRequest {
                         "filter" => {
                             filter = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
+                        "num_flex_logs_retention_days" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            num_flex_logs_retention_days =
+                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "num_retention_days" => {
                             if v.is_null() {
                                 continue;
@@ -199,6 +220,7 @@ impl<'de> Deserialize<'de> for LogsIndexUpdateRequest {
                     disable_daily_limit,
                     exclusion_filters,
                     filter,
+                    num_flex_logs_retention_days,
                     num_retention_days,
                     additional_properties,
                     _unparsed,

tests/scenarios/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