Class: Falcon::DomainReportExecutionV1

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/models/domain_report_execution_v1.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainReportExecutionV1

Initializes the object

Parameters:

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

    Model attributes in the form of hash


140
141
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
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
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 140

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#can_writeObject

Returns the value of attribute can_write.


35
36
37
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 35

def can_write
  @can_write
end

#created_onObject

Returns the value of attribute created_on.


37
38
39
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 37

def created_on
  @created_on
end

#customer_idObject

Returns the value of attribute customer_id.


39
40
41
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 39

def customer_id
  @customer_id
end

#execution_metadataObject

Returns the value of attribute execution_metadata.


41
42
43
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 41

def 
  @execution_metadata
end

#expiration_onObject

Returns the value of attribute expiration_on.


43
44
45
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 43

def expiration_on
  @expiration_on
end

#idObject

Returns the value of attribute id.


45
46
47
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 45

def id
  @id
end

#job_referenceObject

Returns the value of attribute job_reference.


47
48
49
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 47

def job_reference
  @job_reference
end

#last_updated_onObject

Returns the value of attribute last_updated_on.


49
50
51
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 49

def last_updated_on
  @last_updated_on
end

#report_file_referenceObject

Returns the value of attribute report_file_reference.


51
52
53
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 51

def report_file_reference
  @report_file_reference
end

#result_metadataObject

Returns the value of attribute result_metadata.


53
54
55
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 53

def 
  @result_metadata
end

#scheduled_report_idObject

Returns the value of attribute scheduled_report_id.


55
56
57
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 55

def scheduled_report_id
  @scheduled_report_id
end

#shared_withObject

Returns the value of attribute shared_with.


57
58
59
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 57

def shared_with
  @shared_with
end

#statusObject

Returns the value of attribute status.


59
60
61
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 59

def status
  @status
end

#status_displayObject

Returns the value of attribute status_display.


61
62
63
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 61

def status_display
  @status_display
end

#status_msgObject

Returns the value of attribute status_msg.


63
64
65
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 63

def status_msg
  @status_msg
end

#trackingObject

Returns the value of attribute tracking.


65
66
67
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 65

def tracking
  @tracking
end

#trigger_referenceObject

Returns the value of attribute trigger_reference.


67
68
69
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 67

def trigger_reference
  @trigger_reference
end

#typeObject

Returns the value of attribute type.


69
70
71
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 69

def type
  @type
end

#user_idObject

Returns the value of attribute user_id.


71
72
73
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 71

def user_id
  @user_id
end

#user_uuidObject

Returns the value of attribute user_uuid.


73
74
75
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 73

def user_uuid
  @user_uuid
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about


102
103
104
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 102

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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


76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 76

def self.attribute_map
  {
    :'can_write' => :'can_write',
    :'created_on' => :'created_on',
    :'customer_id' => :'customer_id',
    :'execution_metadata' => :'execution_metadata',
    :'expiration_on' => :'expiration_on',
    :'id' => :'id',
    :'job_reference' => :'job_reference',
    :'last_updated_on' => :'last_updated_on',
    :'report_file_reference' => :'report_file_reference',
    :'result_metadata' => :'result_metadata',
    :'scheduled_report_id' => :'scheduled_report_id',
    :'shared_with' => :'shared_with',
    :'status' => :'status',
    :'status_display' => :'status_display',
    :'status_msg' => :'status_msg',
    :'tracking' => :'tracking',
    :'trigger_reference' => :'trigger_reference',
    :'type' => :'type',
    :'user_id' => :'user_id',
    :'user_uuid' => :'user_uuid'
  }
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


356
357
358
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 356

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

.openapi_nullableObject

List of attributes with nullable: true


133
134
135
136
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 133

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.


107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 107

def self.openapi_types
  {
    :'can_write' => :'Boolean',
    :'created_on' => :'Time',
    :'customer_id' => :'String',
    :'execution_metadata' => :'DomainExecutionMetadataV1',
    :'expiration_on' => :'Time',
    :'id' => :'String',
    :'job_reference' => :'String',
    :'last_updated_on' => :'Time',
    :'report_file_reference' => :'String',
    :'result_metadata' => :'DomainResultMetadata',
    :'scheduled_report_id' => :'String',
    :'shared_with' => :'Array<String>',
    :'status' => :'String',
    :'status_display' => :'String',
    :'status_msg' => :'String',
    :'tracking' => :'String',
    :'trigger_reference' => :'String',
    :'type' => :'String',
    :'user_id' => :'String',
    :'user_uuid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 316

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      can_write == o.can_write &&
      created_on == o.created_on &&
      customer_id == o.customer_id &&
       == o. &&
      expiration_on == o.expiration_on &&
      id == o.id &&
      job_reference == o.job_reference &&
      last_updated_on == o.last_updated_on &&
      report_file_reference == o.report_file_reference &&
       == o. &&
      scheduled_report_id == o.scheduled_report_id &&
      shared_with == o.shared_with &&
      status == o.status &&
      status_display == o.status_display &&
      status_msg == o.status_msg &&
      tracking == o.tracking &&
      trigger_reference == o.trigger_reference &&
      type == o.type &&
      user_id == o.user_id &&
      user_uuid == o.user_uuid
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


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
415
416
417
418
419
420
421
422
423
424
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 387

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 = Falcon.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


458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 458

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


363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 363

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

343
344
345
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 343

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


349
350
351
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 349

def hash
  [can_write, created_on, customer_id, , expiration_on, id, job_reference, last_updated_on, report_file_reference, , scheduled_report_id, shared_with, status, status_display, status_msg, tracking, trigger_reference, type, user_id, user_uuid].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 238

def list_invalid_properties
  invalid_properties = Array.new
  if @created_on.nil?
    invalid_properties.push('invalid value for "created_on", created_on cannot be nil.')
  end

  if @customer_id.nil?
    invalid_properties.push('invalid value for "customer_id", customer_id cannot be nil.')
  end

  if @expiration_on.nil?
    invalid_properties.push('invalid value for "expiration_on", expiration_on cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @last_updated_on.nil?
    invalid_properties.push('invalid value for "last_updated_on", last_updated_on cannot be nil.')
  end

  if @scheduled_report_id.nil?
    invalid_properties.push('invalid value for "scheduled_report_id", scheduled_report_id cannot be nil.')
  end

  if @shared_with.nil?
    invalid_properties.push('invalid value for "shared_with", shared_with cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @status_display.nil?
    invalid_properties.push('invalid value for "status_display", status_display cannot be nil.')
  end

  if @status_msg.nil?
    invalid_properties.push('invalid value for "status_msg", status_msg cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @user_id.nil?
    invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
  end

  if @user_uuid.nil?
    invalid_properties.push('invalid value for "user_uuid", user_uuid cannot be nil.')
  end

  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


434
435
436
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 434

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


440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 440

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


428
429
430
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 428

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


297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/crimson-falcon/models/domain_report_execution_v1.rb', line 297

def valid?
  return false if @created_on.nil?
  return false if @customer_id.nil?
  return false if @expiration_on.nil?
  return false if @id.nil?
  return false if @last_updated_on.nil?
  return false if @scheduled_report_id.nil?
  return false if @shared_with.nil?
  return false if @status.nil?
  return false if @status_display.nil?
  return false if @status_msg.nil?
  return false if @type.nil?
  return false if @user_id.nil?
  return false if @user_uuid.nil?
  true
end