Class: PureCloud::RecordingJob
- Inherits:
-
Object
- Object
- PureCloud::RecordingJob
- Defined in:
- lib/purecloudplatformclientv2/models/recording_job.rb
Instance Attribute Summary collapse
-
#date_created ⇒ Object
Date when the job was created.
-
#error_message ⇒ Object
Error occurred during the job execution.
-
#id ⇒ Object
The globally unique identifier for the object.
-
#percent_progress ⇒ Object
Progress in percentage based on the number of recordings.
-
#recording_jobs_query ⇒ Object
Original query of the job.
-
#self_uri ⇒ Object
The URI for this object.
-
#state ⇒ Object
The current state of the job.
-
#total_conversations ⇒ Object
Total number of conversations affected.
-
#total_processed_recordings ⇒ Object
Total number of recordings have been processed.
-
#total_recordings ⇒ Object
Total number of recordings affected.
-
#user ⇒ Object
Details of the user created the job.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
- #_deserialize(type, value) ⇒ Object
-
#_to_hash(value) ⇒ Object
Method to output non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
build the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ RecordingJob
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Object
to_body is an alias to to_body (backward compatibility)).
-
#to_hash ⇒ Object
return the object in the form of hash.
- #to_s ⇒ Object
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ RecordingJob
Initializes the object
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 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 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 114 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?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'recordingJobsQuery') self.recording_jobs_query = attributes[:'recordingJobsQuery'] end if attributes.has_key?(:'dateCreated') self.date_created = attributes[:'dateCreated'] end if attributes.has_key?(:'totalConversations') self.total_conversations = attributes[:'totalConversations'] end if attributes.has_key?(:'totalRecordings') self.total_recordings = attributes[:'totalRecordings'] end if attributes.has_key?(:'totalProcessedRecordings') self.total_processed_recordings = attributes[:'totalProcessedRecordings'] end if attributes.has_key?(:'percentProgress') self.percent_progress = attributes[:'percentProgress'] end if attributes.has_key?(:'errorMessage') self. = attributes[:'errorMessage'] end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end if attributes.has_key?(:'user') self.user = attributes[:'user'] end end |
Instance Attribute Details
#date_created ⇒ Object
Date when the job was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
31 32 33 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 31 def date_created @date_created end |
#error_message ⇒ Object
Error occurred during the job execution
46 47 48 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 46 def @error_message end |
#id ⇒ Object
The globally unique identifier for the object.
22 23 24 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 22 def id @id end |
#percent_progress ⇒ Object
Progress in percentage based on the number of recordings
43 44 45 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 43 def percent_progress @percent_progress end |
#recording_jobs_query ⇒ Object
Original query of the job.
28 29 30 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 28 def recording_jobs_query @recording_jobs_query end |
#self_uri ⇒ Object
The URI for this object
49 50 51 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 49 def self_uri @self_uri end |
#state ⇒ Object
The current state of the job.
25 26 27 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 25 def state @state end |
#total_conversations ⇒ Object
Total number of conversations affected.
34 35 36 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 34 def total_conversations @total_conversations end |
#total_processed_recordings ⇒ Object
Total number of recordings have been processed.
40 41 42 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 40 def total_processed_recordings @total_processed_recordings end |
#total_recordings ⇒ Object
Total number of recordings affected.
37 38 39 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 37 def total_recordings @total_recordings end |
#user ⇒ Object
Details of the user created the job
52 53 54 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 52 def user @user end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 55 def self.attribute_map { :'id' => :'id', :'state' => :'state', :'recording_jobs_query' => :'recordingJobsQuery', :'date_created' => :'dateCreated', :'total_conversations' => :'totalConversations', :'total_recordings' => :'totalRecordings', :'total_processed_recordings' => :'totalProcessedRecordings', :'percent_progress' => :'percentProgress', :'error_message' => :'errorMessage', :'self_uri' => :'selfUri', :'user' => :'user' } end |
.swagger_types ⇒ Object
Attribute type mapping.
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 84 def self.swagger_types { :'id' => :'String', :'state' => :'String', :'recording_jobs_query' => :'RecordingJobsQuery', :'date_created' => :'DateTime', :'total_conversations' => :'Integer', :'total_recordings' => :'Integer', :'total_processed_recordings' => :'Integer', :'percent_progress' => :'Integer', :'error_message' => :'String', :'self_uri' => :'String', :'user' => :'AddressableEntityRef' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 358 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && state == o.state && recording_jobs_query == o.recording_jobs_query && date_created == o.date_created && total_conversations == o.total_conversations && total_recordings == o.total_recordings && total_processed_recordings == o.total_processed_recordings && percent_progress == o.percent_progress && == o. && self_uri == o.self_uri && user == o.user end |
#_deserialize(type, value) ⇒ Object
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 406 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
466 467 468 469 470 471 472 473 474 475 476 477 478 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 466 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
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 387 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
376 377 378 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 376 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
382 383 384 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 382 def hash [id, state, recording_jobs_query, date_created, total_conversations, total_recordings, total_processed_recordings, percent_progress, , self_uri, user].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
224 225 226 227 228 229 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 224 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))
449 450 451 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 449 def to_body to_hash end |
#to_hash ⇒ Object
return the object in the form of hash
454 455 456 457 458 459 460 461 462 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 454 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
444 445 446 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 444 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
233 234 235 236 237 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 |
# File 'lib/purecloudplatformclientv2/models/recording_job.rb', line 233 def valid? if @state.nil? return false end allowed_values = ["FULFILLED", "PENDING", "READY", "PROCESSING", "CANCELLED", "FAILED"] if @state && !allowed_values.include?(@state) return false end end |