Class: EmassClient::ArtifactsResponseGetDataInner

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ArtifactsResponseGetDataInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
232
233
234
235
236
 
# File 'lib/emass_client/models/artifacts_response_get_data_inner.rb', line 155

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assessment_procedures ⇒ Object

Optional

The Security Control Assessment Procedure being associated with the artifact.



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

def assessment_procedures
  @assessment_procedures
end

#category ⇒ Object

Required

Artifact category options



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

def category
  @category
end

#ccis ⇒ Object

Read-Only

CCI mapping for Assessment Procedures associated with the artifact.



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

def ccis
  @ccis
end

#controls ⇒ Object

Optional

Control acronym associated with the artifact. NIST SP 800-53 Revision 4 defined.



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

def controls
  @controls
end

#description ⇒ Object

Optional

Artifact description. 10,000 Characters.



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

def description
  @description
end

#expiration_date ⇒ Object

Optional

Date Artifact expires and requires review. In Unix Date format.



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

def expiration_date
  @expiration_date
end

#file_size ⇒ Object

Read-Only

File size of attached artifact.



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

def file_size
  @file_size
end

#filename ⇒ Object

Required

File name should match exactly one file within the provided zip file. 1000 Characters. or Application/zip file. Max 30MB per artifact.



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

def filename
  @filename
end

#is_inherited ⇒ Object

Read-only

Indicates whether an artifact is inherited.



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

def is_inherited
  @is_inherited
end

#is_template ⇒ Object

Required

Indicates whether an artifact template.



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

def is_template
  @is_template
end

#last_reviewed_date ⇒ Object

Optional

Date Artifact was last reviewed. Unix time format.



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

def last_reviewed_date
  @last_reviewed_date
end

#mime_content_type ⇒ Object

Read-Only

Standard MIME content type derived from file extension.



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

def mime_content_type
  @mime_content_type
end

#name ⇒ Object

Optional

Artifact name. Character Limit = 100.



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

def name
  @name
end

#reference_page_number ⇒ Object

Optional

Artifact reference page number. 50 Characters.



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

def reference_page_number
  @reference_page_number
end

#signed_date ⇒ Object

Optional

Date artifact was signed. Unix time format.



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

def signed_date
  @signed_date
end

#system_id ⇒ Object

Required

Unique eMASS system identifier.



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

def system_id
  @system_id
end

#type ⇒ Object

Required

Artifact type options



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

def type
  @type
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



316
317
318
319
320
321
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
 
# File 'lib/emass_client/models/artifacts_response_get_data_inner.rb', line 316

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



93
94
95
 
# File 'lib/emass_client/models/artifacts_response_get_data_inner.rb', line 93

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/emass_client/models/artifacts_response_get_data_inner.rb', line 70

def self.attribute_map
  {
    :'system_id' => :'systemId',
    :'filename' => :'filename',
    :'is_template' => :'isTemplate',
    :'type' => :'type',
    :'category' => :'category',
    :'is_inherited' => :'isInherited',
    :'ccis' => :'ccis',
    :'mime_content_type' => :'mimeContentType',
    :'file_size' => :'fileSize',
    :'name' => :'name',
    :'description' => :'description',
    :'reference_page_number' => :'referencePageNumber',
    :'assessment_procedures' => :'assessmentProcedures',
    :'controls' => :'controls',
    :'expiration_date' => :'expirationDate',
    :'last_reviewed_date' => :'lastReviewedDate',
    :'signed_date' => :'signedDate'
  }
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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/emass_client/models/artifacts_response_get_data_inner.rb', line 292

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

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'ArtifactsIds',
  :'ArtifactsOptionalFields',
  :'ArtifactsReadOnlyFields',
  :'ArtifactsRequiredFields'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/emass_client/models/artifacts_response_get_data_inner.rb', line 126

def self.openapi_nullable
  Set.new([
    :'is_template',
    :'is_inherited',
    :'ccis',
    :'mime_content_type',
    :'file_size',
    :'name',
    :'description',
    :'reference_page_number',
    :'controls',
    :'expiration_date',
    :'last_reviewed_date',
    :'signed_date'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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/artifacts_response_get_data_inner.rb', line 103

def self.openapi_types
  {
    :'system_id' => :'Integer',
    :'filename' => :'String',
    :'is_template' => :'Boolean',
    :'type' => :'String',
    :'category' => :'String',
    :'is_inherited' => :'Boolean',
    :'ccis' => :'String',
    :'mime_content_type' => :'String',
    :'file_size' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'reference_page_number' => :'String',
    :'assessment_procedures' => :'String',
    :'controls' => :'String',
    :'expiration_date' => :'Integer',
    :'last_reviewed_date' => :'Integer',
    :'signed_date' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/emass_client/models/artifacts_response_get_data_inner.rb', line 255

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      system_id == o.system_id &&
      filename == o.filename &&
      is_template == o.is_template &&
      type == o.type &&
      category == o.category &&
      is_inherited == o.is_inherited &&
      ccis == o.ccis &&
      mime_content_type == o.mime_content_type &&
      file_size == o.file_size &&
      name == o.name &&
      description == o.description &&
      reference_page_number == o.reference_page_number &&
      assessment_procedures == o.assessment_procedures &&
      controls == o.controls &&
      expiration_date == o.expiration_date &&
      last_reviewed_date == o.last_reviewed_date &&
      signed_date == o.signed_date
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



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/emass_client/models/artifacts_response_get_data_inner.rb', line 387

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


279
280
281
 
# File 'lib/emass_client/models/artifacts_response_get_data_inner.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [system_id, filename, is_template, type, category, is_inherited, ccis, mime_content_type, file_size, name, description, reference_page_number, assessment_procedures, controls, expiration_date, last_reviewed_date, signed_date].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



240
241
242
243
244
 
# File 'lib/emass_client/models/artifacts_response_get_data_inner.rb', line 240

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



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

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



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/emass_client/models/artifacts_response_get_data_inner.rb', line 369

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



357
358
359
 
# File 'lib/emass_client/models/artifacts_response_get_data_inner.rb', line 357

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



248
249
250
251
 
# File 'lib/emass_client/models/artifacts_response_get_data_inner.rb', line 248

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end