class EmassClient::ArtifactsGet

Attributes

artifact_expiration_date[RW]
Optional

Date Artifact expires and requires review. In Unix Date format.

category[RW]
Required

Artifact category options

ccis[RW]
Optional

CCI associated with test result.

controls[RW]
Optional

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

description[RW]
Optional

Artifact description. 2000 Characters.

file_size[RW]
Read-Only

File size of attached artifact.

filename[RW]
Required

File name should match exactly one file within the provided zip file. 1000 Characters.

is_inherited[RW]
Read-only

Indicates whether an artifact is inherited.

is_template[RW]
Read-only

Indicates whether an artifact template.

last_reviewed_date[RW]
Conditional

Date Artifact was last reviewed.. Unix time format.

mime_content_type[RW]
Read-Only

Standard MIME content type derived from file extension.

ref_page_number[RW]
Optional

Artifact reference page number. 50 Characters.

system_id[RW]
Required

Unique eMASS system identifier.

type[RW]
Required

Artifact type options

Public Class Methods

attribute_map() click to toggle source

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

# File lib/emass_client/models/artifacts_get.rb, line 81
def self.attribute_map
  {
    :'system_id' => :'systemId',
    :'filename' => :'filename',
    :'is_inherited' => :'isInherited',
    :'is_template' => :'isTemplate',
    :'type' => :'type',
    :'category' => :'category',
    :'description' => :'description',
    :'ref_page_number' => :'refPageNumber',
    :'ccis' => :'ccis',
    :'controls' => :'controls',
    :'mime_content_type' => :'mimeContentType',
    :'file_size' => :'fileSize',
    :'artifact_expiration_date' => :'artifactExpirationDate',
    :'last_reviewed_date' => :'lastReviewedDate'
  }
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/artifacts_get.rb, line 271
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/artifacts_get.rb, line 128
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `EmassClient::ArtifactsGet` 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::ArtifactsGet`. 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?(:'filename')
    self.filename = attributes[:'filename']
  end

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/emass_client/models/artifacts_get.rb, line 101
def self.openapi_types
  {
    :'system_id' => :'Object',
    :'filename' => :'Object',
    :'is_inherited' => :'Object',
    :'is_template' => :'Object',
    :'type' => :'Object',
    :'category' => :'Object',
    :'description' => :'Object',
    :'ref_page_number' => :'Object',
    :'ccis' => :'Object',
    :'controls' => :'Object',
    :'mime_content_type' => :'Object',
    :'file_size' => :'Object',
    :'artifact_expiration_date' => :'Object',
    :'last_reviewed_date' => :'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/artifacts_get.rb, line 237
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      system_id == o.system_id &&
      filename == o.filename &&
      is_inherited == o.is_inherited &&
      is_template == o.is_template &&
      type == o.type &&
      category == o.category &&
      description == o.description &&
      ref_page_number == o.ref_page_number &&
      ccis == o.ccis &&
      controls == o.controls &&
      mime_content_type == o.mime_content_type &&
      file_size == o.file_size &&
      artifact_expiration_date == o.artifact_expiration_date &&
      last_reviewed_date == o.last_reviewed_date
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/artifacts_get.rb, line 301
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/artifacts_get.rb, line 370
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/artifacts_get.rb, line 278
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
category=(category) click to toggle source

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

# File lib/emass_client/models/artifacts_get.rb, line 227
def category=(category)
  validator = EnumAttributeValidator.new('Object', ['Implementation Guidance', 'Evidence'])
  unless validator.valid?(category)
    fail ArgumentError, "invalid value for \"category\", must be one of #{validator.allowable_values}."
  end
  @category = category
end
eql?(o) click to toggle source

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

# File lib/emass_client/models/artifacts_get.rb, line 258
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/artifacts_get.rb, line 264
def hash
  [system_id, filename, is_inherited, is_template, type, category, description, ref_page_number, ccis, controls, mime_content_type, file_size, artifact_expiration_date, last_reviewed_date].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/artifacts_get.rb, line 200
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/artifacts_get.rb, line 346
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/artifacts_get.rb, line 352
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/artifacts_get.rb, line 340
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/artifacts_get.rb, line 217
def type=(type)
  validator = EnumAttributeValidator.new('Object', ['Procedure', 'Diagram', 'Policy', 'Labor', 'Document', 'Image', 'Other', 'Scan Result', 'Auditor Report'])
  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/artifacts_get.rb, line 207
def valid?
  type_validator = EnumAttributeValidator.new('Object', ['Procedure', 'Diagram', 'Policy', 'Labor', 'Document', 'Image', 'Other', 'Scan Result', 'Auditor Report'])
  return false unless type_validator.valid?(@type)
  category_validator = EnumAttributeValidator.new('Object', ['Implementation Guidance', 'Evidence'])
  return false unless category_validator.valid?(@category)
  true
end