class EmassClient::TestResultsGet

Attributes

cci[RW]
Required

CCI associated with test result.

compliance_status[RW]
Required

Test result compliance status

control[RW]
Read-Only

Control acronym associated with the test result. NIST SP 800-53 Revision 4 defined.

description[RW]
Required

Include description of test result. 4000 Characters.

is_inherited[RW]
Read-only

Indicates whether a test result is inherited.

system_id[RW]
Required

Unique eMASS identifier. Will need to provide correct number

test_date[RW]
Required

Unix time format.

tested_by[RW]
Required

Last Name, First Name. 100 Characters.

type[RW]
Read-Only

Indicates the location in the Control Approval Chain when the test result is submitted.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/emass_client/models/test_results_get.rb, line 66
def self.attribute_map
  {
    :'system_id' => :'systemId',
    :'control' => :'control',
    :'cci' => :'cci',
    :'is_inherited' => :'isInherited',
    :'tested_by' => :'testedBy',
    :'test_date' => :'testDate',
    :'description' => :'description',
    :'type' => :'type',
    :'compliance_status' => :'complianceStatus'
  }
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/emass_client/models/test_results_get.rb, line 221
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/emass_client/models/test_results_get.rb, line 103
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `EmassClient::TestResultsGet` 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 `EmassClient::TestResultsGet`. 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?(:'system_id')
    self.system_id = attributes[:'system_id']
  end

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/emass_client/models/test_results_get.rb, line 96
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/emass_client/models/test_results_get.rb, line 81
def self.openapi_types
  {
    :'system_id' => :'Object',
    :'control' => :'Object',
    :'cci' => :'Object',
    :'is_inherited' => :'Object',
    :'tested_by' => :'Object',
    :'test_date' => :'Object',
    :'description' => :'Object',
    :'type' => :'Object',
    :'compliance_status' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/emass_client/models/test_results_get.rb, line 192
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      system_id == o.system_id &&
      control == o.control &&
      cci == o.cci &&
      is_inherited == o.is_inherited &&
      tested_by == o.tested_by &&
      test_date == o.test_date &&
      description == o.description &&
      type == o.type &&
      compliance_status == o.compliance_status
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/emass_client/models/test_results_get.rb, line 251
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
    EmassClient.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/emass_client/models/test_results_get.rb, line 320
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/emass_client/models/test_results_get.rb, line 228
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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end
compliance_status=(compliance_status) click to toggle source

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

# File lib/emass_client/models/test_results_get.rb, line 182
def compliance_status=(compliance_status)
  validator = EnumAttributeValidator.new('Object', ['Compliant', 'Non-Compliant', 'Not Applicable'])
  unless validator.valid?(compliance_status)
    fail ArgumentError, "invalid value for \"compliance_status\", must be one of #{validator.allowable_values}."
  end
  @compliance_status = compliance_status
end
eql?(o) click to toggle source

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

# File lib/emass_client/models/test_results_get.rb, line 208
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/emass_client/models/test_results_get.rb, line 214
def hash
  [system_id, control, cci, is_inherited, tested_by, test_date, description, type, compliance_status].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/emass_client/models/test_results_get.rb, line 155
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
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/emass_client/models/test_results_get.rb, line 296
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/emass_client/models/test_results_get.rb, line 302
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/emass_client/models/test_results_get.rb, line 290
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

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

# File lib/emass_client/models/test_results_get.rb, line 172
def type=(type)
  validator = EnumAttributeValidator.new('Object', ['Self-Assessment', 'Schedule-Assessment', 'Deep Evaluation'])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
  end
  @type = type
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/emass_client/models/test_results_get.rb, line 162
def valid?
  type_validator = EnumAttributeValidator.new('Object', ['Self-Assessment', 'Schedule-Assessment', 'Deep Evaluation'])
  return false unless type_validator.valid?(@type)
  compliance_status_validator = EnumAttributeValidator.new('Object', ['Compliant', 'Non-Compliant', 'Not Applicable'])
  return false unless compliance_status_validator.valid?(@compliance_status)
  true
end