datadog_api_client 2.52.0 → 2.53.0

data/lib/datadog_api_client/v2/models/observability_pipeline_config.rb

@@ -41,6 +41,7 @@ module DatadogAPIClient::V2
     # Set to `true` to continue using the legacy search syntax while migrating filter queries. After migrating all queries to the new syntax, set to `false`.
     # The legacy syntax is deprecated and will eventually be removed.
     # Requires Observability Pipelines Worker 2.11 or later.
+    # Only applies to `logs` pipelines. This field is ignored for `metrics` pipelines.
     # See [Upgrade Your Filter Queries to the New Search Syntax](https://docs.datadoghq.com/observability_pipelines/guide/upgrade_your_filter_queries_to_the_new_search_syntax/) for more information.
     attr_accessor :use_legacy_search_syntax
 

data/lib/datadog_api_client/v2/models/observability_pipeline_config_destination_item.rb

@@ -26,6 +26,7 @@ module DatadogAPIClient::V2
       # List of class defined in oneOf (OpenAPI v3)
       def openapi_one_of
         [
+          :'ObservabilityPipelineElasticsearchDestination',
           :'ObservabilityPipelineHttpClientDestination',
           :'ObservabilityPipelineAmazonOpenSearchDestination',
           :'ObservabilityPipelineAmazonS3Destination',
@@ -35,7 +36,6 @@ module DatadogAPIClient::V2
           :'ObservabilityPipelineCloudPremDestination',
           :'ObservabilityPipelineCrowdStrikeNextGenSiemDestination',
           :'ObservabilityPipelineDatadogLogsDestination',
-          :'ObservabilityPipelineElasticsearchDestination',
           :'ObservabilityPipelineGoogleChronicleDestination',
           :'ObservabilityPipelineGoogleCloudStorageDestination',
           :'ObservabilityPipelineGooglePubSubDestination',

data/lib/datadog_api_client/v2/models/observability_pipeline_elasticsearch_destination.rb

@@ -17,9 +17,9 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # The `elasticsearch` destination writes logs to an Elasticsearch cluster.
+  # The `elasticsearch` destination writes logs or metrics to an Elasticsearch cluster.
   # 
-  # **Supported pipeline types:** logs
+  # **Supported pipeline types:** logs, metrics
   class ObservabilityPipelineElasticsearchDestination
     include BaseGenericModel
 
@@ -33,9 +33,12 @@ module DatadogAPIClient::V2
     # Configuration for buffer settings on destination components.
     attr_accessor :buffer
 
-    # The index to write logs to in Elasticsearch.
+    # The name of the index to write events to in Elasticsearch.
     attr_accessor :bulk_index
 
+    # Compression configuration for the Elasticsearch destination.
+    attr_accessor :compression
+
     # Configuration options for writing to Elasticsearch Data Streams instead of a fixed index.
     attr_accessor :data_stream
 
@@ -45,9 +48,21 @@ module DatadogAPIClient::V2
     # The unique identifier for this component.
     attr_reader :id
 
+    # The name of the field used as the document ID in Elasticsearch.
+    attr_accessor :id_key
+
     # A list of component IDs whose output is used as the `input` for this component.
     attr_reader :inputs
 
+    # The name of an Elasticsearch ingest pipeline to apply to events before indexing.
+    attr_accessor :pipeline
+
+    # When `true`, retries failed partial bulk requests when some events in a batch fail while others succeed.
+    attr_accessor :request_retry_partial
+
+    # Configuration for enabling TLS encryption between the pipeline component and external services.
+    attr_accessor :tls
+
     # The destination type. The value should always be `elasticsearch`.
     attr_reader :type
 
@@ -61,10 +76,15 @@ module DatadogAPIClient::V2
         :'auth' => :'auth',
         :'buffer' => :'buffer',
         :'bulk_index' => :'bulk_index',
+        :'compression' => :'compression',
         :'data_stream' => :'data_stream',
         :'endpoint_url_key' => :'endpoint_url_key',
         :'id' => :'id',
+        :'id_key' => :'id_key',
         :'inputs' => :'inputs',
+        :'pipeline' => :'pipeline',
+        :'request_retry_partial' => :'request_retry_partial',
+        :'tls' => :'tls',
         :'type' => :'type'
       }
     end
@@ -77,10 +97,15 @@ module DatadogAPIClient::V2
         :'auth' => :'ObservabilityPipelineElasticsearchDestinationAuth',
         :'buffer' => :'ObservabilityPipelineBufferOptions',
         :'bulk_index' => :'String',
