datadog_api_client 2.47.0 → 2.49.0

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,17 +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
 
-    # 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.
+    # The display name for a component.
+    attr_accessor :display_name
+
+    # 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.
@@ -42,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.
@@ -54,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
 
@@ -63,6 +74,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'display_name' => :'display_name',
         :'drop_events' => :'drop_events',
         :'enabled' => :'enabled',
         :'id' => :'id',
@@ -73,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
@@ -81,6 +94,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'display_name' => :'String',
         :'drop_events' => :'Boolean',
         :'enabled' => :'Boolean',
         :'id' => :'String',
@@ -91,6 +105,7 @@ module DatadogAPIClient::V2
         :'overflow_action' => :'ObservabilityPipelineQuotaProcessorOverflowAction',
         :'overrides' => :'Array<ObservabilityPipelineQuotaProcessorOverride>',
         :'partition_fields' => :'Array<String>',
+        :'too_many_buckets_action' => :'ObservabilityPipelineQuotaProcessorOverflowAction',
         :'type' => :'ObservabilityPipelineQuotaProcessorType'
       }
     end
@@ -113,6 +128,10 @@ module DatadogAPIClient::V2
         end
       }
 
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
       if attributes.key?(:'drop_events')
         self.drop_events = attributes[:'drop_events']
       end
@@ -157,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
@@ -261,6 +284,7 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          display_name == o.display_name &&
           drop_events == o.drop_events &&
           enabled == o.enabled &&
           id == o.id &&
@@ -271,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
@@ -279,7 +304,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [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,10 +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
 
-    # Whether this processor is enabled.
+    # The display name for a component.
+    attr_accessor :display_name
+
+    # Indicates whether the processor is enabled.
     attr_reader :enabled
 
     # A list of fields used to group log events for merging.
@@ -45,6 +50,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'display_name' => :'display_name',
         :'enabled' => :'enabled',
         :'group_by' => :'group_by',
         :'id' => :'id',
@@ -58,6 +64,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'display_name' => :'String',
         :'enabled' => :'Boolean',
         :'group_by' => :'Array<String>',
         :'id' => :'String',
@@ -85,6 +92,10 @@ module DatadogAPIClient::V2
         end
       }
 
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
       if attributes.key?(:'enabled')
         self.enabled = attributes[:'enabled']
       end
@@ -213,6 +224,7 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          display_name == o.display_name &&
           enabled == o.enabled &&
           group_by == o.group_by &&
           id == o.id &&
@@ -226,7 +238,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [enabled, group_by, id, include, merge_strategies, type, additional_properties].hash
+      [display_name, enabled, group_by, id, include, merge_strategies, type, additional_properties].hash
     end
   end
 end

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

@@ -18,16 +18,21 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `remove_fields` processor deletes specified fields from logs.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineRemoveFieldsProcessor
     include BaseGenericModel
 
-    # Whether this processor is enabled.
+    # The display name for a component.
+    attr_accessor :display_name
+
+    # 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.
@@ -42,6 +47,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'display_name' => :'display_name',
         :'enabled' => :'enabled',
         :'fields' => :'fields',
         :'id' => :'id',
@@ -54,6 +60,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'display_name' => :'String',
         :'enabled' => :'Boolean',
         :'fields' => :'Array<String>',
         :'id' => :'String',
@@ -80,6 +87,10 @@ module DatadogAPIClient::V2
         end
       }
 
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
       if attributes.key?(:'enabled')
         self.enabled = attributes[:'enabled']
       end
@@ -191,6 +202,7 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          display_name == o.display_name &&
           enabled == o.enabled &&
           fields == o.fields &&
           id == o.id &&
@@ -203,7 +215,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [enabled, fields, id, include, type, additional_properties].hash
+      [display_name, enabled, fields, id, include, type, additional_properties].hash
     end
   end
 end

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

@@ -18,10 +18,15 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `rename_fields` processor changes field names.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineRenameFieldsProcessor
     include BaseGenericModel
 
-    # Whether this processor is enabled.
+    # The display name for a component.
+    attr_accessor :display_name
+
+    # 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.
@@ -42,6 +47,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'display_name' => :'display_name',
         :'enabled' => :'enabled',
         :'fields' => :'fields',
         :'id' => :'id',
@@ -54,6 +60,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'display_name' => :'String',
         :'enabled' => :'Boolean',
         :'fields' => :'Array<ObservabilityPipelineRenameFieldsProcessorField>',
         :'id' => :'String',
@@ -80,6 +87,10 @@ module DatadogAPIClient::V2
         end
       }
 
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
       if attributes.key?(:'enabled')
         self.enabled = attributes[:'enabled']
       end
@@ -191,6 +202,7 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          display_name == o.display_name &&
           enabled == o.enabled &&
           fields == o.fields &&
           id == o.id &&
@@ -203,7 +215,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [enabled, fields, id, include, type, additional_properties].hash
+      [display_name, enabled, fields, id, include, type, additional_properties].hash
     end
   end
 end

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

@@ -18,6 +18,8 @@ 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
 

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.

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

@@ -18,23 +18,28 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `sample` processor allows probabilistic sampling of logs at a fixed rate.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineSampleProcessor
     include BaseGenericModel
 
-    # Whether this processor is enabled.
+    # The display name for a component.
+    attr_accessor :display_name
+
+    # 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).
+    # Optional list of fields to group events by. Each group is sampled independently.
+    attr_reader :group_by
+
+    # 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
 
     # The percentage of logs to sample.
