datadog_api_client 2.55.0 → 2.56.0

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

@@ -0,0 +1,221 @@
+=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
+  # A CycloneDX 1.5 Bill of Materials (BOM) document containing vulnerability data.
+  class CycloneDXBom
+    include BaseGenericModel
+
+    # The BOM format identifier. Must be `CycloneDX`.
+    attr_reader :bom_format
+
+    # The list of scanned software components. Cannot be empty.
+    attr_reader :components
+
+    # Metadata about the BOM, including the scanned asset and the scanner tool.
+    attr_reader :metadata
+
+    # The CycloneDX specification version. Must be `1.5`.
+    attr_reader :spec_version
+
+    # The version number of the BOM document.
+    attr_accessor :version
+
+    # The list of detected vulnerabilities. Cannot be empty.
+    attr_reader :vulnerabilities
+
+    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',
+        :'spec_version' => :'specVersion',
+        :'version' => :'version',
+        :'vulnerabilities' => :'vulnerabilities'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'bom_format' => :'String',
+        :'components' => :'Array<CycloneDXComponent>',
+        :'metadata' => :'CycloneDXMetadata',
+        :'spec_version' => :'String',
+        :'version' => :'Integer',
+        :'vulnerabilities' => :'Array<CycloneDXVulnerability>'
+      }
+    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::CycloneDXBom` 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?(:'spec_version')
+        self.spec_version = attributes[:'spec_version']
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      end
+
+      if attributes.key?(:'vulnerabilities')
+        if (value = attributes[:'vulnerabilities']).is_a?(Array)
+          self.vulnerabilities = value
+        end
+      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 @spec_version.nil?
+      return false if @vulnerabilities.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 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 vulnerabilities [Object] Object to be assigned
+    # @!visibility private
+    def vulnerabilities=(vulnerabilities)
+      if vulnerabilities.nil?
+        fail ArgumentError, 'invalid value for "vulnerabilities", vulnerabilities cannot be nil.'
+      end
+      @vulnerabilities = vulnerabilities
+    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 &&
+          spec_version == o.spec_version &&
+          version == o.version &&
+          vulnerabilities == o.vulnerabilities &&
+          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, spec_version, version, vulnerabilities, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,196 @@
+=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
+  # A software component identified during scanning.
+  class CycloneDXComponent
+    include BaseGenericModel
+
+    # A unique reference identifier used to link vulnerabilities to this component.
+    attr_reader :bom_ref
+
+    # The name of the component.
+    attr_reader :name
+
+    # The Package URL (PURL) of the component. Required when `type` is `library`.
+    attr_accessor :purl
+
+    # The type of the scanned component.
+    attr_reader :type
+
+    # The version of the component.
+    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' => :'CycloneDXComponentType',
+        :'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::CycloneDXComponent` 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 @bom_ref.nil?
+      return false if @name.nil?
+      return false if @type.nil?
+      return false if @version.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param bom_ref [Object] Object to be assigned
+    # @!visibility private
+    def bom_ref=(bom_ref)
+      if bom_ref.nil?
+        fail ArgumentError, 'invalid value for "bom_ref", bom_ref cannot be nil.'
+      end
+      @bom_ref = bom_ref
+    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/cyclone_dx_component_type.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
+  # The type of the scanned component.
+  class CycloneDXComponentType
+    include BaseEnumModel
+
+    LIBRARY = "library".freeze
+    APPLICATION = "application".freeze
+    OPERATING_SYSTEM = "operating-system".freeze
+  end
+end

data/lib/datadog_api_client/v2/models/cyclone_dx_metadata.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
+  # Metadata about the BOM, including the scanned asset and the scanner tool.
+  class CycloneDXMetadata
+    include BaseGenericModel
+
+    # The asset that was scanned (for example, a host or container image).
+    attr_reader :component
+
+    # Information about the scanner tool that produced this BOM.
+    attr_reader :tools
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'component' => :'component',
+        :'tools' => :'tools'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'component' => :'CycloneDXMetadataComponent',
+        :'tools' => :'CycloneDXMetadataTools'
+      }
+    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::CycloneDXMetadata` 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
+
+      if attributes.key?(:'tools')
+        self.tools = attributes[:'tools']
+      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 @component.nil?
+      return false if @tools.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param component [Object] Object to be assigned
+    # @!visibility private
+    def component=(component)
+      if component.nil?
+        fail ArgumentError, 'invalid value for "component", component cannot be nil.'
+      end
+      @component = component
+    end
+
+    # Custom attribute writer method with validation
+    # @param tools [Object] Object to be assigned
+    # @!visibility private
+    def tools=(tools)
+      if tools.nil?
+        fail ArgumentError, 'invalid value for "tools", tools cannot be nil.'
+      end
+      @tools = tools
+    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 &&
+          tools == o.tools &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [component, tools, additional_properties].hash
+    end
+  end
+end