datadog_api_client 2.29.1 → 2.30.0

data/lib/datadog_api_client/v2/models/{script_data.rb → sbom.rb}

@@ -17,17 +17,17 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # The definition of `ScriptData` object.
-  class ScriptData
+  # A single SBOM
+  class SBOM
     include BaseGenericModel
 
-    # The definition of `ScriptDataAttributes` object.
+    # The JSON:API attributes of the SBOM.
     attr_accessor :attributes
 
-    # The `data` `id`.
+    # The unique ID for this SBOM (it is equivalent to the `asset_name` or `asset_name@repo_digest` (Image)
     attr_accessor :id
 
-    # The definition of `ScriptDataType` object.
+    # The JSON:API type.
     attr_accessor :type
 
     attr_accessor :additional_properties
@@ -46,9 +46,9 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
-        :'attributes' => :'ScriptDataAttributes',
+        :'attributes' => :'SBOMAttributes',
         :'id' => :'String',
-        :'type' => :'ScriptDataType'
+        :'type' => :'SBOMType'
       }
     end
 
@@ -57,7 +57,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::ScriptData` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::SBOM` initialize method"
       end
 
       self.additional_properties = {}

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

@@ -0,0 +1,230 @@
+=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 JSON:API attributes of the SBOM.
+  class SBOMAttributes
+    include BaseGenericModel
+
+    # Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOM do not have a filename convention nor does JSON schema support namespaces. This value MUST be `CycloneDX`.
+    attr_reader :bom_format
+
+    # A list of software and hardware components.
+    attr_reader :components
+
+    # Provides additional information about a BOM.
+    attr_reader :metadata
+
+    # Every BOM generated has a unique serial number, even if the contents of the BOM have not changed overt time. The serial number follows [RFC-4122](https://datatracker.ietf.org/doc/html/rfc4122)
+    attr_reader :serial_number
+
+    # The version of the CycloneDX specification a BOM conforms to.
+    attr_reader :spec_version
+
+    # It increments when a BOM is modified. The default value is 1.
+    attr_reader :version
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'bom_format' => :'bomFormat',
+        :'components' => :'components',
+        :'metadata' => :'metadata',
+        :'serial_number' => :'serialNumber',
+        :'spec_version' => :'specVersion',
+        :'version' => :'version'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'bom_format' => :'String',
+        :'components' => :'Array<SBOMComponent>',
+        :'metadata' => :'SBOMMetadata',
+        :'serial_number' => :'String',
+        :'spec_version' => :'SpecVersion',
+        :'version' => :'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::SBOMAttributes` 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?(:'bom_format')
+        self.bom_format = attributes[:'bom_format']
+      end
+
+      if attributes.key?(:'components')
+        if (value = attributes[:'components']).is_a?(Array)
+          self.components = value
+        end
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'serial_number')
+        self.serial_number = attributes[:'serial_number']
+      end
+
+      if attributes.key?(:'spec_version')
+        self.spec_version = attributes[:'spec_version']
+      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 @bom_format.nil?
+      return false if @components.nil?
+      return false if @metadata.nil?
+      return false if @serial_number.nil?
+      return false if @spec_version.nil?
+      return false if @version.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param bom_format [Object] Object to be assigned
+    # @!visibility private
+    def bom_format=(bom_format)
+      if bom_format.nil?
+        fail ArgumentError, 'invalid value for "bom_format", bom_format cannot be nil.'
+      end
+      @bom_format = bom_format
+    end
+
+    # Custom attribute writer method with validation
+    # @param components [Object] Object to be assigned
+    # @!visibility private
+    def components=(components)
+      if components.nil?
+        fail ArgumentError, 'invalid value for "components", components cannot be nil.'
+      end
+      @components = components
+    end
+
+    # Custom attribute writer method with validation
+    # @param metadata [Object] Object to be assigned
+    # @!visibility private
+    def metadata=(metadata)
+      if metadata.nil?
+        fail ArgumentError, 'invalid value for "metadata", metadata cannot be nil.'
+      end
+      @metadata = metadata
+    end
+
+    # Custom attribute writer method with validation
+    # @param serial_number [Object] Object to be assigned
+    # @!visibility private
+    def serial_number=(serial_number)
+      if serial_number.nil?
+        fail ArgumentError, 'invalid value for "serial_number", serial_number cannot be nil.'
+      end
+      @serial_number = serial_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param spec_version [Object] Object to be assigned
+    # @!visibility private
+    def spec_version=(spec_version)
+      if spec_version.nil?
+        fail ArgumentError, 'invalid value for "spec_version", spec_version cannot be nil.'
+      end
+      @spec_version = spec_version
+    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 &&
+          bom_format == o.bom_format &&
+          components == o.components &&
+          metadata == o.metadata &&
+          serial_number == o.serial_number &&
+          spec_version == o.spec_version &&
+          version == o.version &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [bom_format, components, metadata, serial_number, spec_version, version, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,185 @@
+=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
+  # Software or hardware component.
+  class SBOMComponent
+    include BaseGenericModel
+
+    # An optional identifier that can be used to reference the component elsewhere in the BOM.
+    attr_accessor :bom_ref
+
+    # The name of the component. This will often be a shortened, single name of the component.
+    attr_reader :name
+
+    # Specifies the package-url (purl). The purl, if specified, MUST be valid and conform to the [specification](https://github.com/package-url/purl-spec).
+    attr_accessor :purl
+
+    # The SBOM component type
+    attr_reader :type
+
+    # The component version.
+    attr_reader :version
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'bom_ref' => :'bom-ref',
+        :'name' => :'name',
+        :'purl' => :'purl',
+        :'type' => :'type',
+        :'version' => :'version'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'bom_ref' => :'String',
+        :'name' => :'String',
+        :'purl' => :'String',
+        :'type' => :'SBOMComponentType',
+        :'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::V2::SBOMComponent` 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?(:'bom_ref')
+        self.bom_ref = attributes[:'bom_ref']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'purl')
+        self.purl = attributes[:'purl']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'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 @name.nil?
+      return false if @type.nil?
+      return false if @version.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 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
+
+    # 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 &&
+          bom_ref == o.bom_ref &&
+          name == o.name &&
+          purl == o.purl &&
+          type == o.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
+      [bom_ref, name, purl, type, version, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+=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 SBOM component type
+  class SBOMComponentType
+    include BaseEnumModel
+
+    APPLICATION = "application".freeze
+    CONTAINER = "container".freeze
+    DATA = "data".freeze
+    DEVICE = "device".freeze
+    DEVICE_DRIVER = "device-driver".freeze
+    FILE = "file".freeze
+    FIRMWARE = "firmware".freeze
+    FRAMEWORK = "framework".freeze
+    LIBRARY = "library".freeze
+    MACHINE_LEARNING_MODEL = "machine-learning-model".freeze
+    OPERATING_SYSTEM = "operating-system".freeze
+    PLATFORM = "platform".freeze
+  end
+end

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

@@ -0,0 +1,105 @@
+=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
+  # Provides additional information about a BOM.
+  class SBOMMetadata
+    include BaseGenericModel
+
+    # The component that the BOM describes.
+    attr_accessor :component
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'component' => :'component'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'component' => :'SBOMMetadataComponent'
+      }
+    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::SBOMMetadata` 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?(:'component')
+        self.component = attributes[:'component']
+      end
+    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 &&
+          component == o.component &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [component, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/{script_data_attributes.rb → sbom_metadata_component.rb}

@@ -17,17 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # The definition of `ScriptDataAttributes` object.
-  class ScriptDataAttributes
+  # The component that the BOM describes.
+  class SBOMMetadataComponent
     include BaseGenericModel
 
-    # The `attributes` `name`.
+    # The name of the component. This will often be a shortened, single name of the component.
     attr_accessor :name
 
-    # The `attributes` `src`.
-    attr_accessor :src
-
-    # The `attributes` `type`.
+    # Specifies the type of the component.
     attr_accessor :type
 
     attr_accessor :additional_properties
@@ -37,7 +34,6 @@ module DatadogAPIClient::V2
     def self.attribute_map
       {
         :'name' => :'name',
-        :'src' => :'src',
         :'type' => :'type'
       }
     end
@@ -47,7 +43,6 @@ module DatadogAPIClient::V2
     def self.openapi_types
       {
         :'name' => :'String',
-        :'src' => :'String',
         :'type' => :'String'
       }
     end
@@ -57,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::ScriptDataAttributes` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::SBOMMetadataComponent` initialize method"
       end
 
       self.additional_properties = {}
@@ -74,10 +69,6 @@ module DatadogAPIClient::V2
         self.name = attributes[:'name']
       end
 
-      if attributes.key?(:'src')
-        self.src = attributes[:'src']
-      end
-
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -110,7 +101,6 @@ module DatadogAPIClient::V2
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
-          src == o.src &&
           type == o.type &&
           additional_properties == o.additional_properties
     end
@@ -119,7 +109,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [name, src, type, additional_properties].hash
+      [name, type, additional_properties].hash
     end
   end
 end

data/lib/datadog_api_client/v2/models/sbom_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 JSON:API type.
+  class SBOMType
+    include BaseEnumModel
+
+    SBOMS = "sboms".freeze
+  end
+end