Class: PureCloud::SchedulingRunResponse

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

Overview

Information containing details of a schedule run

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SchedulingRunResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  
  if attributes.has_key?(:'state')
    
    
    self.state = attributes[:'state']
    
  
  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?(:'scheduleId')
    
    
    self.schedule_id = attributes[:'scheduleId']
    
  
  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

  
end

Instance Attribute Details

#percent_complete ⇒ Object

Completion percentage of the schedule run



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 29

def percent_complete
  @percent_complete
end

#run_id ⇒ Object

ID of the schedule run



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

def run_id
  @run_id
end

#schedule_description ⇒ Object

Description of the schedule run



38
39
40
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 38

def schedule_description
  @schedule_description
end

#schedule_id ⇒ Object

ID of the schedule



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 35

def schedule_id
  @schedule_id
end

#scheduling_canceled_by ⇒ Object

User that canceled the schedule run



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 47

def scheduling_canceled_by
  @scheduling_canceled_by
end

#scheduling_completed_time ⇒ Object

Time at which the scheduling run was completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



50
51
52
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 50

def scheduling_completed_time
  @scheduling_completed_time
end

#scheduling_start_time ⇒ Object

Start time of the schedule run. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 41

def scheduling_start_time
  @scheduling_start_time
end

#scheduling_started_by ⇒ Object

User that started the schedule run



44
45
46
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 44

def scheduling_started_by
  @scheduling_started_by
end

#state ⇒ Object

Status of the schedule run



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 26

def state
  @state
end

#target_week ⇒ Object

The start date of the week for which the scheduling is done in yyyy-MM-dd format



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 32

def target_week
  @target_week
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 53

def self.attribute_map
  {
    
    :'run_id' => :'runId',
    
    :'state' => :'state',
    
    :'percent_complete' => :'percentComplete',
    
    :'target_week' => :'targetWeek',
    
    :'schedule_id' => :'scheduleId',
    
    :'schedule_description' => :'scheduleDescription',
    
    :'scheduling_start_time' => :'schedulingStartTime',
    
    :'scheduling_started_by' => :'schedulingStartedBy',
    
    :'scheduling_canceled_by' => :'schedulingCanceledBy',
    
    :'scheduling_completed_time' => :'schedulingCompletedTime'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'run_id' => :'String',
    
    :'state' => :'String',
    
    :'percent_complete' => :'Float',
    
    :'target_week' => :'String',
    
    :'schedule_id' => :'String',
    
    :'schedule_description' => :'String',
    
    :'scheduling_start_time' => :'DateTime',
    
    :'scheduling_started_by' => :'UserReference',
    
    :'scheduling_canceled_by' => :'UserReference',
    
    :'scheduling_completed_time' => :'DateTime'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 329

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      run_id == o.run_id &&
      state == o.state &&
      percent_complete == o.percent_complete &&
      target_week == o.target_week &&
      schedule_id == o.schedule_id &&
      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
end

#_deserialize(type, value) ⇒ Object 



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
405
406
407
408
409
410
411
412
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 376

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



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 436

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



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 357

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



352
353
354
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 352

def hash
  [run_id, state, percent_complete, target_week, schedule_id, schedule_description, scheduling_start_time, scheduling_started_by, scheduling_canceled_by, scheduling_completed_time].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



209
210
211
212
213
214
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 209

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



419
420
421
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 419

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



424
425
426
427
428
429
430
431
432
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 424

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 



414
415
416
 
# File 'lib/purecloudplatformclientv2/models/scheduling_run_response.rb', line 414

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



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

def valid?
  
  
  
  
  
  
  
  allowed_values = ["None", "Queued", "Scheduling", "Canceled", "Failed", "Complete"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end