+        :'compression' => :'ObservabilityPipelineElasticsearchDestinationCompression',
         :'data_stream' => :'ObservabilityPipelineElasticsearchDestinationDataStream',
         :'endpoint_url_key' => :'String',
         :'id' => :'String',
+        :'id_key' => :'String',
         :'inputs' => :'Array<String>',
+        :'pipeline' => :'String',
+        :'request_retry_partial' => :'Boolean',
+        :'tls' => :'ObservabilityPipelineTls',
         :'type' => :'ObservabilityPipelineElasticsearchDestinationType'
       }
     end
@@ -119,6 +144,10 @@ module DatadogAPIClient::V2
         self.bulk_index = attributes[:'bulk_index']
       end
 
+      if attributes.key?(:'compression')
+        self.compression = attributes[:'compression']
+      end
+
       if attributes.key?(:'data_stream')
         self.data_stream = attributes[:'data_stream']
       end
@@ -131,12 +160,28 @@ module DatadogAPIClient::V2
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'id_key')
+        self.id_key = attributes[:'id_key']
+      end
+
       if attributes.key?(:'inputs')
         if (value = attributes[:'inputs']).is_a?(Array)
           self.inputs = value
         end
       end
 
+      if attributes.key?(:'pipeline')
+        self.pipeline = attributes[:'pipeline']
+      end
+
+      if attributes.key?(:'request_retry_partial')
+        self.request_retry_partial = attributes[:'request_retry_partial']
+      end
+
+      if attributes.key?(:'tls')
+        self.tls = attributes[:'tls']
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -212,10 +257,15 @@ module DatadogAPIClient::V2
           auth == o.auth &&
           buffer == o.buffer &&
           bulk_index == o.bulk_index &&
+          compression == o.compression &&
           data_stream == o.data_stream &&
           endpoint_url_key == o.endpoint_url_key &&
           id == o.id &&
+          id_key == o.id_key &&
           inputs == o.inputs &&
+          pipeline == o.pipeline &&
+          request_retry_partial == o.request_retry_partial &&
+          tls == o.tls &&
           type == o.type &&
           additional_properties == o.additional_properties
     end
@@ -224,7 +274,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [api_version, auth, buffer, bulk_index, data_stream, endpoint_url_key, id, inputs, type, additional_properties].hash
+      [api_version, auth, buffer, bulk_index, compression, data_stream, endpoint_url_key, id, id_key, inputs, pipeline, request_retry_partial, tls, type, additional_properties].hash
     end
   end
 end

data/lib/datadog_api_client/v2/models/observability_pipeline_elasticsearch_destination_compression.rb

