datadog_api_client 2.43.0 → 2.44.0

data/lib/datadog_api_client/v1/models/logs_schema_data.rb

@@ -0,0 +1,198 @@
+=begin
+#Datadog API V1 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::V1
+  # Configuration of the schema data to use.
+  class LogsSchemaData
+    include BaseGenericModel
+
+    # Class name of the schema to use.
+    attr_reader :class_name
+
+    # Class UID of the schema to use.
+    attr_reader :class_uid
+
+    # Optional list of profiles to modify the schema.
+    attr_accessor :profiles
+
+    # Type of schema to use.
+    attr_reader :schema_type
+
+    # Version of the schema to use.
+    attr_reader :version
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'class_name' => :'class_name',
+        :'class_uid' => :'class_uid',
+        :'profiles' => :'profiles',
+        :'schema_type' => :'schema_type',
+        :'version' => :'version'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'class_name' => :'String',
+        :'class_uid' => :'Integer',
+        :'profiles' => :'Array<String>',
+        :'schema_type' => :'String',
+        :'version' => :'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::V1::LogsSchemaData` 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?(:'class_name')
+        self.class_name = attributes[:'class_name']
+      end
+
+      if attributes.key?(:'class_uid')
+        self.class_uid = attributes[:'class_uid']
+      end
+
+      if attributes.key?(:'profiles')
+        if (value = attributes[:'profiles']).is_a?(Array)
+          self.profiles = value
+        end
+      end
+
+      if attributes.key?(:'schema_type')
+        self.schema_type = attributes[:'schema_type']
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      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 @class_name.nil?
+      return false if @class_uid.nil?
+      return false if @schema_type.nil?
+      return false if @version.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param class_name [Object] Object to be assigned
+    # @!visibility private
+    def class_name=(class_name)
+      if class_name.nil?
+        fail ArgumentError, 'invalid value for "class_name", class_name cannot be nil.'
+      end
+      @class_name = class_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param class_uid [Object] Object to be assigned
+    # @!visibility private
+    def class_uid=(class_uid)
+      if class_uid.nil?
+        fail ArgumentError, 'invalid value for "class_uid", class_uid cannot be nil.'
+      end
+      @class_uid = class_uid
+    end
+
+    # Custom attribute writer method with validation
+    # @param schema_type [Object] Object to be assigned
+    # @!visibility private
+    def schema_type=(schema_type)
+      if schema_type.nil?
+        fail ArgumentError, 'invalid value for "schema_type", schema_type cannot be nil.'
+      end
+      @schema_type = schema_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param version [Object] Object to be assigned
+    # @!visibility private
+    def version=(version)
+      if version.nil?
+        fail ArgumentError, 'invalid value for "version", version cannot be nil.'
+      end
+      @version = version
+    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 &&
+          class_name == o.class_name &&
+          class_uid == o.class_uid &&
+          profiles == o.profiles &&
+          schema_type == o.schema_type &&
+          version == o.version &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [class_name, class_uid, profiles, schema_type, version, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/logs_schema_mapper.rb

@@ -0,0 +1,63 @@
+=begin
+#Datadog API V1 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::V1
+  # Configuration of the schema processor mapper to use.
+  module LogsSchemaMapper
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'LogsSchemaRemapper',
+          :'LogsSchemaCategoryMapper'
+        ]
+      end
+      # Builds the object
+      # @param data [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            next if typed_data.respond_to?(:_unparsed) && typed_data._unparsed
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        if openapi_one_of.include?(:AnyType)
+          data
+        else
+          self._unparsed = true
+          DatadogAPIClient::UnparsedObject.new(data)
+        end
+      end
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/logs_schema_processor.rb

