datadog_api_client 2.48.0 → 2.49.0

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

@@ -0,0 +1,156 @@
+=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
+  # Uses a Datadog reference table to enrich logs.
+  class ObservabilityPipelineEnrichmentTableReferenceTable
+    include BaseGenericModel
+
+    # List of column names to include from the reference table. If not provided, all columns are included.
+    attr_accessor :columns
+
+    # Path to the field in the log event to match against the reference table.
+    attr_reader :key_field
+
+    # The unique identifier of the reference table.
+    attr_reader :table_id
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'columns' => :'columns',
+        :'key_field' => :'key_field',
+        :'table_id' => :'table_id'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'columns' => :'Array<String>',
+        :'key_field' => :'String',
+        :'table_id' => :'String'
+      }
+    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::ObservabilityPipelineEnrichmentTableReferenceTable` 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?(:'columns')
+        if (value = attributes[:'columns']).is_a?(Array)
+          self.columns = value
+        end
+      end
+
+      if attributes.key?(:'key_field')
+        self.key_field = attributes[:'key_field']
+      end
+
+      if attributes.key?(:'table_id')
+        self.table_id = attributes[:'table_id']
+      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 @key_field.nil?
+      return false if @table_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param key_field [Object] Object to be assigned
+    # @!visibility private
+    def key_field=(key_field)
+      if key_field.nil?
+        fail ArgumentError, 'invalid value for "key_field", key_field cannot be nil.'
+      end
+      @key_field = key_field
+    end
+
+    # Custom attribute writer method with validation
+    # @param table_id [Object] Object to be assigned
+    # @!visibility private
+    def table_id=(table_id)
+      if table_id.nil?
+        fail ArgumentError, 'invalid value for "table_id", table_id cannot be nil.'
+      end
+      @table_id = table_id
+    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 &&
+          columns == o.columns &&
+          key_field == o.key_field &&
+          table_id == o.table_id &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [columns, key_field, table_id, additional_properties].hash
+    end
+  end
+end

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

@@ -17,20 +17,22 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # The `filter` processor allows conditional processing of logs based on a Datadog search query. Logs that match the `include` query are passed through; others are discarded.
+  # The `filter` processor allows conditional processing of logs/metrics based on a Datadog search query. Logs/metrics that match the `include` query are passed through; others are discarded.
+  # 
+  # **Supported pipeline types:** logs, metrics
   class ObservabilityPipelineFilterProcessor
     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).
+    # 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 should pass through the filter. Logs that match this query continue to downstream components; others are dropped.
+    # A Datadog search query used to determine which logs/metrics should pass through the filter. Logs/metrics that match this query continue to downstream components; others are dropped.
     attr_reader :include
 
     # The processor type. The value should always be `filter`.

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

@@ -18,10 +18,12 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `fluent_bit` source ingests logs from Fluent Bit.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineFluentBitSource
     include BaseGenericModel
 
-    # 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
 
     # Configuration for enabling TLS encryption between the pipeline component and external services.

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

@@ -18,10 +18,12 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `fluentd` source ingests logs from a Fluentd-compatible service.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineFluentdSource
     include BaseGenericModel
 
-    # 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
 
     # Configuration for enabling TLS encryption between the pipeline component and external services.

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

@@ -19,13 +19,15 @@ require 'time'
 module DatadogAPIClient::V2
   # The `generate_datadog_metrics` processor creates custom metrics from logs and sends them to Datadog.
   # Metrics can be counters, gauges, or distributions and optionally grouped by log fields.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineGenerateMetricsProcessor
     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.

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

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

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

@@ -19,6 +19,8 @@ require 'time'
 module DatadogAPIClient::V2
   # The `google_cloud_storage` destination stores logs in a Google Cloud Storage (GCS) bucket.
   # It requires a bucket name, GCP authentication, and metadata fields.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineGoogleCloudStorageDestination
     include BaseGenericModel
 

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

@@ -18,6 +18,8 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `google_pubsub` destination publishes logs to a Google Cloud Pub/Sub topic.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineGooglePubSubDestination
     include BaseGenericModel
 

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

@@ -18,6 +18,8 @@ require 'time'
 
 module DatadogAPIClient::V2
   # The `google_pubsub` source ingests logs from a Google Cloud Pub/Sub subscription.
+  # 
+  # **Supported pipeline types:** logs
   class ObservabilityPipelineGooglePubSubSource
     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 GCP project ID that owns the Pub/Sub subscription.

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

@@ -0,0 +1,220 @@
+=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 `http_client` destination sends data to an HTTP endpoint.
+  # 
+  # **Supported pipeline types:** logs, metrics
+  class ObservabilityPipelineHttpClientDestination
+    include BaseGenericModel
+
+    # HTTP authentication strategy.
+    attr_accessor :auth_strategy
+
+    # Compression configuration for HTTP requests.
+    attr_accessor :compression
+
+    # Encoding format for log events.
+    attr_reader :encoding
+
+    # 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
+
+    # Configuration for enabling TLS encryption between the pipeline component and external services.
+    attr_accessor :tls
+
+    # The destination type. The value should always be `http_client`.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'auth_strategy' => :'auth_strategy',
+        :'compression' => :'compression',
+        :'encoding' => :'encoding',
+        :'id' => :'id',
+        :'inputs' => :'inputs',
+        :'tls' => :'tls',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'auth_strategy' => :'ObservabilityPipelineHttpClientDestinationAuthStrategy',
+        :'compression' => :'ObservabilityPipelineHttpClientDestinationCompression',
+        :'encoding' => :'ObservabilityPipelineHttpClientDestinationEncoding',
+        :'id' => :'String',
+        :'inputs' => :'Array<String>',
+        :'tls' => :'ObservabilityPipelineTls',
+        :'type' => :'ObservabilityPipelineHttpClientDestinationType'
+      }
+    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::ObservabilityPipelineHttpClientDestination` 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?(:'auth_strategy')
+        self.auth_strategy = attributes[:'auth_strategy']
+      end
+
+      if attributes.key?(:'compression')
+        self.compression = attributes[:'compression']
+      end
+
+      if attributes.key?(:'encoding')
+        self.encoding = attributes[:'encoding']
+      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?(:'tls')
+        self.tls = attributes[:'tls']
+      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 @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 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 &&
+          auth_strategy == o.auth_strategy &&
+          compression == o.compression &&
+          encoding == o.encoding &&
+          id == o.id &&
+          inputs == o.inputs &&
+          tls == o.tls &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [auth_strategy, compression, encoding, id, inputs, tls, type, additional_properties].hash
+    end
+  end
+end

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/observability_pipeline_http_client_destination_compression_algorithm.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
+  # Compression algorithm.
+  class ObservabilityPipelineHttpClientDestinationCompressionAlgorithm
+    include BaseEnumModel
+
+    GZIP = "gzip".freeze
+  end
+end