@@ -0,0 +1,133 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ 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.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Compression configuration for the Elasticsearch destination.
+  class ObservabilityPipelineElasticsearchDestinationCompression
+    include BaseGenericModel
+
+    # The compression algorithm applied when sending data to Elasticsearch.
+    attr_reader :algorithm
+
+    # The compression level. Only applicable for `gzip`, `zlib`, and `zstd` algorithms.
+    attr_accessor :level
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'algorithm' => :'algorithm',
+        :'level' => :'level'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'algorithm' => :'ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm',
+        :'level' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::ObservabilityPipelineElasticsearchDestinationCompression` initialize method"
+      end
+
+      self.additional_properties = {}
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'algorithm')
+        self.algorithm = attributes[:'algorithm']
+      end
+
+      if attributes.key?(:'level')
+        self.level = attributes[:'level']
+      end
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @algorithm.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param algorithm [Object] Object to be assigned
+    # @!visibility private
+    def algorithm=(algorithm)
+      if algorithm.nil?
+        fail ArgumentError, 'invalid value for "algorithm", algorithm cannot be nil.'
+      end
+      @algorithm = algorithm
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          algorithm == o.algorithm &&
+          level == o.level &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [algorithm, level, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/observability_pipeline_elasticsearch_destination_compression_algorithm.rb

@@ -0,0 +1,30 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ 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.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # The compression algorithm applied when sending data to Elasticsearch.
+  class ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm
+    include BaseEnumModel
+
+    NONE = "none".freeze
+    GZIP = "gzip".freeze
+    ZLIB = "zlib".freeze
+    ZSTD = "zstd".freeze
+    SNAPPY = "snappy".freeze
+  end
+end

data/lib/datadog_api_client/v2/models/observability_pipeline_elasticsearch_destination_data_stream.rb

@@ -21,24 +21,32 @@ module DatadogAPIClient::V2
   class ObservabilityPipelineElasticsearchDestinationDataStream
     include BaseGenericModel
 
-    # The data stream dataset for your logs. This groups logs by their source or application.
+    # When `true`, automatically routes events to the appropriate data stream based on the event content.
+    attr_accessor :auto_routing
+
+    # The data stream dataset. This groups events by their source or application.
     attr_accessor :dataset
 
-    # The data stream type for your logs. This determines how logs are categorized within the data stream.
+    # The data stream type. This determines how events are categorized within the data stream.
     attr_accessor :dtype
 
-    # The data stream namespace for your logs. This separates logs into different environments or domains.
+    # The data stream namespace. This separates events into different environments or domains.
     attr_accessor :namespace
 
+    # When `true`, synchronizes data stream fields with the Elasticsearch index mapping.
+    attr_accessor :sync_fields
+
     attr_accessor :additional_properties
 
     # Attribute mapping from ruby-style variable name to JSON key.
     # @!visibility private
     def self.attribute_map
       {
+        :'auto_routing' => :'auto_routing',
         :'dataset' => :'dataset',
         :'dtype' => :'dtype',
-        :'namespace' => :'namespace'
+        :'namespace' => :'namespace',
+        :'sync_fields' => :'sync_fields'
       }
     end
 
@@ -46,9 +54,11 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'auto_routing' => :'Boolean',
         :'dataset' => :'String',
         :'dtype' => :'String',
-        :'namespace' => :'String'
+        :'namespace' => :'String',
+        :'sync_fields' => :'Boolean'
       }
     end
 
@@ -70,6 +80,10 @@ module DatadogAPIClient::V2
         end
       }
 
+      if attributes.key?(:'auto_routing')
+        self.auto_routing = attributes[:'auto_routing']
+      end
+
       if attributes.key?(:'dataset')
         self.dataset = attributes[:'dataset']
       end
@@ -81,6 +95,10 @@ module DatadogAPIClient::V2
       if attributes.key?(:'namespace')
         self.namespace = attributes[:'namespace']
       end
+
+      if attributes.key?(:'sync_fields')
+        self.sync_fields = attributes[:'sync_fields']
+      end
     end
 
     # Returns the object in the form of hash, with additionalProperties support.
@@ -109,9 +127,11 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          auto_routing == o.auto_routing &&
           dataset == o.dataset &&
           dtype == o.dtype &&
           namespace == o.namespace &&
+          sync_fields == o.sync_fields &&
           additional_properties == o.additional_properties
     end
 
@@ -119,7 +139,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [dataset, dtype, namespace, additional_properties].hash
+      [auto_routing, dataset, dtype, namespace, sync_fields, additional_properties].hash
     end
   end
 end

data/lib/datadog_api_client/v2/models/observability_pipeline_enrichment_table_field_event_lookup.rb

@@ -0,0 +1,123 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ 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.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Looks up a value from a field path in the log event.
+  class ObservabilityPipelineEnrichmentTableFieldEventLookup
+    include BaseGenericModel
+
+    # The path to the field in the log event to use as the lookup key.
+    attr_reader :event
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'event' => :'event'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'event' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::ObservabilityPipelineEnrichmentTableFieldEventLookup` initialize method"
+      end
+
+      self.additional_properties = {}
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'event')
+        self.event = attributes[:'event']
+      end
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @event.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param event [Object] Object to be assigned
+    # @!visibility private
+    def event=(event)
+      if event.nil?
+        fail ArgumentError, 'invalid value for "event", event cannot be nil.'
+      end
+      @event = event
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          event == o.event &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [event, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/observability_pipeline_enrichment_table_field_secret_lookup.rb

@@ -0,0 +1,123 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ 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.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Looks up a value stored as a pipeline secret.
+  class ObservabilityPipelineEnrichmentTableFieldSecretLookup
+    include BaseGenericModel
+
+    # The name of the secret containing the lookup key value.
+    attr_reader :secret
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'secret' => :'secret'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'secret' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::ObservabilityPipelineEnrichmentTableFieldSecretLookup` initialize method"
+      end
+
+      self.additional_properties = {}
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'secret')
+        self.secret = attributes[:'secret']
+      end
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @secret.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param secret [Object] Object to be assigned
+    # @!visibility private
+    def secret=(secret)
+      if secret.nil?
+        fail ArgumentError, 'invalid value for "secret", secret cannot be nil.'
+      end
+      @secret = secret
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          secret == o.secret &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [secret, additional_properties].hash
+    end
+  end
+end