Class: PureCloud::DataTableImportJob

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/data_table_import_job.rb

Overview

State information for an import job of rows to a datatable

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataTableImportJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 128

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

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

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

  
  if attributes.has_key?(:'owner')
    
    
    self.owner = attributes[:'owner']
    
  
  end

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

  
  if attributes.has_key?(:'dateCreated')
    
    
    self.date_created = attributes[:'dateCreated']
    
  
  end

  
  if attributes.has_key?(:'dateCompleted')
    
    
    self.date_completed = attributes[:'dateCompleted']
    
  
  end

  
  if attributes.has_key?(:'uploadURI')
    
    
    self.upload_uri = attributes[:'uploadURI']
    
  
  end

  
  if attributes.has_key?(:'importMode')
    
    
    self.import_mode = attributes[:'importMode']
    
  
  end

  
  if attributes.has_key?(:'errorInformation')
    
    
    self.error_information = attributes[:'errorInformation']
    
  
  end

  
  if attributes.has_key?(:'countRecordsUpdated')
    
    
    self.count_records_updated = attributes[:'countRecordsUpdated']
    
  
  end

  
  if attributes.has_key?(:'countRecordsDeleted')
    
    
    self.count_records_deleted = attributes[:'countRecordsDeleted']
    
  
  end

  
  if attributes.has_key?(:'countRecordsFailed')
    
    
    self.count_records_failed = attributes[:'countRecordsFailed']
    
  
  end

  
  if attributes.has_key?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  end

  
end

Instance Attribute Details

#count_records_deleted ⇒ Object

The current count of the number of records deleted



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 52

def count_records_deleted
  @count_records_deleted
end

#count_records_failed ⇒ Object

The current count of the number of records that failed to import



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 55

def count_records_failed
  @count_records_failed
end

#count_records_updated ⇒ Object

The current count of the number of records processed



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 49

def count_records_updated
  @count_records_updated
end

#date_completed ⇒ Object

The timestamp of when the import stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 37

def date_completed
  @date_completed
end

#date_created ⇒ Object

The timestamp of when the import began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 34

def date_created
  @date_created
end

#error_information ⇒ Object

Any error information, or null of the processing is not in an error state



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 46

def error_information
  @error_information
end

#id ⇒ Object

The globally unique identifier for the object.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 23

def id
  @id
end

#import_mode ⇒ Object

The indication of whether the processing should remove rows that don’t appear in the import file



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 43

def import_mode
  @import_mode
end

#name ⇒ Object

Returns the value of attribute name.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 25

def name
  @name
end

#owner ⇒ Object

The PureCloud user who started the import job



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 28

def owner
  @owner
end

#self_uri ⇒ Object

The URI for this object



58
59
60
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 58

def self_uri
  @self_uri
end

#status ⇒ Object

The status of the import job



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 31

def status
  @status
end

#upload_uri ⇒ Object

The URL of the location at which the caller can upload the file to be imported



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 40

def upload_uri
  @upload_uri
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 61

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'owner' => :'owner',
    
    :'status' => :'status',
    
    :'date_created' => :'dateCreated',
    
    :'date_completed' => :'dateCompleted',
    
    :'upload_uri' => :'uploadURI',
    
    :'import_mode' => :'importMode',
    
    :'error_information' => :'errorInformation',
    
    :'count_records_updated' => :'countRecordsUpdated',
    
    :'count_records_deleted' => :'countRecordsDeleted',
    
    :'count_records_failed' => :'countRecordsFailed',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 94

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'owner' => :'AddressableEntityRef',
    
    :'status' => :'String',
    
    :'date_created' => :'DateTime',
    
    :'date_completed' => :'DateTime',
    
    :'upload_uri' => :'String',
    
    :'import_mode' => :'String',
    
    :'error_information' => :'ErrorBody',
    
    :'count_records_updated' => :'Integer',
    
    :'count_records_deleted' => :'Integer',
    
    :'count_records_failed' => :'Integer',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 422

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      owner == o.owner &&
      status == o.status &&
      date_created == o.date_created &&
      date_completed == o.date_completed &&
      upload_uri == o.upload_uri &&
      import_mode == o.import_mode &&
      error_information == o.error_information &&
      count_records_updated == o.count_records_updated &&
      count_records_deleted == o.count_records_deleted &&
      count_records_failed == o.count_records_failed &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 472

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 532

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

build the object from hash



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 453

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


442
443
444
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 442

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



448
449
450
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 448

def hash
  [id, name, owner, status, date_created, date_completed, upload_uri, import_mode, error_information, count_records_updated, count_records_deleted, count_records_failed, self_uri].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



256
257
258
259
260
261
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 256

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



515
516
517
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 515

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



520
521
522
523
524
525
526
527
528
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 520

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



510
511
512
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 510

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



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
294
295
296
297
298
299
300
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
 
# File 'lib/purecloudplatformclientv2/models/data_table_import_job.rb', line 265

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @status.nil?
    return false
  end

  
  
  allowed_values = ["WaitingForUpload", "Processing", "Failed", "Succeeded"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["ReplaceAll", "Append"]
  if @import_mode && !allowed_values.include?(@import_mode)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end