datadog_api_client 2.55.0 → 2.56.0

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

@@ -0,0 +1,318 @@
+=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 `clickhouse` destination sends log events to a ClickHouse database table over HTTP.
+  # 
+  # **Supported pipeline types:** logs.
+  class ObservabilityPipelineClickhouseDestination
+    include BaseGenericModel
+
+    # HTTP Basic Authentication credentials for the ClickHouse destination.
+    # When `strategy` is `basic`, provide `username_key` and `password_key` that reference environment variables or secrets containing the credentials.
+    attr_accessor :auth
+
+    # Batching configuration for ClickHouse inserts.
+    attr_accessor :batch
+
+    # Batch encoding configuration for the ClickHouse destination.
+    # Required when `format` is `arrow_stream`. The `codec` field must be set to `arrow_stream`.
+    attr_accessor :batch_encoding
+
+    # Configuration for buffer settings on destination components.
+    attr_accessor :buffer
+
+    # Compression setting for outbound HTTP requests to ClickHouse.
+    # Can be specified as a shorthand string (`"gzip"` or `"none"`) or as an object
+    # with an `algorithm` field and an optional `level` (gzip only, 1–9).
+    attr_accessor :compression
+
+    # Optional ClickHouse database name. If omitted, the user's default database on the ClickHouse server is used.
+    attr_accessor :database
+
+    # When `true`, enables flexible DateTime parsing on the ClickHouse server side.
+    attr_accessor :date_time_best_effort
+
+    # Name of the environment variable or secret that contains the ClickHouse HTTP endpoint URL.
+    # Defaults to `DESTINATION_CLICKHOUSE_ENDPOINT_URL` (prefixed with `DD_OP_` at runtime).
+    attr_accessor :endpoint_url_key
+
+    # Insert format for events sent to ClickHouse.
+    # - `json_each_row`: Maps event fields to columns by name (ClickHouse `JSONEachRow`).
+    # - `json_as_object`: Inserts each event into a single `Object('json')` / `JSON` column (ClickHouse `JSONAsObject`).
+    # - `json_as_string`: Inserts each event into a single `String`-typed column as raw JSON (ClickHouse `JSONAsString`).
+    # - `arrow_stream`: Batches events using Apache Arrow IPC streaming format. Requires `batch_encoding`.
+    attr_accessor :format
+
+    # 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
+
+    # When `true`, fields not present in the target table schema are dropped instead of causing insert errors.
+    # When unset, the ClickHouse server's own `input_format_skip_unknown_fields` setting applies.
+    attr_accessor :skip_unknown_fields
+
+    # Target ClickHouse table name. Events are inserted into this table.
+    attr_reader :table
+
+    # Configuration for enabling TLS encryption between the pipeline component and external services.
+    attr_accessor :tls
+
+    # The destination type. The value must be `clickhouse`.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'auth' => :'auth',
+        :'batch' => :'batch',
+        :'batch_encoding' => :'batch_encoding',
+        :'buffer' => :'buffer',
+        :'compression' => :'compression',
+        :'database' => :'database',
+        :'date_time_best_effort' => :'date_time_best_effort',
+        :'endpoint_url_key' => :'endpoint_url_key',
+        :'format' => :'format',
+        :'id' => :'id',
+        :'inputs' => :'inputs',
+        :'skip_unknown_fields' => :'skip_unknown_fields',
+        :'table' => :'table',
+        :'tls' => :'tls',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'auth' => :'ObservabilityPipelineClickhouseDestinationAuth',
+        :'batch' => :'ObservabilityPipelineClickhouseDestinationBatch',
+        :'batch_encoding' => :'ObservabilityPipelineClickhouseDestinationBatchEncoding',
+        :'buffer' => :'ObservabilityPipelineBufferOptions',
+        :'compression' => :'ObservabilityPipelineClickhouseDestinationCompression',
+        :'database' => :'String',
+        :'date_time_best_effort' => :'Boolean',
+        :'endpoint_url_key' => :'String',
+        :'format' => :'ObservabilityPipelineClickhouseDestinationFormat',
+        :'id' => :'String',
+        :'inputs' => :'Array<String>',
+        :'skip_unknown_fields' => :'Boolean',
+        :'table' => :'String',
+        :'tls' => :'ObservabilityPipelineTls',
+        :'type' => :'ObservabilityPipelineClickhouseDestinationType'
+      }
+    end
+
+    # List of attributes with nullable: true
+    # @!visibility private
+    def self.openapi_nullable
+      Set.new([
+        :'skip_unknown_fields',
+      ])
+    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::ObservabilityPipelineClickhouseDestination` 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')
+        self.auth = attributes[:'auth']
+      end
+
+      if attributes.key?(:'batch')
+        self.batch = attributes[:'batch']
+      end
+
+      if attributes.key?(:'batch_encoding')
+        self.batch_encoding = attributes[:'batch_encoding']
+      end
+
+      if attributes.key?(:'buffer')
+        self.buffer = attributes[:'buffer']
+      end
+
+      if attributes.key?(:'compression')
+        self.compression = attributes[:'compression']
+      end
+
+      if attributes.key?(:'database')
+        self.database = attributes[:'database']
+      end
+
+      if attributes.key?(:'date_time_best_effort')
+        self.date_time_best_effort = attributes[:'date_time_best_effort']
+      end
+
+      if attributes.key?(:'endpoint_url_key')
+        self.endpoint_url_key = attributes[:'endpoint_url_key']
+      end
+
+      if attributes.key?(:'format')
+        self.format = attributes[:'format']
+      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?(:'skip_unknown_fields')
+        self.skip_unknown_fields = attributes[:'skip_unknown_fields']
+      end
+
+      if attributes.key?(:'table')
+        self.table = attributes[:'table']
+      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 @id.nil?
+      return false if @inputs.nil?
+      return false if @table.nil?
+      return false if @type.nil?
+      true
+    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 table [Object] Object to be assigned
+    # @!visibility private
+    def table=(table)
+      if table.nil?
+        fail ArgumentError, 'invalid value for "table", table cannot be nil.'
+      end
+      @table = table
+    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 == o.auth &&
+          batch == o.batch &&
+          batch_encoding == o.batch_encoding &&
+          buffer == o.buffer &&
+          compression == o.compression &&
+          database == o.database &&
+          date_time_best_effort == o.date_time_best_effort &&
+          endpoint_url_key == o.endpoint_url_key &&
+          format == o.format &&
+          id == o.id &&
+          inputs == o.inputs &&
+          skip_unknown_fields == o.skip_unknown_fields &&
+          table == o.table &&
+          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, batch, batch_encoding, buffer, compression, database, date_time_best_effort, endpoint_url_key, format, id, inputs, skip_unknown_fields, table, tls, type, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,144 @@
+=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 Basic Authentication credentials for the ClickHouse destination.
+  # When `strategy` is `basic`, provide `username_key` and `password_key` that reference environment variables or secrets containing the credentials.
+  class ObservabilityPipelineClickhouseDestinationAuth
+    include BaseGenericModel
+
+    # Name of the environment variable or secret that contains the ClickHouse password.
+    attr_accessor :password_key
+
+    # The authentication strategy for ClickHouse HTTP requests. Only `basic` is supported.
+    attr_reader :strategy
+
+    # Name of the environment variable or secret that contains the ClickHouse username.
+    attr_accessor :username_key
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'password_key' => :'password_key',
+        :'strategy' => :'strategy',
+        :'username_key' => :'username_key'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'password_key' => :'String',
+        :'strategy' => :'ObservabilityPipelineClickhouseDestinationAuthStrategy',
+        :'username_key' => :'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::ObservabilityPipelineClickhouseDestinationAuth` 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?(:'password_key')
+        self.password_key = attributes[:'password_key']
+      end
+
+      if attributes.key?(:'strategy')
+        self.strategy = attributes[:'strategy']
+      end
+
+      if attributes.key?(:'username_key')
+        self.username_key = attributes[:'username_key']
+      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 @strategy.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param strategy [Object] Object to be assigned
+    # @!visibility private
+    def strategy=(strategy)
+      if strategy.nil?
+        fail ArgumentError, 'invalid value for "strategy", strategy cannot be nil.'
+      end
+      @strategy = strategy
+    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 &&
+          password_key == o.password_key &&
+          strategy == o.strategy &&
+          username_key == o.username_key &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [password_key, strategy, username_key, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination_auth_strategy.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 authentication strategy for ClickHouse HTTP requests. Only `basic` is supported.
+  class ObservabilityPipelineClickhouseDestinationAuthStrategy
+    include BaseEnumModel
+
+    BASIC = "basic".freeze
+  end
+end

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

@@ -0,0 +1,148 @@
+=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
+  # Batching configuration for ClickHouse inserts.
+  class ObservabilityPipelineClickhouseDestinationBatch
+    include BaseGenericModel
+
+    # Maximum number of events per batch before it is flushed.
+    attr_reader :max_events
+
+    # Maximum number of seconds to wait before flushing a partial batch.
+    attr_reader :timeout_secs
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'max_events' => :'max_events',
+        :'timeout_secs' => :'timeout_secs'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'max_events' => :'Integer',
+        :'timeout_secs' => :'Integer'
+      }
+    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::ObservabilityPipelineClickhouseDestinationBatch` 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?(:'max_events')
+        self.max_events = attributes[:'max_events']
+      end
+
+      if attributes.key?(:'timeout_secs')
+        self.timeout_secs = attributes[:'timeout_secs']
+      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 !@max_events.nil? && @max_events < 1
+      return false if !@timeout_secs.nil? && @timeout_secs > 65535
+      return false if !@timeout_secs.nil? && @timeout_secs < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param max_events [Object] Object to be assigned
+    # @!visibility private
+    def max_events=(max_events)
+      if !max_events.nil? && max_events < 1
+        fail ArgumentError, 'invalid value for "max_events", must be greater than or equal to 1.'
+      end
+      @max_events = max_events
+    end
+
+    # Custom attribute writer method with validation
+    # @param timeout_secs [Object] Object to be assigned
+    # @!visibility private
+    def timeout_secs=(timeout_secs)
+      if !timeout_secs.nil? && timeout_secs > 65535
+        fail ArgumentError, 'invalid value for "timeout_secs", must be smaller than or equal to 65535.'
+      end
+      if !timeout_secs.nil? && timeout_secs < 1
+        fail ArgumentError, 'invalid value for "timeout_secs", must be greater than or equal to 1.'
+      end
+      @timeout_secs = timeout_secs
+    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 &&
+          max_events == o.max_events &&
+          timeout_secs == o.timeout_secs &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [max_events, timeout_secs, additional_properties].hash
+    end
+  end
+end