Class: EmassClient::CmmcGet

Inherits:
Object
  • Object
show all
Defined in:
lib/emass_client/models/cmmc_get.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CmmcGet

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/emass_client/models/cmmc_get.rb', line 183

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?(:'uei')
    self.uei = attributes[:'uei']
  end

  if attributes.key?(:'cage_codes_in_scope')
    self.cage_codes_in_scope = attributes[:'cage_codes_in_scope']
  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?(:'assessment_id')
    self.assessment_id = attributes[:'assessment_id']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assessment_id ⇒ Object

Read-Only

Unique identifier for the assessment/certificate.



46
47
48
 
# File 'lib/emass_client/models/cmmc_get.rb', line 46

def assessment_id
  @assessment_id
end

#awarded_cmmc_level ⇒ Object

Read-Only

The CMMC award level.



40
41
42
 
# File 'lib/emass_client/models/cmmc_get.rb', line 40

def awarded_cmmc_level
  @awarded_cmmc_level
end

#cage_codes_in_scope ⇒ Object

Read-Only

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



28
29
30
 
# File 'lib/emass_client/models/cmmc_get.rb', line 28

def cage_codes_in_scope
  @cage_codes_in_scope
end

#certification_unique_id ⇒ Object

Read-Only

Identifies the unique ID that is associated with a given CMMC certification for an organization.



55
56
57
 
# File 'lib/emass_client/models/cmmc_get.rb', line 55

def certification_unique_id
  @certification_unique_id
end

#expiration_date ⇒ Object

Read-Only

Expiration date of the awarded CMMC certification.



43
44
45
 
# File 'lib/emass_client/models/cmmc_get.rb', line 43

def expiration_date
  @expiration_date
end

#highest_level_cage_code ⇒ Object

Read-Only

Identifies the highest-level CAGE Code associated with a given organization.



52
53
54
 
# File 'lib/emass_client/models/cmmc_get.rb', line 52

def highest_level_cage_code
  @highest_level_cage_code
end

#hq_organization_name ⇒ Object

Read-Only

The name of the DIB Company.



22
23
24
 
# File 'lib/emass_client/models/cmmc_get.rb', line 22

def hq_organization_name
  @hq_organization_name
end

#model_version ⇒ Object

Read-Only

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



49
50
51
 
# File 'lib/emass_client/models/cmmc_get.rb', line 49

def model_version
  @model_version
end

#operation ⇒ Object

Read-Only

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



19
20
21
 
# File 'lib/emass_client/models/cmmc_get.rb', line 19

def operation
  @operation
end

#osc_assessment_official_email ⇒ Object

Read-Only

Email of the company official contracting with the C3PAO for the assessment.



70
71
72
 
# File 'lib/emass_client/models/cmmc_get.rb', line 70

def osc_assessment_official_email
  @osc_assessment_official_email
end

#osc_assessment_official_first_name ⇒ Object

Read-Only

First name of the company official contracting with the C3PAO for the assessment.



67
68
69
 
# File 'lib/emass_client/models/cmmc_get.rb', line 67

def osc_assessment_official_first_name
  @osc_assessment_official_first_name
end

#osc_assessment_official_last_name ⇒ Object

Read-Only

Last name of the company official contracting with the C3PAO for the assessment.



64
65
66
 
# File 'lib/emass_client/models/cmmc_get.rb', line 64

def osc_assessment_official_last_name
  @osc_assessment_official_last_name
end

#osc_assessment_official_title ⇒ Object

Read-Only

Title of the company official contracting with the C3PAO for the assessment.



73
74
75
 
# File 'lib/emass_client/models/cmmc_get.rb', line 73

def osc_assessment_official_title
  @osc_assessment_official_title
end

#osc_name ⇒ Object

Read-Only

The name of the Organization Seeking Certification.



31
32
33
 
# File 'lib/emass_client/models/cmmc_get.rb', line 31

def osc_name
  @osc_name
end

#overall_score ⇒ Object

Read-Only

Identifies the overall calculated score for the assessment based on the assigned values to each applicable security requirement.



61
62
63
 
# File 'lib/emass_client/models/cmmc_get.rb', line 61

def overall_score
  @overall_score
end

#poam ⇒ Object

Read-Only

Identifies whether any security requirements received a POA&M during the assessment.



58
59
60
 
# File 'lib/emass_client/models/cmmc_get.rb', line 58

def poam
  @poam
end

#scope ⇒ Object

Read-Only

The scope of the OSC assessment.



34
35
36
 
# File 'lib/emass_client/models/cmmc_get.rb', line 34

def scope
  @scope
end

#scope_description ⇒ Object

Read-Only

Brief description of the scope of the OSC assessment



37
38
39
 
# File 'lib/emass_client/models/cmmc_get.rb', line 37

def scope_description
  @scope_description
end

#ssps ⇒ Object

Returns the value of attribute ssps.



75
76
77
 
# File 'lib/emass_client/models/cmmc_get.rb', line 75

def ssps
  @ssps
end

#uei ⇒ Object

Read-Only

The Unique Entity Identifier assigned to the DIB Company.



25
26
27
 
# File 'lib/emass_client/models/cmmc_get.rb', line 25

def uei
  @uei
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