@@ -0,0 +1,198 @@
+=begin
+#Datadog API V1 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::V1
+  # A processor that has additional validations and checks for a given schema. Currently supported schema types include OCSF.
+  class LogsSchemaProcessor
+    include BaseGenericModel
+
+    # Whether or not the processor is enabled.
+    attr_accessor :is_enabled
+
+    # The `LogsSchemaProcessor` `mappers`.
+    attr_reader :mappers
+
+    # Name of the processor.
+    attr_reader :name
+
+    # Configuration of the schema data to use.
+    attr_reader :schema
+
+    # Type of logs schema processor.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'is_enabled' => :'is_enabled',
+        :'mappers' => :'mappers',
+        :'name' => :'name',
+        :'schema' => :'schema',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'is_enabled' => :'Boolean',
+        :'mappers' => :'Array<LogsSchemaMapper>',
+        :'name' => :'String',
+        :'schema' => :'LogsSchemaData',
+        :'type' => :'LogsSchemaProcessorType'
+      }
+    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::V1::LogsSchemaProcessor` 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?(:'is_enabled')
+        self.is_enabled = attributes[:'is_enabled']
+      end
+
+      if attributes.key?(:'mappers')
+        if (value = attributes[:'mappers']).is_a?(Array)
+          self.mappers = value
+        end
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'schema')
+        self.schema = attributes[:'schema']
+      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 @mappers.nil?
+      return false if @name.nil?
+      return false if @schema.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param mappers [Object] Object to be assigned
+    # @!visibility private
+    def mappers=(mappers)
+      if mappers.nil?
+        fail ArgumentError, 'invalid value for "mappers", mappers cannot be nil.'
+      end
+      @mappers = mappers
+    end
+
+    # Custom attribute writer method with validation
+    # @param name [Object] Object to be assigned
+    # @!visibility private
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'invalid value for "name", name cannot be nil.'
+      end
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param schema [Object] Object to be assigned
+    # @!visibility private
+    def schema=(schema)
+      if schema.nil?
+        fail ArgumentError, 'invalid value for "schema", schema cannot be nil.'
+      end
+      @schema = schema
+    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 &&
+          is_enabled == o.is_enabled &&
+          mappers == o.mappers &&
+          name == o.name &&
+          schema == o.schema &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [is_enabled, mappers, name, schema, type, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/logs_schema_processor_type.rb

@@ -0,0 +1,26 @@
+=begin
+#Datadog API V1 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::V1
+  # Type of logs schema processor.
+  class LogsSchemaProcessorType
+    include BaseEnumModel
+
+    SCHEMA_PROCESSOR = "schema-processor".freeze
+  end
+end

data/lib/datadog_api_client/v1/models/logs_schema_remapper.rb

@@ -0,0 +1,220 @@
+=begin
+#Datadog API V1 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::V1
+  # The schema remapper maps source log fields to their correct fields.
+  class LogsSchemaRemapper
+    include BaseGenericModel
+
+    # Name of the logs schema remapper.
+    attr_reader :name
+
+    # Override or not the target element if already set.
+    attr_accessor :override_on_conflict
+
+    # Remove or preserve the remapped source element.
+    attr_accessor :preserve_source
+
+    # Array of source attributes.
+    attr_reader :sources
+
+    # Target field to map log source field to.
+    attr_reader :target
+
+    # If the `target_type` of the remapper is `attribute`, try to cast the value to a new specific type.
+    # If the cast is not possible, the original type is kept. `string`, `integer`, or `double` are the possible types.
+    # If the `target_type` is `tag`, this parameter may not be specified.
+    attr_accessor :target_format
+
+    # Type of logs schema remapper.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'override_on_conflict' => :'override_on_conflict',
+        :'preserve_source' => :'preserve_source',
+        :'sources' => :'sources',
+        :'target' => :'target',
+        :'target_format' => :'target_format',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'override_on_conflict' => :'Boolean',
+        :'preserve_source' => :'Boolean',
+        :'sources' => :'Array<String>',
+        :'target' => :'String',
+        :'target_format' => :'TargetFormatType',
+        :'type' => :'LogsSchemaRemapperType'
+      }
+    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::V1::LogsSchemaRemapper` 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'override_on_conflict')
+        self.override_on_conflict = attributes[:'override_on_conflict']
+      end
+
+      if attributes.key?(:'preserve_source')
+        self.preserve_source = attributes[:'preserve_source']
+      end
+
+      if attributes.key?(:'sources')
+        if (value = attributes[:'sources']).is_a?(Array)
+          self.sources = value
+        end
+      end
+
+      if attributes.key?(:'target')
+        self.target = attributes[:'target']
+      end
+
+      if attributes.key?(:'target_format')
+        self.target_format = attributes[:'target_format']
+      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 @name.nil?
+      return false if @sources.nil?
+      return false if @target.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param name [Object] Object to be assigned
+    # @!visibility private
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'invalid value for "name", name cannot be nil.'
+      end
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param sources [Object] Object to be assigned
+    # @!visibility private
+    def sources=(sources)
+      if sources.nil?
+        fail ArgumentError, 'invalid value for "sources", sources cannot be nil.'
+      end
+      @sources = sources
+    end
+
+    # Custom attribute writer method with validation
+    # @param target [Object] Object to be assigned
+    # @!visibility private
+    def target=(target)
+      if target.nil?
+        fail ArgumentError, 'invalid value for "target", target cannot be nil.'
+      end
+      @target = target
+    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 &&
+          name == o.name &&
+          override_on_conflict == o.override_on_conflict &&
+          preserve_source == o.preserve_source &&
+          sources == o.sources &&
+          target == o.target &&
+          target_format == o.target_format &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [name, override_on_conflict, preserve_source, sources, target, target_format, type, additional_properties].hash
+    end
+  end
+end