Add Observability Pipelines Amazon S3 Generic destination (#3697)

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

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

.generator/schemas/v2/openapi.yaml

@@ -42075,6 +42075,191 @@ components:
       type: string
       x-enum-varnames:
       - AMAZON_S3
+    ObservabilityPipelineAmazonS3GenericBatchSettings:
+      description: Event batching settings
+      properties:
+        batch_size:
+          description: Maximum batch size in bytes.
+          example: 100000000
+          format: int64
+          type: integer
+        timeout_secs:
+          description: Maximum number of seconds to wait before flushing the batch.
+          example: 900
+          format: int64
+          type: integer
+      type: object
+    ObservabilityPipelineAmazonS3GenericCompression:
+      description: Compression algorithm applied to encoded logs.
+      oneOf:
+      - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionZstd'
+      - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionGzip'
+      - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionSnappy'
+    ObservabilityPipelineAmazonS3GenericCompressionGzip:
+      description: Gzip compression.
+      properties:
+        algorithm:
+          $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionGzipType'
+        level:
+          description: Gzip compression level.
+          example: 6
+          format: int64
+          type: integer
+      required:
+      - algorithm
+      - level
+      type: object
+    ObservabilityPipelineAmazonS3GenericCompressionGzipType:
+      default: gzip
+      description: The compression type. Always `gzip`.
+      enum:
+      - gzip
+      example: gzip
+      type: string
+      x-enum-varnames:
+      - GZIP
+    ObservabilityPipelineAmazonS3GenericCompressionSnappy:
+      description: Snappy compression.
+      properties:
+        algorithm:
+          $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionSnappyType'
+      required:
+      - algorithm
+      type: object
+    ObservabilityPipelineAmazonS3GenericCompressionSnappyType:
+      default: snappy
+      description: The compression type. Always `snappy`.
+      enum:
+      - snappy
+      example: snappy
+      type: string
+      x-enum-varnames:
+      - SNAPPY
+    ObservabilityPipelineAmazonS3GenericCompressionZstd:
+      description: Zstd compression.
+      properties:
+        algorithm:
+          $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionZstdType'
+        level:
+          description: Zstd compression level.
+          example: 3
+          format: int64
+          type: integer
+      required:
+      - algorithm
+      - level
+      type: object
+    ObservabilityPipelineAmazonS3GenericCompressionZstdType:
+      default: zstd
+      description: The compression type. Always `zstd`.
+      enum:
+      - zstd
+      example: zstd
+      type: string
+      x-enum-varnames:
+      - ZSTD
+    ObservabilityPipelineAmazonS3GenericDestination:
+      description: 'The `amazon_s3_generic` destination sends your logs to an Amazon
+        S3 bucket.
+
+
+        **Supported pipeline types:** logs'
+      properties:
+        auth:
+          $ref: '#/components/schemas/ObservabilityPipelineAwsAuth'
+        batch_settings:
+          $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericBatchSettings'
+        bucket:
+          description: S3 bucket name.
+          example: my-bucket
+          type: string
+        compression:
+          $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompression'
+        encoding:
+          $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncoding'
+        id:
+          description: Unique identifier for the destination component.
+          example: generic-s3-destination
+          type: string
+        inputs:
+          description: A list of component IDs whose output is used as the `input`
+            for this component.
+          example:
+          - filter-processor
+          items:
+            type: string
+          type: array
+        key_prefix:
+          description: Optional prefix for object keys.
+          type: string
+        region:
+          description: AWS region of the S3 bucket.
+          example: us-east-1
+          type: string
+        storage_class:
+          $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationStorageClass'
+        type:
+          $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericDestinationType'
+      required:
+      - id
+      - type
+      - inputs
+      - bucket
+      - region
+      - storage_class
+      - encoding
+      - compression
+      type: object
+      x-pipeline-types:
+      - logs
+    ObservabilityPipelineAmazonS3GenericDestinationType:
+      default: amazon_s3_generic
+      description: The destination type. Always `amazon_s3_generic`.
+      enum:
+      - amazon_s3_generic
+      example: amazon_s3_generic
+      type: string
+      x-enum-varnames:
+      - GENERIC_ARCHIVES_S3
+    ObservabilityPipelineAmazonS3GenericEncoding:
+      description: Encoding format for the destination.
+      oneOf:
+      - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingJson'
+      - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingParquet'
+    ObservabilityPipelineAmazonS3GenericEncodingJson:
+      description: JSON encoding.
+      properties:
+        type:
+          $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingJsonType'
+      required:
+      - type
+      type: object
+    ObservabilityPipelineAmazonS3GenericEncodingJsonType:
+      default: json
+      description: The encoding type. Always `json`.
+      enum:
+      - json
+      example: json
+      type: string
+      x-enum-varnames:
+      - JSON
+    ObservabilityPipelineAmazonS3GenericEncodingParquet:
+      description: Parquet encoding.
+      properties:
+        type:
+          $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingParquetType'
+      required:
+      - type
+      type: object
+    ObservabilityPipelineAmazonS3GenericEncodingParquetType:
+      default: parquet
+      description: The encoding type. Always `parquet`.
+      enum:
+      - parquet
+      example: parquet
+      type: string
+      x-enum-varnames:
+      - PARQUET
     ObservabilityPipelineAmazonS3Source:
       description: 'The `amazon_s3` source ingests logs from an Amazon S3 bucket.
 
@@ -42350,6 +42535,7 @@ components:
       - $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestination'
       - $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination'
       - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3Destination'
+      - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericDestination'
       - $ref: '#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestination'
       - $ref: '#/components/schemas/AzureStorageDestination'
       - $ref: '#/components/schemas/ObservabilityPipelineCloudPremDestination'

services/observability_pipelines/src/v2/index.ts

@@ -32,6 +32,21 @@ export { ObservabilityPipelineAmazonOpenSearchDestinationType } from "./models/O
 export { ObservabilityPipelineAmazonS3Destination } from "./models/ObservabilityPipelineAmazonS3Destination";
 export { ObservabilityPipelineAmazonS3DestinationStorageClass } from "./models/ObservabilityPipelineAmazonS3DestinationStorageClass";
 export { ObservabilityPipelineAmazonS3DestinationType } from "./models/ObservabilityPipelineAmazonS3DestinationType";
+export { ObservabilityPipelineAmazonS3GenericBatchSettings } from "./models/ObservabilityPipelineAmazonS3GenericBatchSettings";
+export { ObservabilityPipelineAmazonS3GenericCompression } from "./models/ObservabilityPipelineAmazonS3GenericCompression";
+export { ObservabilityPipelineAmazonS3GenericCompressionGzip } from "./models/ObservabilityPipelineAmazonS3GenericCompressionGzip";
+export { ObservabilityPipelineAmazonS3GenericCompressionGzipType } from "./models/ObservabilityPipelineAmazonS3GenericCompressionGzipType";
+export { ObservabilityPipelineAmazonS3GenericCompressionSnappy } from "./models/ObservabilityPipelineAmazonS3GenericCompressionSnappy";
+export { ObservabilityPipelineAmazonS3GenericCompressionSnappyType } from "./models/ObservabilityPipelineAmazonS3GenericCompressionSnappyType";
+export { ObservabilityPipelineAmazonS3GenericCompressionZstd } from "./models/ObservabilityPipelineAmazonS3GenericCompressionZstd";
+export { ObservabilityPipelineAmazonS3GenericCompressionZstdType } from "./models/ObservabilityPipelineAmazonS3GenericCompressionZstdType";
+export { ObservabilityPipelineAmazonS3GenericDestination } from "./models/ObservabilityPipelineAmazonS3GenericDestination";
+export { ObservabilityPipelineAmazonS3GenericDestinationType } from "./models/ObservabilityPipelineAmazonS3GenericDestinationType";
+export { ObservabilityPipelineAmazonS3GenericEncoding } from "./models/ObservabilityPipelineAmazonS3GenericEncoding";
+export { ObservabilityPipelineAmazonS3GenericEncodingJson } from "./models/ObservabilityPipelineAmazonS3GenericEncodingJson";
+export { ObservabilityPipelineAmazonS3GenericEncodingJsonType } from "./models/ObservabilityPipelineAmazonS3GenericEncodingJsonType";
+export { ObservabilityPipelineAmazonS3GenericEncodingParquet } from "./models/ObservabilityPipelineAmazonS3GenericEncodingParquet";
+export { ObservabilityPipelineAmazonS3GenericEncodingParquetType } from "./models/ObservabilityPipelineAmazonS3GenericEncodingParquetType";
 export { ObservabilityPipelineAmazonS3Source } from "./models/ObservabilityPipelineAmazonS3Source";
 export { ObservabilityPipelineAmazonS3SourceType } from "./models/ObservabilityPipelineAmazonS3SourceType";
 export { ObservabilityPipelineAmazonSecurityLakeDestination } from "./models/ObservabilityPipelineAmazonSecurityLakeDestination";

services/observability_pipelines/src/v2/models/ObservabilityPipelineAmazonS3GenericBatchSettings.ts

@@ -0,0 +1,54 @@
+import { AttributeTypeMap } from "@datadog/datadog-api-client";
+
+/**
+ * Event batching settings
+ */
+export class ObservabilityPipelineAmazonS3GenericBatchSettings {
+  /**
+   * Maximum batch size in bytes.
+   */
+  "batchSize"?: number;
+  /**
+   * Maximum number of seconds to wait before flushing the batch.
+   */
+  "timeoutSecs"?: number;
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    batchSize: {
+      baseName: "batch_size",
+      type: "number",
+      format: "int64",
+    },
+    timeoutSecs: {
+      baseName: "timeout_secs",
+      type: "number",
+      format: "int64",
+    },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "{ [key: string]: any; }",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return ObservabilityPipelineAmazonS3GenericBatchSettings.attributeTypeMap;
+  }
+
+  public constructor() {}
+}

