Class: EmassClient::ControlsConditionalFields

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ControlsConditionalFields

Initializes the object

Parameters:

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

    Model attributes in the form of hash



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 118

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `EmassClient::ControlsConditionalFields` 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::ControlsConditionalFields`. 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?(:'common_control_provider')
    self.common_control_provider = attributes[:'common_control_provider']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#common_control_provider ⇒ Object

Conditional

Indicate the type of Common Control Provider for an Inherited Security Control.



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

def common_control_provider
  @common_control_provider
end

#na_justification ⇒ Object

Conditional

Provide justification for Security Controls deemed Not Applicable to the system.



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

def na_justification
  @na_justification
end

#slcm_comments ⇒ Object

Conditional

Additional comments for Security Control regarding SLCM. Character Limit = 4,000.



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

def slcm_comments
  @slcm_comments
end

#slcm_criticality ⇒ Object

Conditional

Criticality of Security Control regarding SLCM. Character Limit = 2,000.



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

def slcm_criticality
  @slcm_criticality
end

#slcm_frequency ⇒ Object

Conditional

SLCM frequency



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

def slcm_frequency
  @slcm_frequency
end

#slcm_method ⇒ Object

Conditional

SLCM method utilized



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

def slcm_method
  @slcm_method
end

#slcm_reporting ⇒ Object

Conditional

Method for reporting Security Control for SLCM. Character Limit = 2,000.



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

def slcm_reporting
  @slcm_reporting
end

#slcm_tracking ⇒ Object

Conditional

How Non-Compliant Security Controls will be tracked for SLCM. Character Limit = 2,000.



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

def slcm_tracking
  @slcm_tracking
end

Class Method Details

._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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 270

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



79
80
81
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 79

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 84

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 65

def self.attribute_map
  {
    :'common_control_provider' => :'commonControlProvider',
    :'na_justification' => :'naJustification',
    :'slcm_criticality' => :'slcmCriticality',
    :'slcm_frequency' => :'slcmFrequency',
    :'slcm_method' => :'slcmMethod',
    :'slcm_reporting' => :'slcmReporting',
    :'slcm_tracking' => :'slcmTracking',
    :'slcm_comments' => :'slcmComments'
  }
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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 246

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



103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 103

def self.openapi_nullable
  Set.new([
    :'common_control_provider',
    :'na_justification',
    :'slcm_criticality',
    :'slcm_frequency',
    :'slcm_method',
    :'slcm_reporting',
    :'slcm_tracking',
    :'slcm_comments'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 89

def self.openapi_types
  {
    :'common_control_provider' => :'String',
    :'na_justification' => :'String',
    :'slcm_criticality' => :'String',
    :'slcm_frequency' => :'String',
    :'slcm_method' => :'String',
    :'slcm_reporting' => :'String',
    :'slcm_tracking' => :'String',
    :'slcm_comments' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 218

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      common_control_provider == o.common_control_provider &&
      na_justification == o.na_justification &&
      slcm_criticality == o.slcm_criticality &&
      slcm_frequency == o.slcm_frequency &&
      slcm_method == o.slcm_method &&
      slcm_reporting == o.slcm_reporting &&
      slcm_tracking == o.slcm_tracking &&
      slcm_comments == o.slcm_comments
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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 341

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:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


233
234
235
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



239
240
241
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 239

def hash
  [common_control_provider, na_justification, slcm_criticality, slcm_frequency, slcm_method, slcm_reporting, slcm_tracking, slcm_comments].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



167
168
169
170
171
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 167

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:

  • (Hash) —

    Returns the object in the form of hash



317
318
319
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 317

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 323

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



311
312
313
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 311

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



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/emass_client/models/controls_conditional_fields.rb', line 175

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  common_control_provider_validator = EnumAttributeValidator.new('String', ["DoD", "Component", "Enclave", "unknown_default_open_api"])
  return false unless common_control_provider_validator.valid?(@common_control_provider)
  slcm_frequency_validator = EnumAttributeValidator.new('String', ["Constantly", "Daily", "Weekly", "Monthly", "Quarterly", "Semi-Annually", "Annually", "Every Two Years", "Every Three Years", "Undetermined", "unknown_default_open_api"])
  return false unless slcm_frequency_validator.valid?(@slcm_frequency)
  slcm_method_validator = EnumAttributeValidator.new('String', ["Automated", "Semi-Automated", "Manual", "Undetermined", "unknown_default_open_api"])
  return false unless slcm_method_validator.valid?(@slcm_method)
  true
end