datadog_api_client 2.48.0 → 2.50.0

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

@@ -0,0 +1,300 @@
+=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 `parse_xml` processor parses XML from a specified field and extracts it into the event.
+  # 
+  # **Supported pipeline types:** logs
+  class ObservabilityPipelineParseXMLProcessor
+    include BaseGenericModel
+
+    # Whether to always use a text key for element content.
+    attr_accessor :always_use_text_key
+
+    # The prefix to use for XML attributes in the parsed output.
+    attr_accessor :attr_prefix
+
+    # The display name for a component.
+    attr_accessor :display_name
+
+    # Indicates whether the processor is enabled.
+    attr_reader :enabled
+
+    # The name of the log field that contains an XML string.
+    attr_reader :field
+
+    # 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
+
+    # A Datadog search query used to determine which logs this processor targets.
+    attr_reader :include
+
+    # Whether to include XML attributes in the parsed output.
+    attr_accessor :include_attr
+
+    # Whether to parse boolean values from strings.
+    attr_accessor :parse_bool
+
+    # Whether to parse null values.
+    attr_accessor :parse_null
+
+    # Whether to parse numeric values from strings.
+    attr_accessor :parse_number
+
+    # The key name to use for text content within XML elements. Must be at least 1 character if specified.
+    attr_reader :text_key
+
+    # The processor type. The value should always be `parse_xml`.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'always_use_text_key' => :'always_use_text_key',
+        :'attr_prefix' => :'attr_prefix',
+        :'display_name' => :'display_name',
+        :'enabled' => :'enabled',
+        :'field' => :'field',
+        :'id' => :'id',
+        :'include' => :'include',
+        :'include_attr' => :'include_attr',
+        :'parse_bool' => :'parse_bool',
+        :'parse_null' => :'parse_null',
+        :'parse_number' => :'parse_number',
+        :'text_key' => :'text_key',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'always_use_text_key' => :'Boolean',
+        :'attr_prefix' => :'String',
+        :'display_name' => :'String',
+        :'enabled' => :'Boolean',
+        :'field' => :'String',
+        :'id' => :'String',
+        :'include' => :'String',
+        :'include_attr' => :'Boolean',
+        :'parse_bool' => :'Boolean',
+        :'parse_null' => :'Boolean',
+        :'parse_number' => :'Boolean',
+        :'text_key' => :'String',
+        :'type' => :'ObservabilityPipelineParseXMLProcessorType'
+      }
+    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::ObservabilityPipelineParseXMLProcessor` 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?(:'always_use_text_key')
+        self.always_use_text_key = attributes[:'always_use_text_key']
+      end
+
+      if attributes.key?(:'attr_prefix')
+        self.attr_prefix = attributes[:'attr_prefix']
+      end
+
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      end
+
+      if attributes.key?(:'field')
+        self.field = attributes[:'field']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'include')
+        self.include = attributes[:'include']
+      end
+
+      if attributes.key?(:'include_attr')
+        self.include_attr = attributes[:'include_attr']
+      end
+
+      if attributes.key?(:'parse_bool')
+        self.parse_bool = attributes[:'parse_bool']
+      end
+
+      if attributes.key?(:'parse_null')
+        self.parse_null = attributes[:'parse_null']
+      end
+
+      if attributes.key?(:'parse_number')
+        self.parse_number = attributes[:'parse_number']
+      end
+
+      if attributes.key?(:'text_key')
+        self.text_key = attributes[:'text_key']
+      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 @enabled.nil?
+      return false if @field.nil?
+      return false if @id.nil?
+      return false if @include.nil?
+      return false if !@text_key.nil? && @text_key.to_s.length < 1
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param enabled [Object] Object to be assigned
+    # @!visibility private
+    def enabled=(enabled)
+      if enabled.nil?
+        fail ArgumentError, 'invalid value for "enabled", enabled cannot be nil.'
+      end
+      @enabled = enabled
+    end
+
+    # Custom attribute writer method with validation
+    # @param field [Object] Object to be assigned
+    # @!visibility private
+    def field=(field)
+      if field.nil?
+        fail ArgumentError, 'invalid value for "field", field cannot be nil.'
+      end
+      @field = field
+    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 include [Object] Object to be assigned
+    # @!visibility private
+    def include=(include)
+      if include.nil?
+        fail ArgumentError, 'invalid value for "include", include cannot be nil.'
+      end
+      @include = include
+    end
+
+    # Custom attribute writer method with validation
+    # @param text_key [Object] Object to be assigned
+    # @!visibility private
+    def text_key=(text_key)
+      if !text_key.nil? && text_key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "text_key", the character length must be great than or equal to 1.'
+      end
+      @text_key = text_key
+    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 &&
+          always_use_text_key == o.always_use_text_key &&
+          attr_prefix == o.attr_prefix &&
+          display_name == o.display_name &&
+          enabled == o.enabled &&
+          field == o.field &&
+          id == o.id &&
+          include == o.include &&
+          include_attr == o.include_attr &&
+          parse_bool == o.parse_bool &&
+          parse_null == o.parse_null &&
+          parse_number == o.parse_number &&
+          text_key == o.text_key &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [always_use_text_key, attr_prefix, display_name, enabled, field, id, include, include_attr, parse_bool, parse_null, parse_number, text_key, type, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/observability_pipeline_parse_xml_processor_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 processor type. The value should always be `parse_xml`.
+  class ObservabilityPipelineParseXMLProcessorType
+    include BaseEnumModel
+
+    PARSE_XML = "parse_xml".freeze
+  end
+end

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

@@ -17,20 +17,22 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # The Quota Processor measures logging traffic for logs that match a specified filter. When the configured daily quota is met, the processor can drop or alert.
+  # The `quota` processor measures logging traffic for logs that match a specified filter. When the configured daily quota is met, the processor can drop or alert.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineQuotaProcessor
     include BaseGenericModel
 
     # The display name for a component.
     attr_accessor :display_name
 
-    # If set to `true`, logs that matched the quota filter and sent after the quota has been met are dropped; only logs that did not match the filter query continue through the pipeline.
+    # If set to `true`, logs that match the quota filter and are sent after the quota is exceeded are dropped. Logs that do not match the filter continue through the pipeline. **Note**: You can set either `drop_events` or `overflow_action`, but not both.
     attr_accessor :drop_events
 
-    # Whether this processor is enabled.
+    # Indicates whether the processor is enabled.
     attr_reader :enabled
 
-    # The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the `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
 
     # If `true`, the processor skips quota checks when partition fields are missing from the logs.
