Class: PureCloud::FlowRuntimeExecution

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

Overview

Details about the current state of a Flow execution

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FlowRuntimeExecution

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
221
222
223
 
# File 'lib/purecloudplatformclientv2/models/flow_runtime_execution.rb', line 115

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

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

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

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

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

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

  
  if attributes.has_key?(:'outputData')
    
    if (value = attributes[:'outputData']).is_a?(Array)
      self.output_data = value
    end
    
    
  
  end

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

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

  
end

Instance Attribute Details

#completion_reason ⇒ Object

The completion reason set at the flow completion time, if applicable.



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

def completion_reason
  @completion_reason
end

#conversation ⇒ Object

The conversation to which this Flow execution is related



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

def conversation
  @conversation
end

#date_completed ⇒ Object

The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def date_completed
  @date_completed
end

#date_launched ⇒ Object

The time the flow was launched. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def date_launched
  @date_launched
end

#flow_error_info ⇒ Object

Additional information if the flow is in error



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

def flow_error_info
  @flow_error_info
end

#flow_version ⇒ Object

The Version of the flow definition of the flow execution.



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

def flow_version
  @flow_version
end

#id ⇒ Object

The flow execution ID



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

def id
  @id
end

#name ⇒ Object

The flow execution name.



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

def name
  @name
end

#output_data ⇒ Object

List of the flow’s output variables, if any. Output variables are only supplied for Completed flows.



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

def output_data
  @output_data
end

#self_uri ⇒ Object

The URI for this object



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/flow_runtime_execution.rb', line 53

def self_uri
  @self_uri
end

#status ⇒ Object

The flow’s running status, which indicates whether the flow is running normally or completed, etc.



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

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



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
82
 
# File 'lib/purecloudplatformclientv2/models/flow_runtime_execution.rb', line 56

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'flow_version' => :'flowVersion',
    
    :'date_launched' => :'dateLaunched',
    
    :'status' => :'status',
    
    :'date_completed' => :'dateCompleted',
    
    :'completion_reason' => :'completionReason',
    
    :'flow_error_info' => :'flowErrorInfo',
    
    :'output_data' => :'outputData',
    
    :'conversation' => :'conversation',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/flow_runtime_execution.rb', line 85

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'flow_version' => :'FlowVersion',
    
    :'date_launched' => :'DateTime',
    
    :'status' => :'String',
    
    :'date_completed' => :'DateTime',
    
    :'completion_reason' => :'String',
    
    :'flow_error_info' => :'ErrorBody',
    
    :'output_data' => :'Hash<String, Object>',
    
    :'conversation' => :'DomainEntityRef',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/purecloudplatformclientv2/models/flow_runtime_execution.rb', line 371

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      flow_version == o.flow_version &&
      date_launched == o.date_launched &&
      status == o.status &&
      date_completed == o.date_completed &&
      completion_reason == o.completion_reason &&
      flow_error_info == o.flow_error_info &&
      output_data == o.output_data &&
      conversation == o.conversation &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/purecloudplatformclientv2/models/flow_runtime_execution.rb', line 419

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



479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/purecloudplatformclientv2/models/flow_runtime_execution.rb', line 479

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



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/purecloudplatformclientv2/models/flow_runtime_execution.rb', line 400

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


389
390
391
 
# File 'lib/purecloudplatformclientv2/models/flow_runtime_execution.rb', line 389

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



395
396
397
 
# File 'lib/purecloudplatformclientv2/models/flow_runtime_execution.rb', line 395

def hash
  [id, name, flow_version, date_launched, status, date_completed, completion_reason, flow_error_info, output_data, conversation, 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



227
228
229
230
231
232
 
# File 'lib/purecloudplatformclientv2/models/flow_runtime_execution.rb', line 227

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



462
463
464
 
# File 'lib/purecloudplatformclientv2/models/flow_runtime_execution.rb', line 462

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



467
468
469
470
471
472
473
474
475
 
# File 'lib/purecloudplatformclientv2/models/flow_runtime_execution.rb', line 467

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 



457
458
459
 
# File 'lib/purecloudplatformclientv2/models/flow_runtime_execution.rb', line 457

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



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

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

  
  
  
  
  
  if @date_launched.nil?
    return false
  end

  
  
  
  
  
  if @status.nil?
    return false
  end

  
  
  allowed_values = ["UNKNOWN", "RUNNING", "ERROR", "TERMINATED", "COMPLETED", "FAILED"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end