-    attr_accessor :percentage
-
-    # Number of events to sample (1 in N).
-    attr_reader :rate
+    attr_reader :percentage
 
     # The processor type. The value should always be `sample`.
     attr_reader :type
@@ -45,11 +50,12 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'display_name' => :'display_name',
         :'enabled' => :'enabled',
+        :'group_by' => :'group_by',
         :'id' => :'id',
         :'include' => :'include',
         :'percentage' => :'percentage',
-        :'rate' => :'rate',
         :'type' => :'type'
       }
     end
@@ -58,11 +64,12 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'display_name' => :'String',
         :'enabled' => :'Boolean',
+        :'group_by' => :'Array<String>',
         :'id' => :'String',
         :'include' => :'String',
         :'percentage' => :'Float',
-        :'rate' => :'Integer',
         :'type' => :'ObservabilityPipelineSampleProcessorType'
       }
     end
@@ -85,10 +92,20 @@ module DatadogAPIClient::V2
         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?(:'group_by')
+        if (value = attributes[:'group_by']).is_a?(Array)
+          self.group_by = value
+        end
+      end
+
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
@@ -101,10 +118,6 @@ module DatadogAPIClient::V2
         self.percentage = attributes[:'percentage']
       end
 
-      if attributes.key?(:'rate')
-        self.rate = attributes[:'rate']
-      end
-
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -115,9 +128,10 @@ module DatadogAPIClient::V2
     # @!visibility private
     def valid?
       return false if @enabled.nil?
+      return false if !@group_by.nil? && @group_by.length < 1
       return false if @id.nil?
       return false if @include.nil?
-      return false if !@rate.nil? && @rate < 1
+      return false if @percentage.nil?
       return false if @type.nil?
       true
     end
@@ -132,6 +146,16 @@ module DatadogAPIClient::V2
       @enabled = enabled
     end
 
+    # Custom attribute writer method with validation
+    # @param group_by [Object] Object to be assigned
+    # @!visibility private
+    def group_by=(group_by)
+      if !group_by.nil? && group_by.length < 1
+        fail ArgumentError, 'invalid value for "group_by", number of items must be greater than or equal to 1.'
+      end
+      @group_by = group_by
+    end
+
     # Custom attribute writer method with validation
     # @param id [Object] Object to be assigned
     # @!visibility private
@@ -153,13 +177,13 @@ module DatadogAPIClient::V2
     end
 
     # Custom attribute writer method with validation
-    # @param rate [Object] Object to be assigned
+    # @param percentage [Object] Object to be assigned
     # @!visibility private
-    def rate=(rate)
-      if !rate.nil? && rate < 1
-        fail ArgumentError, 'invalid value for "rate", must be greater than or equal to 1.'
+    def percentage=(percentage)
+      if percentage.nil?
+        fail ArgumentError, 'invalid value for "percentage", percentage cannot be nil.'
       end
-      @rate = rate
+      @percentage = percentage
     end
 
     # Custom attribute writer method with validation
@@ -198,11 +222,12 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          display_name == o.display_name &&
           enabled == o.enabled &&
+          group_by == o.group_by &&
           id == o.id &&
           include == o.include &&
           percentage == o.percentage &&
-          rate == o.rate &&
           type == o.type &&
           additional_properties == o.additional_properties
     end
@@ -211,7 +236,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [enabled, id, include, percentage, rate, type, additional_properties].hash
+      [display_name, enabled, group_by, id, include, percentage, type, additional_properties].hash
     end
   end
 end

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

@@ -18,13 +18,18 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `sensitive_data_scanner` processor detects and optionally redacts sensitive data in log events.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineSensitiveDataScannerProcessor
     include BaseGenericModel
 
-    # Whether this processor is enabled.
+    # The display name for a component.
+    attr_accessor :display_name
+
+    # 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 (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.
@@ -42,6 +47,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'display_name' => :'display_name',
         :'enabled' => :'enabled',
         :'id' => :'id',
         :'include' => :'include',
@@ -54,6 +60,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'display_name' => :'String',
         :'enabled' => :'Boolean',
         :'id' => :'String',
         :'include' => :'String',
@@ -80,6 +87,10 @@ module DatadogAPIClient::V2
         end
       }
 
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
       if attributes.key?(:'enabled')
         self.enabled = attributes[:'enabled']
       end
@@ -191,6 +202,7 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          display_name == o.display_name &&
           enabled == o.enabled &&
           id == o.id &&
           include == o.include &&
@@ -203,7 +215,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [enabled, id, include, rules, type, additional_properties].hash
+      [display_name, enabled, id, include, rules, type, additional_properties].hash
     end
   end
 end

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

@@ -21,6 +21,9 @@ module DatadogAPIClient::V2
   class ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions
     include BaseGenericModel
 
+    # Human-readable description providing context about a sensitive data scanner rule
+    attr_accessor :description
+
     # A regular expression used to detect sensitive values. Must be a valid regex.
     attr_reader :rule
 
@@ -30,6 +33,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'description' => :'description',
         :'rule' => :'rule'
       }
     end
@@ -38,6 +42,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'description' => :'String',
         :'rule' => :'String'
       }
     end
@@ -60,6 +65,10 @@ module DatadogAPIClient::V2
         end
       }
 
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'rule')
         self.rule = attributes[:'rule']
       end
@@ -109,6 +118,7 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          description == o.description &&
           rule == o.rule &&
           additional_properties == o.additional_properties
     end
@@ -117,7 +127,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [rule, additional_properties].hash
+      [description, rule, additional_properties].hash
     end
   end
 end