Add compression_method field to Log Archives (#4043)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

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

.generator/schemas/v2/openapi.yaml

@@ -41615,6 +41615,8 @@ components:
     LogsArchiveAttributes:
       description: The attributes associated with the archive.
       properties:
+        compression_method:
+          $ref: "#/components/schemas/LogsArchiveAttributesCompressionMethod"
         destination:
           $ref: "#/components/schemas/LogsArchiveDestination"
         include_tags:
@@ -41652,6 +41654,17 @@ components:
         - query
         - destination
       type: object
+    LogsArchiveAttributesCompressionMethod:
+      default: GZIP
+      description: The type of compression for the archive.
+      enum:
+        - GZIP
+        - ZSTD
+      example: GZIP
+      type: string
+      x-enum-varnames:
+        - GZIP
+        - ZSTD
     LogsArchiveCreateRequest:
       description: The logs archive.
       properties:
@@ -41661,6 +41674,8 @@ components:
     LogsArchiveCreateRequestAttributes:
       description: The attributes associated with the archive.
       properties:
+        compression_method:
+          $ref: "#/components/schemas/LogsArchiveAttributesCompressionMethod"
         destination:
           $ref: "#/components/schemas/LogsArchiveCreateRequestDestination"
         include_tags:
@@ -111745,6 +111760,7 @@ paths:
                 value:
                   data:
                     attributes:
+                      compression_method: GZIP
                       destination:
                         container: container-name
                         storage_account: account-name
@@ -111918,6 +111934,7 @@ paths:
                 value:
                   data:
                     attributes:
+                      compression_method: GZIP
                       destination:
                         container: container-name
                         storage_account: account-name

examples/v2/logs-archives/CreateLogsArchive.ts

@@ -11,6 +11,7 @@ const params: v2.LogsArchivesApiCreateLogsArchiveRequest = {
   body: {
     data: {
       attributes: {
+        compressionMethod: "GZIP",
         destination: {
           container: "container-name",
           integration: {

examples/v2/logs-archives/UpdateLogsArchive.ts

@@ -11,6 +11,7 @@ const params: v2.LogsArchivesApiUpdateLogsArchiveRequest = {
   body: {
     data: {
       attributes: {
+        compressionMethod: "GZIP",
         destination: {
           container: "container-name",
           integration: {

features/v2/logs_archives.feature

@@ -12,14 +12,14 @@ Feature: Logs Archives
   @generated @skip @team:DataDog/logs-backend @team:DataDog/logs-forwarding
   Scenario: Create an archive returns "Bad Request" response
     Given new "CreateLogsArchive" request
-    And body with value {"data": {"attributes": {"destination": {"container": "container-name", "integration": {"client_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa", "tenant_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa"}, "storage_account": "account-name", "type": "azure"}, "include_tags": false, "name": "Nginx Archive", "query": "source:nginx", "rehydration_max_scan_size_in_gb": 100, "rehydration_tags": ["team:intake", "team:app"]}, "type": "archives"}}
+    And body with value {"data": {"attributes": {"compression_method": "GZIP", "destination": {"container": "container-name", "integration": {"client_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa", "tenant_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa"}, "storage_account": "account-name", "type": "azure"}, "include_tags": false, "name": "Nginx Archive", "query": "source:nginx", "rehydration_max_scan_size_in_gb": 100, "rehydration_tags": ["team:intake", "team:app"]}, "type": "archives"}}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @generated @skip @team:DataDog/logs-backend @team:DataDog/logs-forwarding
   Scenario: Create an archive returns "OK" response
     Given new "CreateLogsArchive" request
-    And body with value {"data": {"attributes": {"destination": {"container": "container-name", "integration": {"client_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa", "tenant_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa"}, "storage_account": "account-name", "type": "azure"}, "include_tags": false, "name": "Nginx Archive", "query": "source:nginx", "rehydration_max_scan_size_in_gb": 100, "rehydration_tags": ["team:intake", "team:app"]}, "type": "archives"}}
+    And body with value {"data": {"attributes": {"compression_method": "GZIP", "destination": {"container": "container-name", "integration": {"client_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa", "tenant_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa"}, "storage_account": "account-name", "type": "azure"}, "include_tags": false, "name": "Nginx Archive", "query": "source:nginx", "rehydration_max_scan_size_in_gb": 100, "rehydration_tags": ["team:intake", "team:app"]}, "type": "archives"}}
     When the request is sent
     Then the response status is 200 OK
 
@@ -150,23 +150,23 @@ Feature: Logs Archives
   Scenario: Update an archive returns "Bad Request" response
     Given new "UpdateLogsArchive" request
     And request contains "archive_id" parameter from "REPLACE.ME"
-    And body with value {"data": {"attributes": {"destination": {"container": "container-name", "integration": {"client_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa", "tenant_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa"}, "storage_account": "account-name", "type": "azure"}, "include_tags": false, "name": "Nginx Archive", "query": "source:nginx", "rehydration_max_scan_size_in_gb": 100, "rehydration_tags": ["team:intake", "team:app"]}, "type": "archives"}}
+    And body with value {"data": {"attributes": {"compression_method": "GZIP", "destination": {"container": "container-name", "integration": {"client_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa", "tenant_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa"}, "storage_account": "account-name", "type": "azure"}, "include_tags": false, "name": "Nginx Archive", "query": "source:nginx", "rehydration_max_scan_size_in_gb": 100, "rehydration_tags": ["team:intake", "team:app"]}, "type": "archives"}}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @generated @skip @team:DataDog/logs-backend @team:DataDog/logs-forwarding
   Scenario: Update an archive returns "Not found" response
     Given new "UpdateLogsArchive" request
     And request contains "archive_id" parameter from "REPLACE.ME"
-    And body with value {"data": {"attributes": {"destination": {"container": "container-name", "integration": {"client_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa", "tenant_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa"}, "storage_account": "account-name", "type": "azure"}, "include_tags": false, "name": "Nginx Archive", "query": "source:nginx", "rehydration_max_scan_size_in_gb": 100, "rehydration_tags": ["team:intake", "team:app"]}, "type": "archives"}}
+    And body with value {"data": {"attributes": {"compression_method": "GZIP", "destination": {"container": "container-name", "integration": {"client_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa", "tenant_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa"}, "storage_account": "account-name", "type": "azure"}, "include_tags": false, "name": "Nginx Archive", "query": "source:nginx", "rehydration_max_scan_size_in_gb": 100, "rehydration_tags": ["team:intake", "team:app"]}, "type": "archives"}}
     When the request is sent
     Then the response status is 404 Not found
 
   @generated @skip @team:DataDog/logs-backend @team:DataDog/logs-forwarding
   Scenario: Update an archive returns "OK" response
     Given new "UpdateLogsArchive" request
     And request contains "archive_id" parameter from "REPLACE.ME"
-    And body with value {"data": {"attributes": {"destination": {"container": "container-name", "integration": {"client_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa", "tenant_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa"}, "storage_account": "account-name", "type": "azure"}, "include_tags": false, "name": "Nginx Archive", "query": "source:nginx", "rehydration_max_scan_size_in_gb": 100, "rehydration_tags": ["team:intake", "team:app"]}, "type": "archives"}}
+    And body with value {"data": {"attributes": {"compression_method": "GZIP", "destination": {"container": "container-name", "integration": {"client_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa", "tenant_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa"}, "storage_account": "account-name", "type": "azure"}, "include_tags": false, "name": "Nginx Archive", "query": "source:nginx", "rehydration_max_scan_size_in_gb": 100, "rehydration_tags": ["team:intake", "team:app"]}, "type": "archives"}}
     When the request is sent
     Then the response status is 200 OK
 

packages/datadog-api-client-v2/index.ts

@@ -3914,6 +3914,7 @@ export { LogsAggregateSortType } from "./models/LogsAggregateSortType";
 export { LogsAggregationFunction } from "./models/LogsAggregationFunction";
 export { LogsArchive } from "./models/LogsArchive";
 export { LogsArchiveAttributes } from "./models/LogsArchiveAttributes";
+export { LogsArchiveAttributesCompressionMethod } from "./models/LogsArchiveAttributesCompressionMethod";
 export { LogsArchiveCreateRequest } from "./models/LogsArchiveCreateRequest";
 export { LogsArchiveCreateRequestAttributes } from "./models/LogsArchiveCreateRequestAttributes";
 export { LogsArchiveCreateRequestDefinition } from "./models/LogsArchiveCreateRequestDefinition";

packages/datadog-api-client-v2/models/LogsArchiveAttributes.ts

@@ -3,6 +3,7 @@
  * This product includes software developed at Datadog (https://www.datadoghq.com/).
  * Copyright 2020-Present Datadog, Inc.
  */
+import { LogsArchiveAttributesCompressionMethod } from "./LogsArchiveAttributesCompressionMethod";
 import { LogsArchiveDestination } from "./LogsArchiveDestination";
 import { LogsArchiveState } from "./LogsArchiveState";
 
@@ -12,6 +13,10 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
  * The attributes associated with the archive.
  */
 export class LogsArchiveAttributes {
+  /**
+   * The type of compression for the archive.
+   */
+  "compressionMethod"?: LogsArchiveAttributesCompressionMethod;
   /**
    * An archive's destination.
    */
@@ -58,6 +63,10 @@ export class LogsArchiveAttributes {
    * @ignore
    */
   static readonly attributeTypeMap: AttributeTypeMap = {
+    compressionMethod: {
+      baseName: "compression_method",
+      type: "LogsArchiveAttributesCompressionMethod",
+    },
     destination: {
       baseName: "destination",
       type: "LogsArchiveDestination",

packages/datadog-api-client-v2/models/LogsArchiveAttributesCompressionMethod.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 2020-Present Datadog, Inc.
+ */
+
+import { UnparsedObject } from "../../datadog-api-client-common/util";
+
+/**
+ * The type of compression for the archive.
+ */
+
+export type LogsArchiveAttributesCompressionMethod =
+  | typeof GZIP
+  | typeof ZSTD
+  | UnparsedObject;
+export const GZIP = "GZIP";
+export const ZSTD = "ZSTD";

packages/datadog-api-client-v2/models/LogsArchiveCreateRequestAttributes.ts

@@ -3,6 +3,7 @@
  * This product includes software developed at Datadog (https://www.datadoghq.com/).
  * Copyright 2020-Present Datadog, Inc.
  */
+import { LogsArchiveAttributesCompressionMethod } from "./LogsArchiveAttributesCompressionMethod";
 import { LogsArchiveCreateRequestDestination } from "./LogsArchiveCreateRequestDestination";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
@@ -11,6 +12,10 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
  * The attributes associated with the archive.
  */
 export class LogsArchiveCreateRequestAttributes {
+  /**
+   * The type of compression for the archive.
+   */
+  "compressionMethod"?: LogsArchiveAttributesCompressionMethod;
   /**
    * An archive's destination.
    */
@@ -53,6 +58,10 @@ export class LogsArchiveCreateRequestAttributes {
    * @ignore
    */
   static readonly attributeTypeMap: AttributeTypeMap = {
+    compressionMethod: {
+      baseName: "compression_method",
+      type: "LogsArchiveAttributesCompressionMethod",
+    },
     destination: {
       baseName: "destination",
       type: "LogsArchiveCreateRequestDestination",

packages/datadog-api-client-v2/models/ObjectSerializer.ts

@@ -5009,6 +5009,7 @@ const enumsMap: { [key: string]: any[] } = {
     "avg",
     "median",
   ],
+  LogsArchiveAttributesCompressionMethod: ["GZIP", "ZSTD"],
   LogsArchiveDestinationAzureType: ["azure"],
   LogsArchiveDestinationGCSType: ["gcs"],
   LogsArchiveDestinationS3Type: ["s3"],