datadog_api_client 2.47.0 → 2.49.0

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

data/lib/datadog_api_client/v2/models/{incident_attachment_link_attributes_attachment_object.rb → observability_pipeline_split_array_processor_array_config.rb}

@@ -17,15 +17,15 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # The link attachment.
-  class IncidentAttachmentLinkAttributesAttachmentObject
+  # Configuration for a single array split operation.
+  class ObservabilityPipelineSplitArrayProcessorArrayConfig
     include BaseGenericModel
 
-    # The URL of this link attachment.
-    attr_reader :document_url
+    # The path to the array field to split.
+    attr_reader :field
 
-    # The title of this link attachment.
-    attr_reader :title
+    # A Datadog search query used to determine which logs this array split operation targets.
+    attr_reader :include
 
     attr_accessor :additional_properties
 
@@ -33,8 +33,8 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
-        :'document_url' => :'documentUrl',
-        :'title' => :'title'
+        :'field' => :'field',
+        :'include' => :'include'
       }
     end
 
@@ -42,8 +42,8 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
-        :'document_url' => :'String',
-        :'title' => :'String'
+        :'field' => :'String',
+        :'include' => :'String'
       }
     end
 
@@ -52,7 +52,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::IncidentAttachmentLinkAttributesAttachmentObject` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::ObservabilityPipelineSplitArrayProcessorArrayConfig` initialize method"
       end
 
       self.additional_properties = {}
@@ -65,12 +65,12 @@ module DatadogAPIClient::V2
         end
       }
 
-      if attributes.key?(:'document_url')
-        self.document_url = attributes[:'document_url']
+      if attributes.key?(:'field')
+        self.field = attributes[:'field']
       end
 
-      if attributes.key?(:'title')
-        self.title = attributes[:'title']
+      if attributes.key?(:'include')
+        self.include = attributes[:'include']
       end
     end
 
@@ -78,29 +78,29 @@ module DatadogAPIClient::V2
     # @return true if the model is valid
     # @!visibility private
     def valid?
-      return false if @document_url.nil?
-      return false if @title.nil?
+      return false if @field.nil?
+      return false if @include.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param document_url [Object] Object to be assigned
+    # @param field [Object] Object to be assigned
     # @!visibility private
-    def document_url=(document_url)
-      if document_url.nil?
-        fail ArgumentError, 'invalid value for "document_url", document_url cannot be nil.'
+    def field=(field)
+      if field.nil?
+        fail ArgumentError, 'invalid value for "field", field cannot be nil.'
       end
-      @document_url = document_url
+      @field = field
     end
 
     # Custom attribute writer method with validation
-    # @param title [Object] Object to be assigned
+    # @param include [Object] Object to be assigned
     # @!visibility private
-    def title=(title)
-      if title.nil?
-        fail ArgumentError, 'invalid value for "title", title cannot be nil.'
+    def include=(include)
+      if include.nil?
+        fail ArgumentError, 'invalid value for "include", include cannot be nil.'
       end
-      @title = title
+      @include = include
     end
 
     # Returns the object in the form of hash, with additionalProperties support.
@@ -129,8 +129,8 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          document_url == o.document_url &&
-          title == o.title &&
+          field == o.field &&
+          include == o.include &&
           additional_properties == o.additional_properties
     end
 
@@ -138,7 +138,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [document_url, title, additional_properties].hash
+      [field, include, additional_properties].hash
     end
   end
 end

data/lib/datadog_api_client/v2/models/observability_pipeline_split_array_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 `split_array`.
+  class ObservabilityPipelineSplitArrayProcessorType
+    include BaseEnumModel
+
+    SPLIT_ARRAY = "split_array".freeze
+  end
+end

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

@@ -18,6 +18,8 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `splunk_hec` destination forwards logs to Splunk using the HTTP Event Collector (HEC).
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineSplunkHecDestination
     include BaseGenericModel
 
@@ -28,7 +30,7 @@ module DatadogAPIClient::V2
     # Encoding format for log events.
     attr_accessor :encoding
 
-    # 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
 
     # Optional name of the Splunk index where logs are written.

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

@@ -18,10 +18,12 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `splunk_hec` source implements the Splunk HTTP Event Collector (HEC) API.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineSplunkHecSource
     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
 
     # Configuration for enabling TLS encryption between the pipeline component and external services.

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

@@ -19,10 +19,12 @@ require 'time'
 module DatadogAPIClient::V2
   # The `splunk_tcp` source receives logs from a Splunk Universal Forwarder over TCP.
   # TLS is supported for secure transmission.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineSplunkTcpSource
     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
 
     # Configuration for enabling TLS encryption between the pipeline component and external services.

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

@@ -18,6 +18,8 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `sumo_logic` destination forwards logs to Sumo Logic.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineSumoLogicDestination
     include BaseGenericModel
 

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

@@ -18,10 +18,12 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `sumo_logic` source receives logs from Sumo Logic collectors.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineSumoLogicSource
     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
 
     # The source type. The value should always be `sumo_logic`.

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

@@ -18,6 +18,8 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `syslog_ng` destination forwards logs to an external `syslog-ng` server over TCP or UDP using the syslog protocol.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineSyslogNgDestination
     include BaseGenericModel
 

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

@@ -18,10 +18,12 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `syslog_ng` source listens for logs over TCP or UDP from a `syslog-ng` server using the syslog protocol.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineSyslogNgSource
     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_throttle_processor.rb

@@ -18,10 +18,15 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `throttle` processor limits the number of events that pass through over a given time window.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineThrottleProcessor
     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
 
     # Optional list of fields used to group events before the threshold has been reached.
@@ -48,6 +53,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'display_name' => :'display_name',
         :'enabled' => :'enabled',
         :'group_by' => :'group_by',
         :'id' => :'id',
@@ -62,6 +68,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'display_name' => :'String',
         :'enabled' => :'Boolean',
         :'group_by' => :'Array<String>',
         :'id' => :'String',
@@ -90,6 +97,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
@@ -220,6 +231,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 &&
@@ -234,7 +246,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [enabled, group_by, id, include, threshold, type, window, additional_properties].hash
+      [display_name, enabled, group_by, id, include, threshold, type, window, additional_properties].hash
     end
   end
 end