datadog_api_client 2.47.0 → 2.49.0

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

@@ -0,0 +1,28 @@
+=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
+  # HTTP authentication strategy.
+  class ObservabilityPipelineHttpClientDestinationAuthStrategy
+    include BaseEnumModel
+
+    NONE = "none".freeze
+    BASIC = "basic".freeze
+    BEARER = "bearer".freeze
+  end
+end

data/lib/datadog_api_client/v2/models/observability_pipeline_http_client_destination_compression.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
+  # Compression configuration for HTTP requests.
+  class ObservabilityPipelineHttpClientDestinationCompression
+    include BaseGenericModel
+
+    # Compression algorithm.
+    attr_reader :algorithm
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'algorithm' => :'algorithm'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'algorithm' => :'ObservabilityPipelineHttpClientDestinationCompressionAlgorithm'
+      }
+    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::ObservabilityPipelineHttpClientDestinationCompression` 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
+    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 &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [algorithm, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/{incident_attachment_postmortem_attachment_type.rb → observability_pipeline_http_client_destination_compression_algorithm.rb}

@@ -17,10 +17,10 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # The type of postmortem attachment attributes.
-  class IncidentAttachmentPostmortemAttachmentType
+  # Compression algorithm.
+  class ObservabilityPipelineHttpClientDestinationCompressionAlgorithm
     include BaseEnumModel
 
-    POSTMORTEM = "postmortem".freeze
+    GZIP = "gzip".freeze
   end
 end

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

@@ -0,0 +1,26 @@
+=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
+  # Encoding format for log events.
+  class ObservabilityPipelineHttpClientDestinationEncoding
+    include BaseEnumModel
+
+    JSON = "json".freeze
+  end
+end

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

@@ -0,0 +1,26 @@
+=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 destination type. The value should always be `http_client`.
+  class ObservabilityPipelineHttpClientDestinationType
+    include BaseEnumModel
+
+    HTTP_CLIENT = "http_client".freeze
+  end
+end

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

@@ -18,6 +18,8 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `http_client` source scrapes logs from HTTP endpoints at regular intervals.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineHttpClientSource
     include BaseGenericModel
 
@@ -27,7 +29,7 @@ module DatadogAPIClient::V2
     # The decoding format used to interpret incoming logs.
     attr_reader :decoding
 
-    # The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
+    # The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
     attr_reader :id
 
     # The interval (in seconds) between HTTP scrape requests.

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

@@ -21,6 +21,7 @@ module DatadogAPIClient::V2
   class ObservabilityPipelineHttpClientSourceAuthStrategy
     include BaseEnumModel
 
+    NONE = "none".freeze
     BASIC = "basic".freeze
     BEARER = "bearer".freeze
   end

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

@@ -18,6 +18,8 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `http_server` source collects logs over HTTP POST from external services.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineHttpServerSource
     include BaseGenericModel
 

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

@@ -0,0 +1,361 @@
+=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 `kafka` destination sends logs to Apache Kafka topics.
+  # 
+  # **Supported pipeline types:** logs
+  class ObservabilityPipelineKafkaDestination
+    include BaseGenericModel
+
+    # Compression codec for Kafka messages.
+    attr_accessor :compression
+
+    # Encoding format for log events.
+    attr_reader :encoding
+
+    # The field name to use for Kafka message headers.
+    attr_accessor :headers_key
+
+    # The unique identifier for this component.
+    attr_reader :id
+
+    # A list of component IDs whose output is used as the `input` for this component.
+    attr_reader :inputs
+
+    # The field name to use as the Kafka message key.
+    attr_accessor :key_field
+
+    # Optional list of advanced Kafka producer configuration options, defined as key-value pairs.
+    attr_accessor :librdkafka_options
+
+    # Maximum time in milliseconds to wait for message delivery confirmation.
+    attr_reader :message_timeout_ms
+
+    # Duration in seconds for the rate limit window.
+    attr_reader :rate_limit_duration_secs
+
+    # Maximum number of messages allowed per rate limit duration.
+    attr_reader :rate_limit_num
+
+    # Specifies the SASL mechanism for authenticating with a Kafka cluster.
+    attr_accessor :sasl
+
+    # Socket timeout in milliseconds for network requests.
+    attr_reader :socket_timeout_ms
+
+    # Configuration for enabling TLS encryption between the pipeline component and external services.
+    attr_accessor :tls
+
+    # The Kafka topic name to publish logs to.
+    attr_reader :topic
+
+    # The destination type. The value should always be `kafka`.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'compression' => :'compression',
+        :'encoding' => :'encoding',
+        :'headers_key' => :'headers_key',
+        :'id' => :'id',
+        :'inputs' => :'inputs',
+        :'key_field' => :'key_field',
+        :'librdkafka_options' => :'librdkafka_options',
+        :'message_timeout_ms' => :'message_timeout_ms',
+        :'rate_limit_duration_secs' => :'rate_limit_duration_secs',
+        :'rate_limit_num' => :'rate_limit_num',
+        :'sasl' => :'sasl',
+        :'socket_timeout_ms' => :'socket_timeout_ms',
+        :'tls' => :'tls',
+        :'topic' => :'topic',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'compression' => :'ObservabilityPipelineKafkaDestinationCompression',
+        :'encoding' => :'ObservabilityPipelineKafkaDestinationEncoding',
+        :'headers_key' => :'String',
+        :'id' => :'String',
+        :'inputs' => :'Array<String>',
+        :'key_field' => :'String',
+        :'librdkafka_options' => :'Array<ObservabilityPipelineKafkaLibrdkafkaOption>',
+        :'message_timeout_ms' => :'Integer',
+        :'rate_limit_duration_secs' => :'Integer',
+        :'rate_limit_num' => :'Integer',
+        :'sasl' => :'ObservabilityPipelineKafkaSasl',
+        :'socket_timeout_ms' => :'Integer',
+        :'tls' => :'ObservabilityPipelineTls',
+        :'topic' => :'String',
+        :'type' => :'ObservabilityPipelineKafkaDestinationType'
+      }
+    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::ObservabilityPipelineKafkaDestination` 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?(:'compression')
+        self.compression = attributes[:'compression']
+      end
+
+      if attributes.key?(:'encoding')
+        self.encoding = attributes[:'encoding']
+      end
+
+      if attributes.key?(:'headers_key')
+        self.headers_key = attributes[:'headers_key']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'inputs')
+        if (value = attributes[:'inputs']).is_a?(Array)
+          self.inputs = value
+        end
+      end
+
+      if attributes.key?(:'key_field')
+        self.key_field = attributes[:'key_field']
+      end
+
+      if attributes.key?(:'librdkafka_options')
+        if (value = attributes[:'librdkafka_options']).is_a?(Array)
+          self.librdkafka_options = value
+        end
+      end
+
+      if attributes.key?(:'message_timeout_ms')
+        self.message_timeout_ms = attributes[:'message_timeout_ms']
+      end
+
+      if attributes.key?(:'rate_limit_duration_secs')
+        self.rate_limit_duration_secs = attributes[:'rate_limit_duration_secs']
+      end
+
+      if attributes.key?(:'rate_limit_num')
+        self.rate_limit_num = attributes[:'rate_limit_num']
+      end
+
+      if attributes.key?(:'sasl')
+        self.sasl = attributes[:'sasl']
+      end
+
+      if attributes.key?(:'socket_timeout_ms')
+        self.socket_timeout_ms = attributes[:'socket_timeout_ms']
+      end
+
+      if attributes.key?(:'tls')
+        self.tls = attributes[:'tls']
+      end
+
+      if attributes.key?(:'topic')
+        self.topic = attributes[:'topic']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      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 @encoding.nil?
+      return false if @id.nil?
+      return false if @inputs.nil?
+      return false if !@message_timeout_ms.nil? && @message_timeout_ms < 1
+      return false if !@rate_limit_duration_secs.nil? && @rate_limit_duration_secs < 1
+      return false if !@rate_limit_num.nil? && @rate_limit_num < 1
+      return false if !@socket_timeout_ms.nil? && @socket_timeout_ms > 300000
+      return false if !@socket_timeout_ms.nil? && @socket_timeout_ms < 10
+      return false if @topic.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param encoding [Object] Object to be assigned
+    # @!visibility private
+    def encoding=(encoding)
+      if encoding.nil?
+        fail ArgumentError, 'invalid value for "encoding", encoding cannot be nil.'
+      end
+      @encoding = encoding
+    end
+
+    # Custom attribute writer method with validation
+    # @param id [Object] Object to be assigned
+    # @!visibility private
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'invalid value for "id", id cannot be nil.'
+      end
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param inputs [Object] Object to be assigned
+    # @!visibility private
+    def inputs=(inputs)
+      if inputs.nil?
+        fail ArgumentError, 'invalid value for "inputs", inputs cannot be nil.'
+      end
+      @inputs = inputs
+    end
+
+    # Custom attribute writer method with validation
+    # @param message_timeout_ms [Object] Object to be assigned
+    # @!visibility private
+    def message_timeout_ms=(message_timeout_ms)
+      if !message_timeout_ms.nil? && message_timeout_ms < 1
+        fail ArgumentError, 'invalid value for "message_timeout_ms", must be greater than or equal to 1.'
+      end
+      @message_timeout_ms = message_timeout_ms
+    end
+
+    # Custom attribute writer method with validation
+    # @param rate_limit_duration_secs [Object] Object to be assigned
+    # @!visibility private
+    def rate_limit_duration_secs=(rate_limit_duration_secs)
+      if !rate_limit_duration_secs.nil? && rate_limit_duration_secs < 1
+        fail ArgumentError, 'invalid value for "rate_limit_duration_secs", must be greater than or equal to 1.'
+      end
+      @rate_limit_duration_secs = rate_limit_duration_secs
+    end
+
+    # Custom attribute writer method with validation
+    # @param rate_limit_num [Object] Object to be assigned
+    # @!visibility private
+    def rate_limit_num=(rate_limit_num)
+      if !rate_limit_num.nil? && rate_limit_num < 1
+        fail ArgumentError, 'invalid value for "rate_limit_num", must be greater than or equal to 1.'
+      end
+      @rate_limit_num = rate_limit_num
+    end
+
+    # Custom attribute writer method with validation
+    # @param socket_timeout_ms [Object] Object to be assigned
+    # @!visibility private
+    def socket_timeout_ms=(socket_timeout_ms)
+      if !socket_timeout_ms.nil? && socket_timeout_ms > 300000
+        fail ArgumentError, 'invalid value for "socket_timeout_ms", must be smaller than or equal to 300000.'
+      end
+      if !socket_timeout_ms.nil? && socket_timeout_ms < 10
+        fail ArgumentError, 'invalid value for "socket_timeout_ms", must be greater than or equal to 10.'
+      end
+      @socket_timeout_ms = socket_timeout_ms
+    end
+
+    # Custom attribute writer method with validation
+    # @param topic [Object] Object to be assigned
+    # @!visibility private
+    def topic=(topic)
+      if topic.nil?
+        fail ArgumentError, 'invalid value for "topic", topic cannot be nil.'
+      end
+      @topic = topic
+    end
+
+    # Custom attribute writer method with validation
+    # @param type [Object] Object to be assigned
+    # @!visibility private
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'invalid value for "type", type cannot be nil.'
+      end
+      @type = type
+    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 &&
+          compression == o.compression &&
+          encoding == o.encoding &&
+          headers_key == o.headers_key &&
+          id == o.id &&
+          inputs == o.inputs &&
+          key_field == o.key_field &&
+          librdkafka_options == o.librdkafka_options &&
+          message_timeout_ms == o.message_timeout_ms &&
+          rate_limit_duration_secs == o.rate_limit_duration_secs &&
+          rate_limit_num == o.rate_limit_num &&
+          sasl == o.sasl &&
+          socket_timeout_ms == o.socket_timeout_ms &&
+          tls == o.tls &&
+          topic == o.topic &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [compression, encoding, headers_key, id, inputs, key_field, librdkafka_options, message_timeout_ms, rate_limit_duration_secs, rate_limit_num, sasl, socket_timeout_ms, tls, topic, type, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination_compression.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
+  # Compression codec for Kafka messages.
+  class ObservabilityPipelineKafkaDestinationCompression
+    include BaseEnumModel
+
+    NONE = "none".freeze
+    GZIP = "gzip".freeze
+    SNAPPY = "snappy".freeze
+    LZ4 = "lz4".freeze
+    ZSTD = "zstd".freeze
+  end
+end

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

@@ -0,0 +1,27 @@
+=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
+  # Encoding format for log events.
+  class ObservabilityPipelineKafkaDestinationEncoding
+    include BaseEnumModel
+
+    JSON = "json".freeze
+    RAW_MESSAGE = "raw_message".freeze
+  end
+end