Adding Buffer options to Observability Pipeline Destinations (DataDog#2981)

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

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

.generator/schemas/v2/openapi.yaml

@@ -6766,6 +6766,8 @@ components:
           description: Optional prefix for blobs written to the container.
           example: logs/
           type: string
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         container_name:
           description: The name of the Azure Blob Storage container to store logs
             in.
@@ -36391,6 +36393,8 @@ components:
 
         **Supported pipeline types:** logs'
       properties:
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         client_id:
           description: Azure AD client ID used for authentication.
           example: a1b2c3d4-5678-90ab-cdef-1234567890ab
@@ -38337,6 +38341,8 @@ components:
       properties:
         auth:
           $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuth'
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         bulk_index:
           description: The index to write logs to.
           example: logs-index
@@ -38418,6 +38424,8 @@ components:
           description: S3 bucket name.
           example: error-logs
           type: string
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         id:
           description: Unique identifier for the destination component.
           example: amazon-s3-destination
@@ -38539,6 +38547,8 @@ components:
           description: Name of the Amazon S3 bucket in Security Lake (3-63 characters).
           example: security-lake-bucket
           type: string
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         custom_source_name:
           description: Custom source name for the logs in Security Lake.
           example: my-custom-source
@@ -38598,6 +38608,39 @@ components:
             role session.
           type: string
       type: object
+    ObservabilityPipelineBufferOptions:
+      description: Configuration for buffer settings on destination components.
+      oneOf:
+      - $ref: '#/components/schemas/ObservabilityPipelineDiskBufferOptions'
+      - $ref: '#/components/schemas/ObservabilityPipelineMemoryBufferOptions'
+      - $ref: '#/components/schemas/ObservabilityPipelineMemoryBufferSizeOptions'
+    ObservabilityPipelineBufferOptionsDiskType:
+      default: disk
+      description: The type of the buffer that will be configured, a disk buffer.
+      enum:
+      - disk
+      type: string
+      x-enum-varnames:
+      - DISK
+    ObservabilityPipelineBufferOptionsMemoryType:
+      default: memory
+      description: The type of the buffer that will be configured, a memory buffer.
+      enum:
+      - memory
+      type: string
+      x-enum-varnames:
+      - MEMORY
+    ObservabilityPipelineBufferOptionsWhenFull:
+      default: block
+      description: Behavior when the buffer is full (block and stop accepting new
+        events, or drop new events)
+      enum:
+      - block
+      - drop_newest
+      type: string
+      x-enum-varnames:
+      - BLOCK
+      - DROP_NEWEST
     ObservabilityPipelineCloudPremDestination:
       description: 'The `cloud_prem` destination sends logs to Datadog CloudPrem.
 
@@ -38868,6 +38911,8 @@ components:
 
         **Supported pipeline types:** logs'
       properties:
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         compression:
           $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression'
         encoding:
@@ -39093,6 +39138,8 @@ components:
 
         **Supported pipeline types:** logs'
       properties:
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         id:
           description: The unique identifier for this component.
           example: datadog-logs-destination
@@ -39347,6 +39394,19 @@ components:
       type: string
       x-enum-varnames:
       - DEDUPE
+    ObservabilityPipelineDiskBufferOptions:
+      description: Options for configuring a disk buffer.
+      properties:
+        max_size:
+          description: Maximum size of the disk buffer.
+          example: 4096
+          format: int64
+          type: integer
+        type:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsDiskType'
+        when_full:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull'
+      type: object
     ObservabilityPipelineElasticsearchDestination:
       description: 'The `elasticsearch` destination writes logs to an Elasticsearch
         cluster.
@@ -39356,6 +39416,8 @@ components:
       properties:
         api_version:
           $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationApiVersion'
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         bulk_index:
           description: The index to write logs to in Elasticsearch.
           example: logs-index
@@ -39901,6 +39963,8 @@ components:
       properties:
         auth:
           $ref: '#/components/schemas/ObservabilityPipelineGcpAuth'
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         customer_id:
           description: The Google Chronicle customer ID.
           example: abcdefg123456789
@@ -39969,6 +40033,8 @@ components:
           description: Name of the GCS bucket.
           example: error-logs
           type: string
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         id:
           description: Unique identifier for the destination component.
           example: gcs-destination
@@ -40053,6 +40119,8 @@ components:
       properties:
         auth:
           $ref: '#/components/schemas/ObservabilityPipelineGcpAuth'
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         encoding:
           $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubDestinationEncoding'
         id:
@@ -40579,6 +40647,28 @@ components:
       type: string
       x-enum-varnames:
       - LOGSTASH
+    ObservabilityPipelineMemoryBufferOptions:
+      description: Options for configuring a memory buffer by byte size.
+      properties:
+        max_size:
+          description: Maximum size of the memory buffer.
+          example: 4096
+          format: int64
+          type: integer
+        type:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType'
+      type: object
+    ObservabilityPipelineMemoryBufferSizeOptions:
+      description: Options for configuring a memory buffer by queue length.
+      properties:
+        max_events:
+          description: Maximum events for the memory buffer.
+          example: 500
+          format: int64
+          type: integer
+        type:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType'
+      type: object
     ObservabilityPipelineMetadataEntry:
       description: A custom metadata entry.
       properties:
@@ -40701,6 +40791,8 @@ components:
 
         **Supported pipeline types:** logs'
       properties:
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         id:
           description: The unique identifier for this component.
           example: new-relic-destination
@@ -40847,6 +40939,8 @@ components:
 
         **Supported pipeline types:** logs'
       properties:
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         bulk_index:
           description: The index to write logs to.
           example: logs-index
@@ -41560,6 +41654,8 @@ components:
 
         **Supported pipeline types:** logs'
       properties:
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         id:
           description: The unique identifier for this component.
           example: rsyslog-destination
@@ -42065,6 +42161,8 @@ components:
 
         **Supported pipeline types:** logs'
       properties:
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         id:
           description: The unique identifier for this component.
           example: sentinelone-destination
@@ -42119,6 +42217,8 @@ components:
 
         **Supported pipeline types:** logs'
       properties:
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         encoding:
           $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationEncoding'
         framing:
@@ -42495,6 +42595,8 @@ components:
             If `false`, Splunk assigns the time the event was received.'
           example: true
           type: boolean
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         encoding:
           $ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestinationEncoding'
         id:
@@ -42619,6 +42721,8 @@ components:
 
         **Supported pipeline types:** logs'
       properties:
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         encoding:
           $ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestinationEncoding'
         header_custom_fields:
@@ -42732,6 +42836,8 @@ components:
 
         **Supported pipeline types:** logs'
       properties:
+        buffer:
+          $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
         id:
           description: The unique identifier for this component.
           example: syslog-ng-destination

lib/datadog_api_client/inflector.rb

@@ -3364,6 +3364,10 @@ def overrides
           "v2.observability_pipeline_amazon_security_lake_destination" => "ObservabilityPipelineAmazonSecurityLakeDestination",
           "v2.observability_pipeline_amazon_security_lake_destination_type" => "ObservabilityPipelineAmazonSecurityLakeDestinationType",
           "v2.observability_pipeline_aws_auth" => "ObservabilityPipelineAwsAuth",
+          "v2.observability_pipeline_buffer_options" => "ObservabilityPipelineBufferOptions",
+          "v2.observability_pipeline_buffer_options_disk_type" => "ObservabilityPipelineBufferOptionsDiskType",
+          "v2.observability_pipeline_buffer_options_memory_type" => "ObservabilityPipelineBufferOptionsMemoryType",
+          "v2.observability_pipeline_buffer_options_when_full" => "ObservabilityPipelineBufferOptionsWhenFull",
           "v2.observability_pipeline_cloud_prem_destination" => "ObservabilityPipelineCloudPremDestination",
           "v2.observability_pipeline_cloud_prem_destination_type" => "ObservabilityPipelineCloudPremDestinationType",
           "v2.observability_pipeline_config" => "ObservabilityPipelineConfig",
@@ -3397,6 +3401,7 @@ def overrides
           "v2.observability_pipeline_dedupe_processor" => "ObservabilityPipelineDedupeProcessor",
           "v2.observability_pipeline_dedupe_processor_mode" => "ObservabilityPipelineDedupeProcessorMode",
           "v2.observability_pipeline_dedupe_processor_type" => "ObservabilityPipelineDedupeProcessorType",
+          "v2.observability_pipeline_disk_buffer_options" => "ObservabilityPipelineDiskBufferOptions",
           "v2.observability_pipeline_elasticsearch_destination" => "ObservabilityPipelineElasticsearchDestination",
           "v2.observability_pipeline_elasticsearch_destination_api_version" => "ObservabilityPipelineElasticsearchDestinationApiVersion",
           "v2.observability_pipeline_elasticsearch_destination_data_stream" => "ObservabilityPipelineElasticsearchDestinationDataStream",
@@ -3463,6 +3468,8 @@ def overrides
           "v2.observability_pipeline_kafka_source_type" => "ObservabilityPipelineKafkaSourceType",
           "v2.observability_pipeline_logstash_source" => "ObservabilityPipelineLogstashSource",
           "v2.observability_pipeline_logstash_source_type" => "ObservabilityPipelineLogstashSourceType",
+          "v2.observability_pipeline_memory_buffer_options" => "ObservabilityPipelineMemoryBufferOptions",
+          "v2.observability_pipeline_memory_buffer_size_options" => "ObservabilityPipelineMemoryBufferSizeOptions",
           "v2.observability_pipeline_metadata_entry" => "ObservabilityPipelineMetadataEntry",
           "v2.observability_pipeline_metric_tags_processor" => "ObservabilityPipelineMetricTagsProcessor",
           "v2.observability_pipeline_metric_tags_processor_rule" => "ObservabilityPipelineMetricTagsProcessorRule",

lib/datadog_api_client/v2/models/azure_storage_destination.rb

@@ -26,6 +26,9 @@ class AzureStorageDestination
     # Optional prefix for blobs written to the container.
     attr_accessor :blob_prefix
 
+    # Configuration for buffer settings on destination components.
+    attr_accessor :buffer
+
     # The name of the Azure Blob Storage container to store logs in.
     attr_reader :container_name
 
@@ -45,6 +48,7 @@ class AzureStorageDestination
     def self.attribute_map
       {
         :'blob_prefix' => :'blob_prefix',
+        :'buffer' => :'buffer',
         :'container_name' => :'container_name',
         :'id' => :'id',
         :'inputs' => :'inputs',
@@ -57,6 +61,7 @@ def self.attribute_map
     def self.openapi_types
       {
         :'blob_prefix' => :'String',
+        :'buffer' => :'ObservabilityPipelineBufferOptions',
         :'container_name' => :'String',
         :'id' => :'String',
         :'inputs' => :'Array<String>',
@@ -86,6 +91,10 @@ def initialize(attributes = {})
         self.blob_prefix = attributes[:'blob_prefix']
       end
 
+      if attributes.key?(:'buffer')
+        self.buffer = attributes[:'buffer']
+      end
+
       if attributes.key?(:'container_name')
         self.container_name = attributes[:'container_name']
       end
@@ -183,6 +192,7 @@ def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           blob_prefix == o.blob_prefix &&
+          buffer == o.buffer &&
           container_name == o.container_name &&
           id == o.id &&
           inputs == o.inputs &&
@@ -194,7 +204,7 @@ def ==(o)
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [blob_prefix, container_name, id, inputs, type, additional_properties].hash
+      [blob_prefix, buffer, container_name, id, inputs, type, additional_properties].hash
     end
   end
 end

lib/datadog_api_client/v2/models/microsoft_sentinel_destination.rb

@@ -23,6 +23,9 @@ module DatadogAPIClient::V2
   class MicrosoftSentinelDestination
     include BaseGenericModel
 
+    # Configuration for buffer settings on destination components.
+    attr_accessor :buffer
+
     # Azure AD client ID used for authentication.
     attr_reader :client_id
 
@@ -50,6 +53,7 @@ class MicrosoftSentinelDestination
     # @!visibility private
     def self.attribute_map
       {
+        :'buffer' => :'buffer',
         :'client_id' => :'client_id',
         :'dcr_immutable_id' => :'dcr_immutable_id',
         :'id' => :'id',
@@ -64,6 +68,7 @@ def self.attribute_map
     # @!visibility private
     def self.openapi_types
       {
+        :'buffer' => :'ObservabilityPipelineBufferOptions',
         :'client_id' => :'String',
         :'dcr_immutable_id' => :'String',
         :'id' => :'String',
@@ -92,6 +97,10 @@ def initialize(attributes = {})
         end
       }
 
+      if attributes.key?(:'buffer')
+        self.buffer = attributes[:'buffer']
+      end
+
       if attributes.key?(:'client_id')
         self.client_id = attributes[:'client_id']
       end
@@ -233,6 +242,7 @@ def to_hash
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          buffer == o.buffer &&
           client_id == o.client_id &&
           dcr_immutable_id == o.dcr_immutable_id &&
           id == o.id &&
@@ -247,7 +257,7 @@ def ==(o)
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [client_id, dcr_immutable_id, id, inputs, table, tenant_id, type, additional_properties].hash
+      [buffer, client_id, dcr_immutable_id, id, inputs, table, tenant_id, type, additional_properties].hash
     end
   end
 end