class DependencyTracker::Project

Attributes

active[RW]
children[RW]
description[RW]
last_bom_import[RW]
last_bom_import_format[RW]
last_inherited_risk_score[RW]
metrics[RW]
name[RW]
parent[RW]
properties[RW]
purl[RW]
tags[RW]
uuid[RW]
version[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/dependency-tracker-client/models/project.rb, line 46
def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'version' => :'version',
    :'purl' => :'purl',
    :'uuid' => :'uuid',
    :'parent' => :'parent',
    :'children' => :'children',
    :'properties' => :'properties',
    :'tags' => :'tags',
    :'last_bom_import' => :'lastBomImport',
    :'last_bom_import_format' => :'lastBomImportFormat',
    :'last_inherited_risk_score' => :'lastInheritedRiskScore',
    :'active' => :'active',
    :'metrics' => :'metrics'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/dependency-tracker-client/models/project.rb, line 309
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/dependency-tracker-client/models/project.rb, line 93
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DependencyTracker::Project` initialize method"
  end

  # 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))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DependencyTracker::Project`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  end

  if attributes.key?(:'purl')
    self.purl = attributes[:'purl']
  end

  if attributes.key?(:'uuid')
    self.uuid = attributes[:'uuid']
  end

  if attributes.key?(:'parent')
    self.parent = attributes[:'parent']
  end

  if attributes.key?(:'children')
    if (value = attributes[:'children']).is_a?(Array)
      self.children = value
    end
  end

  if attributes.key?(:'properties')
    if (value = attributes[:'properties']).is_a?(Array)
      self.properties = value
    end
  end

  if attributes.key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end

  if attributes.key?(:'last_bom_import')
    self.last_bom_import = attributes[:'last_bom_import']
  end

  if attributes.key?(:'last_bom_import_format')
    self.last_bom_import_format = attributes[:'last_bom_import_format']
  end

  if attributes.key?(:'last_inherited_risk_score')
    self.last_inherited_risk_score = attributes[:'last_inherited_risk_score']
  end

  if attributes.key?(:'active')
    self.active = attributes[:'active']
  end

  if attributes.key?(:'metrics')
    self.metrics = attributes[:'metrics']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/dependency-tracker-client/models/project.rb, line 86
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/dependency-tracker-client/models/project.rb, line 66
def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'version' => :'String',
    :'purl' => :'String',
    :'uuid' => :'String',
    :'parent' => :'Project',
    :'children' => :'Array<Project>',
    :'properties' => :'Array<ProjectProperty>',
    :'tags' => :'Array<Tag>',
    :'last_bom_import' => :'Integer',
    :'last_bom_import_format' => :'String',
    :'last_inherited_risk_score' => :'Float',
    :'active' => :'Boolean',
    :'metrics' => :'ProjectMetrics'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/dependency-tracker-client/models/project.rb, line 275
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      version == o.version &&
      purl == o.purl &&
      uuid == o.uuid &&
      parent == o.parent &&
      children == o.children &&
      properties == o.properties &&
      tags == o.tags &&
      last_bom_import == o.last_bom_import &&
      last_bom_import_format == o.last_bom_import_format &&
      last_inherited_risk_score == o.last_inherited_risk_score &&
      active == o.active &&
      metrics == o.metrics
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/dependency-tracker-client/models/project.rb, line 337
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    DependencyTracker.const_get(type).build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/dependency-tracker-client/models/project.rb, line 406
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/dependency-tracker-client/models/project.rb, line 316
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
description=(description) click to toggle source

Custom attribute writer method with validation @param [Object] description Value to be assigned

# File lib/dependency-tracker-client/models/project.rb, line 242
def description=(description)
  pattern = Regexp.new(/^[\p{White_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$/)
  if !description.nil? && description !~ pattern
    fail ArgumentError, "invalid value for \"description\", must conform to the pattern #{pattern}."
  end

  @description = description
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/dependency-tracker-client/models/project.rb, line 296
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/dependency-tracker-client/models/project.rb, line 302
def hash
  [name, description, version, purl, uuid, parent, children, properties, tags, last_bom_import, last_bom_import_format, last_inherited_risk_score, active, metrics].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/dependency-tracker-client/models/project.rb, line 171
def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  if !@name.nil? && @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/^[\p{White_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$/)
  if !@name.nil? && @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^[\p{White_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$/)
  if !@description.nil? && @description !~ pattern
    invalid_properties.push("invalid value for \"description\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^[\p{White_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$/)
  if !@version.nil? && @version !~ pattern
    invalid_properties.push("invalid value for \"version\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^[\w()\-=\*\.\?;,+\/:& ]*$/)
  if !@purl.nil? && @purl !~ pattern
    invalid_properties.push("invalid value for \"purl\", must conform to the pattern #{pattern}.")
  end

  if @uuid.nil?
    invalid_properties.push('invalid value for "uuid", uuid cannot be nil.')
  end

  invalid_properties
end
name=(name) click to toggle source

Custom attribute writer method with validation @param [Object] name Value to be assigned

# File lib/dependency-tracker-client/models/project.rb, line 223
def name=(name)
  if !name.nil? && name.to_s.length > 255
    fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
  end

  if !name.nil? && name.to_s.length < 1
    fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
  end

  pattern = Regexp.new(/^[\p{White_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$/)
  if !name.nil? && name !~ pattern
    fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
  end

  @name = name
end
purl=(purl) click to toggle source

Custom attribute writer method with validation @param [Object] purl Value to be assigned

# File lib/dependency-tracker-client/models/project.rb, line 264
def purl=(purl)
  pattern = Regexp.new(/^[\w()\-=\*\.\?;,+\/:& ]*$/)
  if !purl.nil? && purl !~ pattern
    fail ArgumentError, "invalid value for \"purl\", must conform to the pattern #{pattern}."
  end

  @purl = purl
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/dependency-tracker-client/models/project.rb, line 382
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/dependency-tracker-client/models/project.rb, line 388
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
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/dependency-tracker-client/models/project.rb, line 376
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/dependency-tracker-client/models/project.rb, line 210
def valid?
  return false if !@name.nil? && @name.to_s.length > 255
  return false if !@name.nil? && @name.to_s.length < 1
  return false if !@name.nil? && @name !~ Regexp.new(/^[\p{White_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$/)
  return false if !@description.nil? && @description !~ Regexp.new(/^[\p{White_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$/)
  return false if !@version.nil? && @version !~ Regexp.new(/^[\p{White_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$/)
  return false if !@purl.nil? && @purl !~ Regexp.new(/^[\w()\-=\*\.\?;,+\/:& ]*$/)
  return false if @uuid.nil?
  true
end
version=(version) click to toggle source

Custom attribute writer method with validation @param [Object] version Value to be assigned

# File lib/dependency-tracker-client/models/project.rb, line 253
def version=(version)
  pattern = Regexp.new(/^[\p{White_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$/)
  if !version.nil? && version !~ pattern
    fail ArgumentError, "invalid value for \"version\", must conform to the pattern #{pattern}."
  end

  @version = version
end