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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
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
# File 'lib/emass_client/models/cmmc_get.rb', line 142

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

Instance Attribute Details

#awarded_cmmc_levelObject

Read-Only

The CMMC award level.



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

def awarded_cmmc_level
  @awarded_cmmc_level
end

#cage_codesObject

Read-Only

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



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

def cage_codes
  @cage_codes
end

#certificate_idObject

Read-Only

Unique identifier for the assessment/certificate.



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

def certificate_id
  @certificate_id
end

#dunsObject

Read-Only

The Data Universal Numbering System (DUNS) number.



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

def duns
  @duns
end

#expiration_dateObject

Read-Only

Expiration date of the awarded CMMC certification.



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

def expiration_date
  @expiration_date
end

#hq_organization_nameObject

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_versionObject

Read-Only

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



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

def model_version
  @model_version
end

#operationObject

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_nameObject

Read-Only

The name of the Organization Seeking Certification.



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

def osc_name
  @osc_name
end

#scopeObject

Read-Only

The scope of the OSC assessment.



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

def scope
  @scope
end

#scope_descriptionObject

Read-Only

Brief description of the scope of the OSC assessment



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

def scope_description
  @scope_description
end

#sspsObject

Returns the value of attribute ssps.



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

def ssps
  @ssps
end

#unique_entity_identifierObject

Read-Only

The Unique Entity Identifier assigned to the DIB Company.



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

def unique_entity_identifier
  @unique_entity_identifier
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



98
99
100
# File 'lib/emass_client/models/cmmc_get.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/emass_client/models/cmmc_get.rb', line 79

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

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



270
271
272
# File 'lib/emass_client/models/cmmc_get.rb', line 270

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

.openapi_nullableObject

List of attributes with nullable: true



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/emass_client/models/cmmc_get.rb', line 122

def self.openapi_nullable
  Set.new([
    :'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'
  ])
end

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    :'operation' => :'String',
    :'hq_organization_name' => :'String',
    :'duns' => :'String',
    :'unique_entity_identifier' => :'String',
    :'cage_codes' => :'String',
    :'osc_name' => :'String',
    :'scope' => :'String',
    :'scope_description' => :'String',
    :'awarded_cmmc_level' => :'String',
    :'expiration_date' => :'Integer',
    :'certificate_id' => :'String',
    :'model_version' => :'String',
    :'ssps' => :'Array<Ssps>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/emass_client/models/cmmc_get.rb', line 237

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

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'lib/emass_client/models/cmmc_get.rb', line 301

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



372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'lib/emass_client/models/cmmc_get.rb', line 372

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'lib/emass_client/models/cmmc_get.rb', line 277

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


257
258
259
# File 'lib/emass_client/models/cmmc_get.rb', line 257

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



263
264
265
# File 'lib/emass_client/models/cmmc_get.rb', line 263

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_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



212
213
214
215
# File 'lib/emass_client/models/cmmc_get.rb', line 212

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



348
349
350
# File 'lib/emass_client/models/cmmc_get.rb', line 348

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



342
343
344
# File 'lib/emass_client/models/cmmc_get.rb', line 342

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



219
220
221
222
223
# File 'lib/emass_client/models/cmmc_get.rb', line 219

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