datadog_api_client 2.48.0 → 2.49.0

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,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,26 +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
 
     # The display name for a component.
     attr_accessor :display_name
 
-    # 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).
+    # 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
@@ -50,10 +52,10 @@ module DatadogAPIClient::V2
       {
         :'display_name' => :'display_name',
         :'enabled' => :'enabled',
+        :'group_by' => :'group_by',
         :'id' => :'id',
         :'include' => :'include',
         :'percentage' => :'percentage',
-        :'rate' => :'rate',
         :'type' => :'type'
       }
     end
@@ -64,10 +66,10 @@ module DatadogAPIClient::V2
       {
         :'display_name' => :'String',
         :'enabled' => :'Boolean',
+        :'group_by' => :'Array<String>',
         :'id' => :'String',
         :'include' => :'String',
         :'percentage' => :'Float',
-        :'rate' => :'Integer',
         :'type' => :'ObservabilityPipelineSampleProcessorType'
       }
     end
@@ -98,6 +100,12 @@ module DatadogAPIClient::V2
         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
@@ -110,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
@@ -124,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
@@ -141,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
@@ -162,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
@@ -209,10 +224,10 @@ module DatadogAPIClient::V2
       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
@@ -221,7 +236,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [display_name, 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,16 +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
 
     # The display name for a component.
     attr_accessor :display_name
 
-    # 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 (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_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

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

@@ -21,6 +21,9 @@ module DatadogAPIClient::V2
   class ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions
     include BaseGenericModel
 
+    # Human-readable description providing context about a sensitive data scanner rule
+    attr_accessor :description
+
     # Identifier for a predefined pattern from the sensitive data scanner pattern library.
     attr_reader :id
 
@@ -33,6 +36,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'description' => :'description',
         :'id' => :'id',
         :'use_recommended_keywords' => :'use_recommended_keywords'
       }
@@ -42,6 +46,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'description' => :'String',
         :'id' => :'String',
         :'use_recommended_keywords' => :'Boolean'
       }
@@ -65,6 +70,10 @@ module DatadogAPIClient::V2
         end
       }
 
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
@@ -118,6 +127,7 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          description == o.description &&
           id == o.id &&
           use_recommended_keywords == o.use_recommended_keywords &&
           additional_properties == o.additional_properties
@@ -127,7 +137,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [id, use_recommended_keywords, additional_properties].hash
+      [description, id, use_recommended_keywords, additional_properties].hash
     end
   end
 end

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

@@ -18,6 +18,8 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `sentinel_one` destination sends logs to SentinelOne.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineSentinelOneDestination
     include BaseGenericModel
 

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

@@ -18,6 +18,8 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `socket` destination sends logs over TCP or UDP to a remote server.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineSocketDestination
     include BaseGenericModel
 

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

@@ -18,13 +18,15 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `socket` source ingests logs over TCP or UDP.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineSocketSource
     include BaseGenericModel
 
     # Framing method configuration for the socket source.
     attr_reader :framing
 
-    # 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 to receive logs.

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

@@ -0,0 +1,229 @@
+=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 `split_array` processor splits array fields into separate events based on configured rules.
+  # 
+  # **Supported pipeline types:** logs
+  class ObservabilityPipelineSplitArrayProcessor
+    include BaseGenericModel
+
+    # A list of array split configurations.
+    attr_reader :arrays
+
+    # 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 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. For split_array, this should typically be `*`.
+    attr_reader :include
+
+    # The processor type. The value should always be `split_array`.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'arrays' => :'arrays',
+        :'display_name' => :'display_name',
+        :'enabled' => :'enabled',
+        :'id' => :'id',
+        :'include' => :'include',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'arrays' => :'Array<ObservabilityPipelineSplitArrayProcessorArrayConfig>',
+        :'display_name' => :'String',
+        :'enabled' => :'Boolean',
+        :'id' => :'String',
+        :'include' => :'String',
+        :'type' => :'ObservabilityPipelineSplitArrayProcessorType'
+      }
+    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::ObservabilityPipelineSplitArrayProcessor` 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?(:'arrays')
+        if (value = attributes[:'arrays']).is_a?(Array)
+          self.arrays = value
+        end
+      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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'include')
+        self.include = attributes[:'include']
+      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 @arrays.nil?
+      return false if @arrays.length > 15
+      return false if @arrays.length < 1
+      return false if @enabled.nil?
+      return false if @id.nil?
+      return false if @include.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param arrays [Object] Object to be assigned
+    # @!visibility private
+    def arrays=(arrays)
+      if arrays.nil?
+        fail ArgumentError, 'invalid value for "arrays", arrays cannot be nil.'
+      end
+      if arrays.length > 15
+        fail ArgumentError, 'invalid value for "arrays", number of items must be less than or equal to 15.'
+      end
+      if arrays.length < 1
+        fail ArgumentError, 'invalid value for "arrays", number of items must be greater than or equal to 1.'
+      end
+      @arrays = arrays
+    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 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 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 &&
+          arrays == o.arrays &&
+          display_name == o.display_name &&
+          enabled == o.enabled &&
+          id == o.id &&
+          include == o.include &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [arrays, display_name, enabled, id, include, type, additional_properties].hash
+    end
+  end
+end