class EmassClient::CmmcGet

Attributes

awarded_cmmc_level[RW]
Read-Only

The CMMC award level.

cage_codes[RW]
Read-Only

The five position code(s) associated with the Organization Seeking Certification (OSC).

certificate_id[RW]
Read-Only

Unique identifier for the assessment/certificate.

duns[RW]
Read-Only

The Data Universal Numbering System (DUNS) number.

expiration_date[RW]
Read-Only

Expiration date of the awarded CMMC certification.

hq_organization_name[RW]
Read-Only

The name of the DIB Company.

model_version[RW]
Read-Only

Version of the CMMC Model used as part of the assessment.

operation[RW]
Read-Only

Indicates the action that should be taken on the assessment record since the provided sinceDate.

osc_name[RW]
Read-Only

The name of the Organization Seeking Certification.

scope[RW]
Read-Only

The scope of the OSC assessment.

scope_description[RW]
Read-Only

Brief description of the scope of the OSC assessment

ssps[RW]
unique_entity_identifier[RW]
Read-Only

The Unique Entity Identifier assigned to the DIB Company.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/emass_client/models/cmmc_get.rb, line 77
def self.attribute_map
  {
    :'operation' => :'operation',
    :'hq_organization_name' => :'hqOrganizationName',
    :'duns' => :'duns',
    :'unique_entity_identifier' => :'uniqueEntityIdentifier',
    :'cage_codes' => :'cageCodes',
    :'osc_name' => :'oscName',
    :'scope' => :'scope',
    :'scope_description' => :'scopeDescription',
    :'awarded_cmmc_level' => :'awardedCMMCLevel',
    :'expiration_date' => :'expirationDate',
    :'certificate_id' => :'certificateId',
    :'model_version' => :'modelVersion',
    :'ssps' => :'ssps'
  }
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/cmmc_get.rb, line 286
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/cmmc_get.rb, line 122
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `EmassClient::CmmcGet` 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::CmmcGet`. 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?(:'operation')
    self.operation = attributes[:'operation']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'ssps')
    if (value = attributes[:'ssps']).is_a?(Array)
      self.ssps = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/emass_client/models/cmmc_get.rb, line 96
def self.openapi_types
  {
    :'operation' => :'Object',
    :'hq_organization_name' => :'Object',
    :'duns' => :'Object',
    :'unique_entity_identifier' => :'Object',
    :'cage_codes' => :'Object',
    :'osc_name' => :'Object',
    :'scope' => :'Object',
    :'scope_description' => :'Object',
    :'awarded_cmmc_level' => :'Object',
    :'expiration_date' => :'Object',
    :'certificate_id' => :'Object',
    :'model_version' => :'Object',
    :'ssps' => :'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/cmmc_get.rb, line 253
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      operation == o.operation &&
      hq_organization_name == o.hq_organization_name &&
      duns == o.duns &&
      unique_entity_identifier == o.unique_entity_identifier &&
      cage_codes == o.cage_codes &&
      osc_name == o.osc_name &&
      scope == o.scope &&
      scope_description == o.scope_description &&
      awarded_cmmc_level == o.awarded_cmmc_level &&
      expiration_date == o.expiration_date &&
      certificate_id == o.certificate_id &&
      model_version == o.model_version &&
      ssps == o.ssps
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/cmmc_get.rb, line 316
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/cmmc_get.rb, line 385
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
awarded_cmmc_level=(awarded_cmmc_level) click to toggle source

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

# File lib/emass_client/models/cmmc_get.rb, line 243
def awarded_cmmc_level=(awarded_cmmc_level)
  validator = EnumAttributeValidator.new('Object', ['Not Certified', 'Level 1', 'Level 2', 'Level 3', 'Level 4', 'Level 5'])
  unless validator.valid?(awarded_cmmc_level)
    fail ArgumentError, "invalid value for \"awarded_cmmc_level\", must be one of #{validator.allowable_values}."
  end
  @awarded_cmmc_level = awarded_cmmc_level
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/cmmc_get.rb, line 293
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
cage_codes=(cage_codes) click to toggle source

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

# File lib/emass_client/models/cmmc_get.rb, line 223
def cage_codes=(cage_codes)
  validator = EnumAttributeValidator.new('Object', ['89ED9; 99D8B', '34TH5; 23YH6', '75F8H; 2GH5I', '45RF9', '58H9L; 45UH8; 75F8H; 2GH5I'])
  unless validator.valid?(cage_codes)
    fail ArgumentError, "invalid value for \"cage_codes\", must be one of #{validator.allowable_values}."
  end
  @cage_codes = cage_codes
end
eql?(o) click to toggle source

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

# File lib/emass_client/models/cmmc_get.rb, line 273
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/cmmc_get.rb, line 279
def hash
  [operation, hq_organization_name, duns, unique_entity_identifier, cage_codes, osc_name, scope, scope_description, awarded_cmmc_level, expiration_date, certificate_id, model_version, ssps].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/cmmc_get.rb, line 192
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
operation=(operation) click to toggle source

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

# File lib/emass_client/models/cmmc_get.rb, line 213
def operation=(operation)
  validator = EnumAttributeValidator.new('Object', ['ADDED', 'UPDATED', 'DELETED'])
  unless validator.valid?(operation)
    fail ArgumentError, "invalid value for \"operation\", must be one of #{validator.allowable_values}."
  end
  @operation = operation
end
scope=(scope) click to toggle source

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

# File lib/emass_client/models/cmmc_get.rb, line 233
def scope=(scope)
  validator = EnumAttributeValidator.new('Object', ['Enterprise', 'Non-Enterprise'])
  unless validator.valid?(scope)
    fail ArgumentError, "invalid value for \"scope\", must be one of #{validator.allowable_values}."
  end
  @scope = scope
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/cmmc_get.rb, line 361
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/cmmc_get.rb, line 367
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/cmmc_get.rb, line 355
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/emass_client/models/cmmc_get.rb, line 199
def valid?
  operation_validator = EnumAttributeValidator.new('Object', ['ADDED', 'UPDATED', 'DELETED'])
  return false unless operation_validator.valid?(@operation)
  cage_codes_validator = EnumAttributeValidator.new('Object', ['89ED9; 99D8B', '34TH5; 23YH6', '75F8H; 2GH5I', '45RF9', '58H9L; 45UH8; 75F8H; 2GH5I'])
  return false unless cage_codes_validator.valid?(@cage_codes)
  scope_validator = EnumAttributeValidator.new('Object', ['Enterprise', 'Non-Enterprise'])
  return false unless scope_validator.valid?(@scope)
  awarded_cmmc_level_validator = EnumAttributeValidator.new('Object', ['Not Certified', 'Level 1', 'Level 2', 'Level 3', 'Level 4', 'Level 5'])
  return false unless awarded_cmmc_level_validator.valid?(@awarded_cmmc_level)
  true
end