Adding Buffer options to Observability Pipeline Destinations (#3676)

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

api/datadogV2/model_azure_storage_destination.go

@@ -16,6 +16,8 @@ import (
 type AzureStorageDestination struct {
 	// Optional prefix for blobs written to the container.
 	BlobPrefix *string `json:"blob_prefix,omitempty"`
+	// Configuration for buffer settings on destination components.
+	Buffer *ObservabilityPipelineBufferOptions `json:"buffer,omitempty"`
 	// The name of the Azure Blob Storage container to store logs in.
 	ContainerName string `json:"container_name"`
 	// The unique identifier for this component.
@@ -80,6 +82,34 @@ func (o *AzureStorageDestination) SetBlobPrefix(v string) {
 	o.BlobPrefix = &v
 }
 
+// GetBuffer returns the Buffer field value if set, zero value otherwise.
+func (o *AzureStorageDestination) GetBuffer() ObservabilityPipelineBufferOptions {
+	if o == nil || o.Buffer == nil {
+		var ret ObservabilityPipelineBufferOptions
+		return ret
+	}
+	return *o.Buffer
+}
+
+// GetBufferOk returns a tuple with the Buffer field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *AzureStorageDestination) GetBufferOk() (*ObservabilityPipelineBufferOptions, bool) {
+	if o == nil || o.Buffer == nil {
+		return nil, false
+	}
+	return o.Buffer, true
+}
+
+// HasBuffer returns a boolean if a field has been set.
+func (o *AzureStorageDestination) HasBuffer() bool {
+	return o != nil && o.Buffer != nil
+}
+
+// SetBuffer gets a reference to the given ObservabilityPipelineBufferOptions and assigns it to the Buffer field.
+func (o *AzureStorageDestination) SetBuffer(v ObservabilityPipelineBufferOptions) {
+	o.Buffer = &v
+}
+
 // GetContainerName returns the ContainerName field value.
 func (o *AzureStorageDestination) GetContainerName() string {
 	if o == nil {
@@ -181,6 +211,9 @@ func (o AzureStorageDestination) MarshalJSON() ([]byte, error) {
 	if o.BlobPrefix != nil {
 		toSerialize["blob_prefix"] = o.BlobPrefix
 	}
+	if o.Buffer != nil {
+		toSerialize["buffer"] = o.Buffer
+	}
 	toSerialize["container_name"] = o.ContainerName
 	toSerialize["id"] = o.Id
 	toSerialize["inputs"] = o.Inputs
@@ -195,11 +228,12 @@ func (o AzureStorageDestination) MarshalJSON() ([]byte, error) {
 // UnmarshalJSON deserializes the given payload.
 func (o *AzureStorageDestination) UnmarshalJSON(bytes []byte) (err error) {
 	all := struct {
-		BlobPrefix    *string                      `json:"blob_prefix,omitempty"`
-		ContainerName *string                      `json:"container_name"`
-		Id            *string                      `json:"id"`
-		Inputs        *[]string                    `json:"inputs"`
-		Type          *AzureStorageDestinationType `json:"type"`
+		BlobPrefix    *string                             `json:"blob_prefix,omitempty"`
+		Buffer        *ObservabilityPipelineBufferOptions `json:"buffer,omitempty"`
+		ContainerName *string                             `json:"container_name"`
+		Id            *string                             `json:"id"`
+		Inputs        *[]string                           `json:"inputs"`
+		Type          *AzureStorageDestinationType        `json:"type"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
 		return datadog.Unmarshal(bytes, &o.UnparsedObject)
@@ -218,13 +252,14 @@ func (o *AzureStorageDestination) UnmarshalJSON(bytes []byte) (err error) {
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"blob_prefix", "container_name", "id", "inputs", "type"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"blob_prefix", "buffer", "container_name", "id", "inputs", "type"})
 	} else {
 		return err
 	}
 
 	hasInvalidField := false
 	o.BlobPrefix = all.BlobPrefix
+	o.Buffer = all.Buffer
 	o.ContainerName = *all.ContainerName
 	o.Id = *all.Id
 	o.Inputs = *all.Inputs