Class: Falcon::ExecutionsActivityExecutionResult

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExecutionsActivityExecutionResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Falcon::ExecutionsActivityExecutionResult` 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::ExecutionsActivityExecutionResult`. 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?(:'end_timestamp')
    self.end_timestamp = attributes[:'end_timestamp']
  end

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

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

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

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

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

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

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

  if attributes.key?(:'result')
    self.result = attributes[:'result']
  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?(:'type')
    self.type = attributes[:'type']
  end
end

Instance Attribute Details

#end_timestamp ⇒ Object

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



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

def end_timestamp
  @end_timestamp
end

#error_code ⇒ Object

When a node execution is in an error status this field is present and provides an error code that can be used to determine details why the failure occurred.



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

def error_code
  @error_code
end

#error_message ⇒ Object

When a node execution is in an error status this field is present and provides a user friendly error message.



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

def error_message
  @error_message
end

#id ⇒ Object

The unique identifier of the selected activity that is being configured.



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

def id
  @id
end

#mocked ⇒ Object

Whether this node’s result is mocked



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

def mocked
  @mocked
end

#name ⇒ Object

Optional user provided name for the activity, if not specified a default of the name for that activity will be used.



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

def name
  @name
end

#node_id ⇒ Object

Unique id of the node as specified in the definition.



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

def node_id
  @node_id
end

#references ⇒ Object

A set of objects which provide references to other URLs related to the activity execution.



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

def references
  @references
end

#result ⇒ Object

Result fields of activity execution.



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

def result
  @result
end

#start_timestamp ⇒ Object

Timestamp of when the execution first started.



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

def start_timestamp
  @start_timestamp
end

#status ⇒ Object

Current status of execution for the activity.



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

def status
  @status
end

#type ⇒ Object

Root element of the execution route of the activity



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 72

def self.attribute_map
  {
    :'end_timestamp' => :'end_timestamp',
    :'error_code' => :'error_code',
    :'error_message' => :'error_message',
    :'id' => :'id',
    :'mocked' => :'mocked',
    :'name' => :'name',
    :'node_id' => :'node_id',
    :'references' => :'references',
    :'result' => :'result',
    :'start_timestamp' => :'start_timestamp',
    :'status' => :'status',
    :'type' => :'type'
  }
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



261
262
263
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 261

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 113

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 95

def self.openapi_types
  {
    :'end_timestamp' => :'Time',
    :'error_code' => :'Integer',
    :'error_message' => :'String',
    :'id' => :'String',
    :'mocked' => :'Boolean',
    :'name' => :'String',
    :'node_id' => :'String',
    :'references' => :'Array<ExecutionsReferenceLink>',
    :'result' => :'Object',
    :'start_timestamp' => :'Time',
    :'status' => :'String',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      end_timestamp == o.end_timestamp &&
      error_code == o.error_code &&
      error_message == o.error_message &&
      id == o.id &&
      mocked == o.mocked &&
      name == o.name &&
      node_id == o.node_id &&
      references == o.references &&
      result == o.result &&
      start_timestamp == o.start_timestamp &&
      status == o.status &&
      type == o.type
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



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
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 292

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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 363

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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 268

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


248
249
250
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 248

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



254
255
256
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 254

def hash
  [end_timestamp, error_code, error_message, id, mocked, name, node_id, references, result, start_timestamp, status, type].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



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

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

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

  if @node_id.nil?
    invalid_properties.push('invalid value for "node_id", node_id 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 @type.nil?
    invalid_properties.push('invalid value for "type", type 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



339
340
341
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 339

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 345

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



333
334
335
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 333

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



217
218
219
220
221
222
223
224
225
 
# File 'lib/crimson-falcon/models/executions_activity_execution_result.rb', line 217

def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @node_id.nil?
  return false if @start_timestamp.nil?
  return false if @status.nil?
  return false if @type.nil?
  true
end