Class: EmassClient::PoamOptionalFields

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PoamOptionalFields

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 154

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `EmassClient::PoamOptionalFields` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `EmassClient::PoamOptionalFields`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assessment_procedure ⇒ Object

Optional

The Security Control Assessment Procedure being associated with the POA&M Item.



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

def assessment_procedure
  @assessment_procedure
end

#control_acronym ⇒ Object

Optional

Control acronym associated with the POA&M Item. NIST SP 800-53 Revision 4 defined.



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

def control_acronym
  @control_acronym
end

#devices_affected ⇒ Object

Optional

List any affected devices by hostname. If all devices in the information system are affected, state ‘system’ or ‘all’. Navy only



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

def devices_affected
  @devices_affected
end

#external_uid ⇒ Object

Optional

Unique identifier external to the eMASS application for use with associating POA&Ms. 100 Characters.



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

def external_uid
  @external_uid
end

#impact ⇒ Object

Optional

Values include the following options (Very Low, Low, Moderate,High,Very High)



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

def impact
  @impact
end

#impact_description ⇒ Object

Optional

Include description of Security Control’s impact.



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

def impact_description
  @impact_description
end

#likelihood ⇒ Object

Optional

Values include the following options (Very Low, Low, Moderate,High,Very High)



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

def likelihood
  @likelihood
end

#mitigations ⇒ Object

Optional

Include mitigation explanation. 2000 Characters.



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

def mitigations
  @mitigations
end

#predisposing_conditions ⇒ Object

Optional

A predisposing condition is a condition existing within an organization, a mission or business process, enterprise architecture, information system/PIT, or environment of operation, which affects (i.e., increases or decreases) the likelihood that threat events, once initiated, result in adverse impacts. Navy only.



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

def predisposing_conditions
  @predisposing_conditions
end

#raw_severity ⇒ Object

Optional

Scan vulnerability ratting Values include the following options: (Very Low, Low, Moderate,High,Very High)



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

def raw_severity
  @raw_severity
end

#recommendations ⇒ Object

Optional

Include recommendations. Character Limit = 2,000.



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

def recommendations
  @recommendations
end

#relevance_of_threat ⇒ Object

Optional

Values include the following options (Very Low, Low, Moderate,High,Very High)



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

def relevance_of_threat
  @relevance_of_threat
end

#residual_risk_level ⇒ Object

Optional

Values include the following options (Very Low, Low, Moderate,High,Very High)



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

def residual_risk_level
  @residual_risk_level
end

#resulting_residual_risk_level_after_proposed_mitigations ⇒ Object

Optional

Indicate the risk level expected after any proposed mitigations are implemented. Proposed mitigations should be appropriately documented as POA&M milestones. Navy only.



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

def resulting_residual_risk_level_after_proposed_mitigations
  @resulting_residual_risk_level_after_proposed_mitigations
end

#security_checks ⇒ Object

Optional

Security Checks that are associated with the POA&M.



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

def security_checks
  @security_checks
end

#threat_description ⇒ Object

Optional

Describe the identified threat(s) and relevance to the information system. Navy only.



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

def threat_description
  @threat_description
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 322

def self._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_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



111
112
113
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 111

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



116
117
118
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 116

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 89

def self.attribute_map
  {
    :'external_uid' => :'externalUid',
    :'control_acronym' => :'controlAcronym',
    :'assessment_procedure' => :'assessmentProcedure',
    :'security_checks' => :'securityChecks',
    :'raw_severity' => :'rawSeverity',
    :'relevance_of_threat' => :'relevanceOfThreat',
    :'likelihood' => :'likelihood',
    :'impact' => :'impact',
    :'impact_description' => :'impactDescription',
    :'residual_risk_level' => :'residualRiskLevel',
    :'recommendations' => :'recommendations',
    :'mitigations' => :'mitigations',
    :'resulting_residual_risk_level_after_proposed_mitigations' => :'resultingResidualRiskLevelAfterProposedMitigations',
    :'predisposing_conditions' => :'predisposingConditions',
    :'threat_description' => :'threatDescription',
    :'devices_affected' => :'devicesAffected'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 298

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



143
144
145
146
147
148
149
150
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 143

def self.openapi_nullable
  Set.new([
    :'resulting_residual_risk_level_after_proposed_mitigations',
    :'predisposing_conditions',
    :'threat_description',
    :'devices_affected'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'external_uid' => :'String',
    :'control_acronym' => :'String',
    :'assessment_procedure' => :'String',
    :'security_checks' => :'String',
    :'raw_severity' => :'String',
    :'relevance_of_threat' => :'String',
    :'likelihood' => :'String',
    :'impact' => :'String',
    :'impact_description' => :'String',
    :'residual_risk_level' => :'String',
    :'recommendations' => :'String',
    :'mitigations' => :'String',
    :'resulting_residual_risk_level_after_proposed_mitigations' => :'String',
    :'predisposing_conditions' => :'String',
    :'threat_description' => :'String',
    :'devices_affected' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      external_uid == o.external_uid &&
      control_acronym == o.control_acronym &&
      assessment_procedure == o.assessment_procedure &&
      security_checks == o.security_checks &&
      raw_severity == o.raw_severity &&
      relevance_of_threat == o.relevance_of_threat &&
      likelihood == o.likelihood &&
      impact == o.impact &&
      impact_description == o.impact_description &&
      residual_risk_level == o.residual_risk_level &&
      recommendations == o.recommendations &&
      mitigations == o.mitigations &&
      resulting_residual_risk_level_after_proposed_mitigations == o.resulting_residual_risk_level_after_proposed_mitigations &&
      predisposing_conditions == o.predisposing_conditions &&
      threat_description == o.threat_description &&
      devices_affected == o.devices_affected
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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 393

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

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


285
286
287
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 285

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



291
292
293
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 291

def hash
  [external_uid, control_acronym, assessment_procedure, security_checks, raw_severity, relevance_of_threat, likelihood, impact, impact_description, residual_risk_level, recommendations, mitigations, resulting_residual_risk_level_after_proposed_mitigations, predisposing_conditions, threat_description, devices_affected].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



235
236
237
238
239
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 235

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



369
370
371
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 369

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 375

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 presentation of the object



363
364
365
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 363

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • true if the model is valid



243
244
245
246
247
248
 
# File 'lib/emass_client/models/poam_optional_fields.rb', line 243

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  resulting_residual_risk_level_after_proposed_mitigations_validator = EnumAttributeValidator.new('String', ["Very Low", "Low", "Moderate", "High", "Very High", "unknown_default_open_api"])
  return false unless resulting_residual_risk_level_after_proposed_mitigations_validator.valid?(@resulting_residual_risk_level_after_proposed_mitigations)
  true
end