126
127
128
 
# File 'lib/emass_client/models/cmmc_get.rb', line 126

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/emass_client/models/cmmc_get.rb', line 100

def self.attribute_map
  {
    :'operation' => :'operation',
    :'hq_organization_name' => :'hqOrganizationName',
    :'uei' => :'uei',
    :'cage_codes_in_scope' => :'cageCodesInScope',
    :'osc_name' => :'oscName',
    :'scope' => :'scope',
    :'scope_description' => :'scopeDescription',
    :'awarded_cmmc_level' => :'awardedCMMCLevel',
    :'expiration_date' => :'expirationDate',
    :'assessment_id' => :'assessmentId',
    :'model_version' => :'modelVersion',
    :'highest_level_cage_code' => :'highestLevelCageCode',
    :'certification_unique_id' => :'certificationUniqueId',
    :'poam' => :'poam',
    :'overall_score' => :'overallScore',
    :'osc_assessment_official_last_name' => :'oscAssessmentOfficialLastName',
    :'osc_assessment_official_first_name' => :'oscAssessmentOfficialFirstName',
    :'osc_assessment_official_email' => :'oscAssessmentOfficialEmail',
    :'osc_assessment_official_title' => :'oscAssessmentOfficialTitle',
    :'ssps' => :'ssps'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



346
347
348
 
# File 'lib/emass_client/models/cmmc_get.rb', line 346

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/emass_client/models/cmmc_get.rb', line 157

def self.openapi_nullable
  Set.new([
    :'operation',
    :'hq_organization_name',
    :'uei',
    :'cage_codes_in_scope',
    :'osc_name',
    :'scope',
    :'scope_description',
    :'awarded_cmmc_level',
    :'expiration_date',
    :'assessment_id',
    :'model_version',
    :'highest_level_cage_code',
    :'certification_unique_id',
    :'poam',
    :'osc_assessment_official_last_name',
    :'osc_assessment_official_first_name',
    :'osc_assessment_official_email',
    :'osc_assessment_official_title',
    :'ssps'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/emass_client/models/cmmc_get.rb', line 131

def self.openapi_types
  {
    :'operation' => :'String',
    :'hq_organization_name' => :'String',
    :'uei' => :'String',
    :'cage_codes_in_scope' => :'String',
    :'osc_name' => :'String',
    :'scope' => :'String',
    :'scope_description' => :'String',
    :'awarded_cmmc_level' => :'String',
    :'expiration_date' => :'Integer',
    :'assessment_id' => :'String',
    :'model_version' => :'String',
    :'highest_level_cage_code' => :'String',
    :'certification_unique_id' => :'String',
    :'poam' => :'Boolean',
    :'overall_score' => :'Integer',
    :'osc_assessment_official_last_name' => :'String',
    :'osc_assessment_official_first_name' => :'String',
    :'osc_assessment_official_email' => :'String',
    :'osc_assessment_official_title' => :'String',
    :'ssps' => :'Array<Ssps>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/emass_client/models/cmmc_get.rb', line 306

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      operation == o.operation &&
      hq_organization_name == o.hq_organization_name &&
      uei == o.uei &&
      cage_codes_in_scope == o.cage_codes_in_scope &&
      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 &&
      assessment_id == o.assessment_id &&
      model_version == o.model_version &&
      highest_level_cage_code == o.highest_level_cage_code &&
      certification_unique_id == o.certification_unique_id &&
      poam == o.poam &&
      overall_score == o.overall_score &&
      osc_assessment_official_last_name == o.osc_assessment_official_last_name &&
      osc_assessment_official_first_name == o.osc_assessment_official_first_name &&
      osc_assessment_official_email == o.osc_assessment_official_email &&
      osc_assessment_official_title == o.osc_assessment_official_title &&
      ssps == o.ssps
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/emass_client/models/cmmc_get.rb', line 377

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = EmassClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/emass_client/models/cmmc_get.rb', line 448

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/emass_client/models/cmmc_get.rb', line 353

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


333
334
335
 
# File 'lib/emass_client/models/cmmc_get.rb', line 333

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



339
340
341
 
# File 'lib/emass_client/models/cmmc_get.rb', line 339

def hash
  [operation, hq_organization_name, uei, cage_codes_in_scope, osc_name, scope, scope_description, awarded_cmmc_level, expiration_date, assessment_id, model_version, highest_level_cage_code, certification_unique_id, poam, overall_score, osc_assessment_official_last_name, osc_assessment_official_first_name, osc_assessment_official_email, osc_assessment_official_title, ssps].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



281
282
283
284
 
# File 'lib/emass_client/models/cmmc_get.rb', line 281

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



424
425
426
 
# File 'lib/emass_client/models/cmmc_get.rb', line 424

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/emass_client/models/cmmc_get.rb', line 430

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



418
419
420
 
# File 'lib/emass_client/models/cmmc_get.rb', line 418

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



288
289
290
291
292
 
# File 'lib/emass_client/models/cmmc_get.rb', line 288

def valid?
  operation_validator = EnumAttributeValidator.new('String', ["ADDED", "UPDATED", "DELETED", "unknown_default_open_api"])
  return false unless operation_validator.valid?(@operation)
  true
end