class DependencyTracker::ConfigProperty

Attributes

description[RW]
group_name[RW]
property_name[RW]
property_type[RW]
property_value[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/config_property.rb, line 50
def self.attribute_map
  {
    :'group_name' => :'groupName',
    :'property_name' => :'propertyName',
    :'property_value' => :'propertyValue',
    :'property_type' => :'propertyType',
    :'description' => :'description'
  }
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/config_property.rb, line 310
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/config_property.rb, line 79
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DependencyTracker::ConfigProperty` 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::ConfigProperty`. 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?(:'group_name')
    self.group_name = attributes[:'group_name']
  end

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/dependency-tracker-client/models/config_property.rb, line 61
def self.openapi_types
  {
    :'group_name' => :'String',
    :'property_name' => :'String',
    :'property_value' => :'String',
    :'property_type' => :'String',
    :'description' => :'String'
  }
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/config_property.rb, line 285
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      group_name == o.group_name &&
      property_name == o.property_name &&
      property_value == o.property_value &&
      property_type == o.property_type &&
      description == o.description
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/config_property.rb, line 338
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/config_property.rb, line 407
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/config_property.rb, line 317
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/config_property.rb, line 266
def description=(description)
  if !description.nil? && description.to_s.length > 255
    fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 255.'
  end

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

  pattern = Regexp.new(/[\P{Cc}]+/)
  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/config_property.rb, line 297
def eql?(o)
  self == o
end
group_name=(group_name) click to toggle source

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

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

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

  pattern = Regexp.new(/[\P{Cc}]+/)
  if !group_name.nil? && group_name !~ pattern
    fail ArgumentError, "invalid value for \"group_name\", must conform to the pattern #{pattern}."
  end

  @group_name = group_name
end
hash() click to toggle source

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

# File lib/dependency-tracker-client/models/config_property.rb, line 303
def hash
  [group_name, property_name, property_value, property_type, description].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/config_property.rb, line 115
def list_invalid_properties
  invalid_properties = Array.new
  if !@group_name.nil? && @group_name.to_s.length > 255
    invalid_properties.push('invalid value for "group_name", the character length must be smaller than or equal to 255.')
  end

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

  pattern = Regexp.new(/[\P{Cc}]+/)
  if !@group_name.nil? && @group_name !~ pattern
    invalid_properties.push("invalid value for \"group_name\", must conform to the pattern #{pattern}.")
  end

  if !@property_name.nil? && @property_name.to_s.length > 255
    invalid_properties.push('invalid value for "property_name", the character length must be smaller than or equal to 255.')
  end

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

  pattern = Regexp.new(/[\P{Cc}]+/)
  if !@property_name.nil? && @property_name !~ pattern
    invalid_properties.push("invalid value for \"property_name\", must conform to the pattern #{pattern}.")
  end

  if !@property_value.nil? && @property_value.to_s.length > 1024
    invalid_properties.push('invalid value for "property_value", the character length must be smaller than or equal to 1024.')
  end

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

  pattern = Regexp.new(/[\P{Cc}]+/)
  if !@property_value.nil? && @property_value !~ pattern
    invalid_properties.push("invalid value for \"property_value\", must conform to the pattern #{pattern}.")
  end

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

  if !@description.nil? && @description.to_s.length > 255
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
  end

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

  pattern = Regexp.new(/[\P{Cc}]+/)
  if !@description.nil? && @description !~ pattern
    invalid_properties.push("invalid value for \"description\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end
property_name=(property_name) click to toggle source

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

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

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

  pattern = Regexp.new(/[\P{Cc}]+/)
  if !property_name.nil? && property_name !~ pattern
    fail ArgumentError, "invalid value for \"property_name\", must conform to the pattern #{pattern}."
  end

  @property_name = property_name
end
property_type=(property_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] property_type Object to be assigned

# File lib/dependency-tracker-client/models/config_property.rb, line 256
def property_type=(property_type)
  validator = EnumAttributeValidator.new('String', ["BOOLEAN", "INTEGER", "NUMBER", "STRING", "ENCRYPTEDSTRING", "TIMESTAMP", "URL", "UUID"])
  unless validator.valid?(property_type)
    fail ArgumentError, "invalid value for \"property_type\", must be one of #{validator.allowable_values}."
  end
  @property_type = property_type
end
property_value=(property_value) click to toggle source

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

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

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

  pattern = Regexp.new(/[\P{Cc}]+/)
  if !property_value.nil? && property_value !~ pattern
    fail ArgumentError, "invalid value for \"property_value\", must conform to the pattern #{pattern}."
  end

  @property_value = property_value
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/config_property.rb, line 383
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/config_property.rb, line 389
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/config_property.rb, line 377
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/config_property.rb, line 178
def valid?
  return false if !@group_name.nil? && @group_name.to_s.length > 255
  return false if !@group_name.nil? && @group_name.to_s.length < 1
  return false if !@group_name.nil? && @group_name !~ Regexp.new(/[\P{Cc}]+/)
  return false if !@property_name.nil? && @property_name.to_s.length > 255
  return false if !@property_name.nil? && @property_name.to_s.length < 1
  return false if !@property_name.nil? && @property_name !~ Regexp.new(/[\P{Cc}]+/)
  return false if !@property_value.nil? && @property_value.to_s.length > 1024
  return false if !@property_value.nil? && @property_value.to_s.length < 0
  return false if !@property_value.nil? && @property_value !~ Regexp.new(/[\P{Cc}]+/)
  return false if @property_type.nil?
  property_type_validator = EnumAttributeValidator.new('String', ["BOOLEAN", "INTEGER", "NUMBER", "STRING", "ENCRYPTEDSTRING", "TIMESTAMP", "URL", "UUID"])
  return false unless property_type_validator.valid?(@property_type)
  return false if !@description.nil? && @description.to_s.length > 255
  return false if !@description.nil? && @description.to_s.length < 0
  return false if !@description.nil? && @description !~ Regexp.new(/[\P{Cc}]+/)
  true
end