services/observability_pipelines/src/v2/models/ObservabilityPipelineAmazonS3GenericCompression.ts

@@ -0,0 +1,14 @@
+import { UnparsedObject } from "@datadog/datadog-api-client";
+
+import { ObservabilityPipelineAmazonS3GenericCompressionGzip } from "./ObservabilityPipelineAmazonS3GenericCompressionGzip";
+import { ObservabilityPipelineAmazonS3GenericCompressionSnappy } from "./ObservabilityPipelineAmazonS3GenericCompressionSnappy";
+import { ObservabilityPipelineAmazonS3GenericCompressionZstd } from "./ObservabilityPipelineAmazonS3GenericCompressionZstd";
+
+/**
+ * Compression algorithm applied to encoded logs.
+ */
+export type ObservabilityPipelineAmazonS3GenericCompression =
+  | ObservabilityPipelineAmazonS3GenericCompressionZstd
+  | ObservabilityPipelineAmazonS3GenericCompressionGzip
+  | ObservabilityPipelineAmazonS3GenericCompressionSnappy
+  | UnparsedObject;

services/observability_pipelines/src/v2/models/ObservabilityPipelineAmazonS3GenericCompressionGzip.ts

@@ -0,0 +1,57 @@
+import { AttributeTypeMap } from "@datadog/datadog-api-client";
+
+import { ObservabilityPipelineAmazonS3GenericCompressionGzipType } from "./ObservabilityPipelineAmazonS3GenericCompressionGzipType";
+
+/**
+ * Gzip compression.
+ */
+export class ObservabilityPipelineAmazonS3GenericCompressionGzip {
+  /**
+   * The compression type. Always `gzip`.
+   */
+  "algorithm": ObservabilityPipelineAmazonS3GenericCompressionGzipType;
+  /**
+   * Gzip compression level.
+   */
+  "level": number;
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    algorithm: {
+      baseName: "algorithm",
+      type: "ObservabilityPipelineAmazonS3GenericCompressionGzipType",
+      required: true,
+    },
+    level: {
+      baseName: "level",
+      type: "number",
+      required: true,
+      format: "int64",
+    },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "{ [key: string]: any; }",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return ObservabilityPipelineAmazonS3GenericCompressionGzip.attributeTypeMap;
+  }
+
+  public constructor() {}
+}

services/observability_pipelines/src/v2/models/ObservabilityPipelineAmazonS3GenericCompressionGzipType.ts

@@ -0,0 +1,9 @@
+import { UnparsedObject } from "@datadog/datadog-api-client";
+
+/**
+ * The compression type. Always `gzip`.
+ */
+export type ObservabilityPipelineAmazonS3GenericCompressionGzipType =
+  | typeof GZIP
+  | UnparsedObject;
+export const GZIP = "gzip";