Class: PureCloud::BatchDownloadJobResult

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchDownloadJobResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
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
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
164
165
166
167
168
169
170
171
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 92

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?(:'conversationId')
    
    
    self.conversation_id = attributes[:'conversationId']
    
  
  end

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

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

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

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

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

  
end

Instance Attribute Details

#content_type ⇒ Object

Content type of this result



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 36

def content_type
  @content_type
end

#conversation_id ⇒ Object

Conversation id of the result



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 27

def conversation_id
  @conversation_id
end

#error_msg ⇒ Object

An error message, in case of failed processing will indicate the cause of the failure



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 39

def error_msg
  @error_msg
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 22

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 24

def name
  @name
end

#recording_id ⇒ Object

Recording id of the result



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 30

def recording_id
  @recording_id
end

#result_url ⇒ Object

URL of results… HTTP GET from this location to download results for this item



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 33

def result_url
  @result_url
end

#self_uri ⇒ Object

The URI for this object



42
43
44
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 42

def self_uri
  @self_uri
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 45

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'conversation_id' => :'conversationId',
    
    :'recording_id' => :'recordingId',
    
    :'result_url' => :'resultUrl',
    
    :'content_type' => :'contentType',
    
    :'error_msg' => :'errorMsg',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 68

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'conversation_id' => :'String',
    
    :'recording_id' => :'String',
    
    :'result_url' => :'String',
    
    :'content_type' => :'String',
    
    :'error_msg' => :'String',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 263

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      conversation_id == o.conversation_id &&
      recording_id == o.recording_id &&
      result_url == o.result_url &&
      content_type == o.content_type &&
      error_msg == o.error_msg &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 308

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 368

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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 289

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


278
279
280
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 278

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



284
285
286
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 284

def hash
  [id, name, conversation_id, recording_id, result_url, content_type, error_msg, 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



175
176
177
178
179
180
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 175

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))



351
352
353
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 351

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



356
357
358
359
360
361
362
363
364
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 356

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 



346
347
348
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 346

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



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
 
# File 'lib/purecloudplatformclientv2/models/batch_download_job_result.rb', line 184

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end