Class: Falcon::ExecutionsExecutionResult

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/models/executions_execution_result.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExecutionsExecutionResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/crimson-falcon/models/executions_execution_result.rb', line 129

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Falcon::ExecutionsExecutionResult` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Falcon::ExecutionsExecutionResult`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'activities')
    if (value = attributes[:'activities']).is_a?(Array)
      self.activities = value
    end
  end

  if attributes.key?(:'ancestor_executions')
    if (value = attributes[:'ancestor_executions']).is_a?(Array)
      self.ancestor_executions = value
    end
  end

  if attributes.key?(:'definition_id')
    self.definition_id = attributes[:'definition_id']
  end

  if attributes.key?(:'definition_version')
    self.definition_version = attributes[:'definition_version']
  end

  if attributes.key?(:'end_timestamp')
    self.end_timestamp = attributes[:'end_timestamp']
  end

  if attributes.key?(:'execution_id')
    self.execution_id = attributes[:'execution_id']
  end

  if attributes.key?(:'flows')
    if (value = attributes[:'flows']).is_a?(Array)
      self.flows = value
    end
  end

  if attributes.key?(:'loops')
    if (value = attributes[:'loops']).is_a?(Array)
      self.loops = value
    end
  end

  if attributes.key?(:'output_data')
    self.output_data = attributes[:'output_data']
  end

  if attributes.key?(:'retryable')
    self.retryable = attributes[:'retryable']
  end

  if attributes.key?(:'start_timestamp')
    self.start_timestamp = attributes[:'start_timestamp']
  end

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

  if attributes.key?(:'summary')
    self.summary = attributes[:'summary']
  end

  if attributes.key?(:'trigger')
    self.trigger = attributes[:'trigger']
  end
end

Instance Attribute Details

#activities ⇒ Object

Details for the result of each activity node.



36
37
38
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 36

def activities
  @activities
end

#ancestor_executions ⇒ Object

Populated when the execution origin is from a sub model.



39
40
41
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 39

def ancestor_executions
  @ancestor_executions
end

#definition_id ⇒ Object

Unique id of the workflow the execution is associated with.



42
43
44
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 42

def definition_id
  @definition_id
end

#definition_version ⇒ Object

Version of the definition that executed.



45
46
47
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 45

def definition_version
  @definition_version
end

#end_timestamp ⇒ Object

Timestamp of when the execution completed. Only present when status is an end state.



48
49
50
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 48

def end_timestamp
  @end_timestamp
end

#execution_id ⇒ Object

Unique id generated for the execution.



51
52
53
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 51

def execution_id
  @execution_id
end

#flows ⇒ Object

Details for the result of each flow node.



54
55
56
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 54

def flows
  @flows
end

#loops ⇒ Object

Details for the results of each loop in the workflow definition.



57
58
59
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 57

def loops
  @loops
end

#output_data ⇒ Object

Output from this workflow execution



60
61
62
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 60

def output_data
  @output_data
end

#retryable ⇒ Object

A boolean value indicating whether the failed workflow execution is retryable



63
64
65
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 63

def retryable
  @retryable
end

#start_timestamp ⇒ Object

Timestamp of when the execution first started.



66
67
68
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 66

def start_timestamp
  @start_timestamp
end

#status ⇒ Object

Overall status for the execution.



69
70
71
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 69

def status
  @status
end

#summary ⇒ Object

Execution summary if defined in the workflow definition



72
73
74
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 72

def summary
  @summary
end

#trigger ⇒ Object

Returns the value of attribute trigger.



74
75
76
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 74

def trigger
  @trigger
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 77

def self.attribute_map
  {
    :'activities' => :'activities',
    :'ancestor_executions' => :'ancestor_executions',
    :'definition_id' => :'definition_id',
    :'definition_version' => :'definition_version',
    :'end_timestamp' => :'end_timestamp',
    :'execution_id' => :'execution_id',
    :'flows' => :'flows',
    :'loops' => :'loops',
    :'output_data' => :'output_data',
    :'retryable' => :'retryable',
    :'start_timestamp' => :'start_timestamp',
    :'status' => :'status',
    :'summary' => :'summary',
    :'trigger' => :'trigger'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



306
307
308
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 306

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 122

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 102

def self.openapi_types
  {
    :'activities' => :'Array<ExecutionsActivityExecutionResult>',
    :'ancestor_executions' => :'Array<ExecutionsAncestorExecution>',
    :'definition_id' => :'String',
    :'definition_version' => :'Integer',
    :'end_timestamp' => :'Time',
    :'execution_id' => :'String',
    :'flows' => :'Array<ExecutionsFlowExecutionResult>',
    :'loops' => :'Array<ExecutionsLoopResult>',
    :'output_data' => :'Object',
    :'retryable' => :'Boolean',
    :'start_timestamp' => :'Time',
    :'status' => :'String',
    :'summary' => :'String',
    :'trigger' => :'ExecutionsTriggerResult'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 272

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activities == o.activities &&
      ancestor_executions == o.ancestor_executions &&
      definition_id == o.definition_id &&
      definition_version == o.definition_version &&
      end_timestamp == o.end_timestamp &&
      execution_id == o.execution_id &&
      flows == o.flows &&
      loops == o.loops &&
      output_data == o.output_data &&
      retryable == o.retryable &&
      start_timestamp == o.start_timestamp &&
      status == o.status &&
      summary == o.summary &&
      trigger == o.trigger
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 337

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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 =~ /\A(true|t|yes|y|1)\z/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
    # models (e.g. Pet) or oneOf
    klass = Falcon.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 408

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 313

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


293
294
295
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



299
300
301
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 299

def hash
  [activities, ancestor_executions, definition_id, definition_version, end_timestamp, execution_id, flows, loops, output_data, retryable, start_timestamp, status, summary, trigger].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 209

def list_invalid_properties
  invalid_properties = Array.new
  if @activities.nil?
    invalid_properties.push('invalid value for "activities", activities cannot be nil.')
  end

  if @ancestor_executions.nil?
    invalid_properties.push('invalid value for "ancestor_executions", ancestor_executions cannot be nil.')
  end

  if @definition_id.nil?
    invalid_properties.push('invalid value for "definition_id", definition_id cannot be nil.')
  end

  if @definition_version.nil?
    invalid_properties.push('invalid value for "definition_version", definition_version cannot be nil.')
  end

  if @execution_id.nil?
    invalid_properties.push('invalid value for "execution_id", execution_id cannot be nil.')
  end

  if @loops.nil?
    invalid_properties.push('invalid value for "loops", loops cannot be nil.')
  end

  if @retryable.nil?
    invalid_properties.push('invalid value for "retryable", retryable cannot be nil.')
  end

  if @start_timestamp.nil?
    invalid_properties.push('invalid value for "start_timestamp", start_timestamp cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @trigger.nil?
    invalid_properties.push('invalid value for "trigger", trigger cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



384
385
386
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 384

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 390

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



378
379
380
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 378

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



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/crimson-falcon/models/executions_execution_result.rb', line 256

def valid?
  return false if @activities.nil?
  return false if @ancestor_executions.nil?
  return false if @definition_id.nil?
  return false if @definition_version.nil?
  return false if @execution_id.nil?
  return false if @loops.nil?
  return false if @retryable.nil?
  return false if @start_timestamp.nil?
  return false if @status.nil?
  return false if @trigger.nil?
  true
end