@@ -45,7 +47,7 @@ module DatadogAPIClient::V2
     # Name of the quota.
     attr_reader :name
 
-    # The action to take when the quota is exceeded. Options:
+    # The action to take when the quota or bucket limit is exceeded. Options:
     # - `drop`: Drop the event.
     # - `no_action`: Let the event pass through.
     # - `overflow_routing`: Route to an overflow destination.
@@ -57,6 +59,12 @@ module DatadogAPIClient::V2
     # A list of fields used to segment log traffic for quota enforcement. Quotas are tracked independently by unique combinations of these field values.
     attr_accessor :partition_fields
 
+    # The action to take when the quota or bucket limit is exceeded. Options:
+    # - `drop`: Drop the event.
+    # - `no_action`: Let the event pass through.
+    # - `overflow_routing`: Route to an overflow destination.
+    attr_accessor :too_many_buckets_action
+
     # The processor type. The value should always be `quota`.
     attr_reader :type
 
@@ -77,6 +85,7 @@ module DatadogAPIClient::V2
         :'overflow_action' => :'overflow_action',
         :'overrides' => :'overrides',
         :'partition_fields' => :'partition_fields',
+        :'too_many_buckets_action' => :'too_many_buckets_action',
         :'type' => :'type'
       }
     end
@@ -96,6 +105,7 @@ module DatadogAPIClient::V2
         :'overflow_action' => :'ObservabilityPipelineQuotaProcessorOverflowAction',
         :'overrides' => :'Array<ObservabilityPipelineQuotaProcessorOverride>',
         :'partition_fields' => :'Array<String>',
+        :'too_many_buckets_action' => :'ObservabilityPipelineQuotaProcessorOverflowAction',
         :'type' => :'ObservabilityPipelineQuotaProcessorType'
       }
     end
