Class: PureCloud::BuScheduleRun
- Inherits:
-
Object
- Object
- PureCloud::BuScheduleRun
- Defined in:
- lib/purecloudplatformclientv2/models/bu_schedule_run.rb
Instance Attribute Summary collapse
-
#id ⇒ Object
The globally unique identifier for the object.
-
#intraday_rescheduling ⇒ Object
Whether this is an intraday rescheduling run.
-
#message_count ⇒ Object
The number of schedule generation messages for this schedule generation run.
-
#percent_complete ⇒ Object
Percent completion of the schedule run.
-
#rescheduling_options ⇒ Object
Rescheduling options for this run.
-
#rescheduling_result_expiration ⇒ Object
When the reschedule result will expire.
-
#schedule ⇒ Object
The generated schedule.
-
#schedule_description ⇒ Object
The description of the generated schedule.
-
#scheduler_run_id ⇒ Object
The scheduler run ID.
-
#scheduling_canceled_by ⇒ Object
The user who canceled the scheduling run, if applicable.
-
#scheduling_completed_time ⇒ Object
When the scheduling run was completed, if applicable.
-
#scheduling_start_time ⇒ Object
When the schedule generation run started.
-
#scheduling_started_by ⇒ Object
The user who started the scheduling run.
-
#self_uri ⇒ Object
The URI for this object.
-
#state ⇒ Object
The state of the generation run.
-
#target_week ⇒ Object
The start date of the target week.
-
#week_count ⇒ Object
The number of weeks spanned by the schedule.
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 = {}) ⇒ BuScheduleRun
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 = {}) ⇒ BuScheduleRun
Initializes the object
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 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 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 156 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?(:'schedulerRunId') self.scheduler_run_id = attributes[:'schedulerRunId'] end if attributes.has_key?(:'intradayRescheduling') self.intraday_rescheduling = attributes[:'intradayRescheduling'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'weekCount') self.week_count = attributes[:'weekCount'] end if attributes.has_key?(:'percentComplete') self.percent_complete = attributes[:'percentComplete'] end if attributes.has_key?(:'targetWeek') self.target_week = attributes[:'targetWeek'] end if attributes.has_key?(:'schedule') self.schedule = attributes[:'schedule'] end if attributes.has_key?(:'scheduleDescription') self.schedule_description = attributes[:'scheduleDescription'] end if attributes.has_key?(:'schedulingStartTime') self.scheduling_start_time = attributes[:'schedulingStartTime'] end if attributes.has_key?(:'schedulingStartedBy') self.scheduling_started_by = attributes[:'schedulingStartedBy'] end if attributes.has_key?(:'schedulingCanceledBy') self.scheduling_canceled_by = attributes[:'schedulingCanceledBy'] end if attributes.has_key?(:'schedulingCompletedTime') self.scheduling_completed_time = attributes[:'schedulingCompletedTime'] end if attributes.has_key?(:'messageCount') self. = attributes[:'messageCount'] end if attributes.has_key?(:'reschedulingOptions') self. = attributes[:'reschedulingOptions'] end if attributes.has_key?(:'reschedulingResultExpiration') self.rescheduling_result_expiration = attributes[:'reschedulingResultExpiration'] end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end |
Instance Attribute Details
#id ⇒ Object
The globally unique identifier for the object.
22 23 24 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 22 def id @id end |
#intraday_rescheduling ⇒ Object
Whether this is an intraday rescheduling run
28 29 30 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 28 def intraday_rescheduling @intraday_rescheduling end |
#message_count ⇒ Object
The number of schedule generation messages for this schedule generation run
61 62 63 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 61 def @message_count end |
#percent_complete ⇒ Object
Percent completion of the schedule run
37 38 39 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 37 def percent_complete @percent_complete end |
#rescheduling_options ⇒ Object
Rescheduling options for this run. Null unless intradayRescheduling is true
64 65 66 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 64 def @rescheduling_options end |
#rescheduling_result_expiration ⇒ Object
When the reschedule result will expire. Null unless intradayRescheduling is true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
67 68 69 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 67 def rescheduling_result_expiration @rescheduling_result_expiration end |
#schedule ⇒ Object
The generated schedule. Null unless the schedule run is complete
43 44 45 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 43 def schedule @schedule end |
#schedule_description ⇒ Object
The description of the generated schedule
46 47 48 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 46 def schedule_description @schedule_description end |
#scheduler_run_id ⇒ Object
The scheduler run ID. Reference this value for support
25 26 27 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 25 def scheduler_run_id @scheduler_run_id end |
#scheduling_canceled_by ⇒ Object
The user who canceled the scheduling run, if applicable
55 56 57 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 55 def scheduling_canceled_by @scheduling_canceled_by end |
#scheduling_completed_time ⇒ Object
When the scheduling run was completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
58 59 60 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 58 def scheduling_completed_time @scheduling_completed_time end |
#scheduling_start_time ⇒ Object
When the schedule generation run started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
49 50 51 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 49 def scheduling_start_time @scheduling_start_time end |
#scheduling_started_by ⇒ Object
The user who started the scheduling run
52 53 54 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 52 def scheduling_started_by @scheduling_started_by end |
#self_uri ⇒ Object
The URI for this object
70 71 72 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 70 def self_uri @self_uri end |
#state ⇒ Object
The state of the generation run
31 32 33 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 31 def state @state end |
#target_week ⇒ Object
The start date of the target week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
40 41 42 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 40 def target_week @target_week end |
#week_count ⇒ Object
The number of weeks spanned by the schedule
34 35 36 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 34 def week_count @week_count end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
73 74 75 76 77 78 79 80 81 82 83 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 111 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 73 def self.attribute_map { :'id' => :'id', :'scheduler_run_id' => :'schedulerRunId', :'intraday_rescheduling' => :'intradayRescheduling', :'state' => :'state', :'week_count' => :'weekCount', :'percent_complete' => :'percentComplete', :'target_week' => :'targetWeek', :'schedule' => :'schedule', :'schedule_description' => :'scheduleDescription', :'scheduling_start_time' => :'schedulingStartTime', :'scheduling_started_by' => :'schedulingStartedBy', :'scheduling_canceled_by' => :'schedulingCanceledBy', :'scheduling_completed_time' => :'schedulingCompletedTime', :'message_count' => :'messageCount', :'rescheduling_options' => :'reschedulingOptions', :'rescheduling_result_expiration' => :'reschedulingResultExpiration', :'self_uri' => :'selfUri' } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 114 def self.swagger_types { :'id' => :'String', :'scheduler_run_id' => :'String', :'intraday_rescheduling' => :'BOOLEAN', :'state' => :'String', :'week_count' => :'Integer', :'percent_complete' => :'Float', :'target_week' => :'Date', :'schedule' => :'BuScheduleReference', :'schedule_description' => :'String', :'scheduling_start_time' => :'DateTime', :'scheduling_started_by' => :'UserReference', :'scheduling_canceled_by' => :'UserReference', :'scheduling_completed_time' => :'DateTime', :'message_count' => :'Integer', :'rescheduling_options' => :'ReschedulingOptionsRunResponse', :'rescheduling_result_expiration' => :'DateTime', :'self_uri' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 503 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && scheduler_run_id == o.scheduler_run_id && intraday_rescheduling == o.intraday_rescheduling && state == o.state && week_count == o.week_count && percent_complete == o.percent_complete && target_week == o.target_week && schedule == o.schedule && schedule_description == o.schedule_description && scheduling_start_time == o.scheduling_start_time && scheduling_started_by == o.scheduling_started_by && scheduling_canceled_by == o.scheduling_canceled_by && scheduling_completed_time == o.scheduling_completed_time && == o. && == o. && rescheduling_result_expiration == o.rescheduling_result_expiration && self_uri == o.self_uri end |
#_deserialize(type, value) ⇒ Object
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 557 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
617 618 619 620 621 622 623 624 625 626 627 628 629 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 617 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
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 538 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
527 528 529 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 527 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
533 534 535 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 533 def hash [id, scheduler_run_id, intraday_rescheduling, state, week_count, percent_complete, target_week, schedule, schedule_description, scheduling_start_time, scheduling_started_by, scheduling_canceled_by, scheduling_completed_time, , , rescheduling_result_expiration, self_uri].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
320 321 322 323 324 325 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 320 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))
600 601 602 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 600 def to_body to_hash end |
#to_hash ⇒ Object
return the object in the form of hash
605 606 607 608 609 610 611 612 613 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 605 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
595 596 597 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 595 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
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 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/purecloudplatformclientv2/models/bu_schedule_run.rb', line 329 def valid? allowed_values = ["None", "Queued", "Scheduling", "Canceled", "Failed", "Complete"] if @state && !allowed_values.include?(@state) return false end end |