@@ -166,6 +176,10 @@ module DatadogAPIClient::V2
         end
       end
 
+      if attributes.key?(:'too_many_buckets_action')
+        self.too_many_buckets_action = attributes[:'too_many_buckets_action']
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -281,6 +295,7 @@ module DatadogAPIClient::V2
           overflow_action == o.overflow_action &&
           overrides == o.overrides &&
           partition_fields == o.partition_fields &&
+          too_many_buckets_action == o.too_many_buckets_action &&
           type == o.type &&
           additional_properties == o.additional_properties
     end
@@ -289,7 +304,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [display_name, drop_events, enabled, id, ignore_when_missing_partitions, include, limit, name, overflow_action, overrides, partition_fields, type, additional_properties].hash
+      [display_name, drop_events, enabled, id, ignore_when_missing_partitions, include, limit, name, overflow_action, overrides, partition_fields, too_many_buckets_action, type, additional_properties].hash
     end
   end
 end

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # The action to take when the quota is exceeded. Options:
+  # The action to take when the quota or bucket limit is exceeded. Options:
   # - `drop`: Drop the event.
   # - `no_action`: Let the event pass through.
   # - `overflow_routing`: Route to an overflow destination.

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

@@ -18,13 +18,15 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `reduce` processor aggregates and merges logs based on matching keys and merge strategies.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineReduceProcessor
     include BaseGenericModel
 
     # The display name for a component.
     attr_accessor :display_name
 
-    # Whether this processor is enabled.
+    # Indicates whether the processor is enabled.
     attr_reader :enabled
 
     # A list of fields used to group log events for merging.

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

@@ -18,19 +18,21 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `remove_fields` processor deletes specified fields from logs.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineRemoveFieldsProcessor
     include BaseGenericModel
 
     # The display name for a component.
     attr_accessor :display_name
 
-    # Whether this processor is enabled.
+    # Indicates whether the processor is enabled.
     attr_reader :enabled
 
     # A list of field names to be removed from each log event.
     attr_reader :fields
 
-    # 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
 
     # A Datadog search query used to determine which logs this processor targets.

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

@@ -18,13 +18,15 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `rename_fields` processor changes field names.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineRenameFieldsProcessor
     include BaseGenericModel
 
     # The display name for a component.
     attr_accessor :display_name
 
-    # Whether this processor is enabled.
+    # Indicates whether the processor is enabled.
     attr_reader :enabled
 
     # A list of rename rules specifying which fields to rename in the event, what to rename them to, and whether to preserve the original fields.

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

@@ -18,9 +18,14 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `rsyslog` destination forwards logs to an external `rsyslog` server over TCP or UDP using the syslog protocol.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineRsyslogDestination
     include BaseGenericModel
 
+    # Configuration for buffer settings on destination components.
+    attr_accessor :buffer
+
     # The unique identifier for this component.
     attr_reader :id
 
@@ -42,6 +47,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'buffer' => :'buffer',
         :'id' => :'id',
         :'inputs' => :'inputs',
         :'keepalive' => :'keepalive',
@@ -54,6 +60,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'buffer' => :'ObservabilityPipelineBufferOptions',
         :'id' => :'String',
         :'inputs' => :'Array<String>',
         :'keepalive' => :'Integer',
@@ -80,6 +87,10 @@ module DatadogAPIClient::V2
         end
       }
 
+      if attributes.key?(:'buffer')
+        self.buffer = attributes[:'buffer']
+      end
+
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
@@ -180,6 +191,7 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          buffer == o.buffer &&
           id == o.id &&
           inputs == o.inputs &&
           keepalive == o.keepalive &&
@@ -192,7 +204,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [id, inputs, keepalive, tls, type, additional_properties].hash
+      [buffer, id, inputs, keepalive, tls, type, additional_properties].hash
     end
   end
 end

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

@@ -18,10 +18,12 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `rsyslog` source listens for logs over TCP or UDP from an `rsyslog` server using the syslog protocol.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineRsyslogSource
     include BaseGenericModel
 
-    # 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
 
     # Protocol used by the syslog source to receive messages.