Class: CloudReactorAPIClient::Workflow

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudreactor_api_client/models/workflow.rb

Overview

Workflows are Tasks arranged in a directed graph. Configured Tasks are held by WorkflowTaskInstances, and WorkflowTransitions connect WorkflowTaskInstances together.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Workflow

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 126

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#alert_methods ⇒ Object

Returns the value of attribute alert_methods.



52
53
54
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 52

def alert_methods
  @alert_methods
end

#created_at ⇒ Object

Returns the value of attribute created_at.



48
49
50
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 48

def created_at
  @created_at
end

#created_by_group ⇒ Object

Returns the value of attribute created_by_group.



42
43
44
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 42

def created_by_group
  @created_by_group
end

#created_by_user ⇒ Object

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.



40
41
42
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 40

def created_by_user
  @created_by_user
end

#dashboard_url ⇒ Object

Returns the value of attribute dashboard_url.



27
28
29
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 27

def dashboard_url
  @dashboard_url
end

#default_max_retries ⇒ Object

Returns the value of attribute default_max_retries.



35
36
37
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 35

def default_max_retries
  @default_max_retries
end

#description ⇒ Object

Returns the value of attribute description.



25
26
27
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 25

def description
  @description
end

#enabled ⇒ Object

Returns the value of attribute enabled.



46
47
48
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 46

def enabled
  @enabled
end

#latest_workflow_execution ⇒ Object

Returns the value of attribute latest_workflow_execution.



37
38
39
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 37

def latest_workflow_execution
  @latest_workflow_execution
end

#max_age_seconds ⇒ Object

Returns the value of attribute max_age_seconds.



33
34
35
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 33

def max_age_seconds
  @max_age_seconds
end

#max_concurrency ⇒ Object

Returns the value of attribute max_concurrency.



31
32
33
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 31

def max_concurrency
  @max_concurrency
end

#name ⇒ Object

Returns the value of attribute name.



23
24
25
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 23

def name
  @name
end

#run_environment ⇒ Object

Returns the value of attribute run_environment.



44
45
46
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 44

def run_environment
  @run_environment
end

#schedule ⇒ Object

Returns the value of attribute schedule.



29
30
31
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 29

def schedule
  @schedule
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



50
51
52
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 50

def updated_at
  @updated_at
end

#url ⇒ Object

Returns the value of attribute url.



19
20
21
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 19

def url
  @url
end

#uuid ⇒ Object

Returns the value of attribute uuid.



21
22
23
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 21

def uuid
  @uuid
end

#workflow_task_instances ⇒ Object

Returns the value of attribute workflow_task_instances.



54
55
56
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 54

def workflow_task_instances
  @workflow_task_instances
end

#workflow_transitions ⇒ Object

Returns the value of attribute workflow_transitions.



56
57
58
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 56

def workflow_transitions
  @workflow_transitions
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 59

def self.attribute_map
  {
    :'url' => :'url',
    :'uuid' => :'uuid',
    :'name' => :'name',
    :'description' => :'description',
    :'dashboard_url' => :'dashboard_url',
    :'schedule' => :'schedule',
    :'max_concurrency' => :'max_concurrency',
    :'max_age_seconds' => :'max_age_seconds',
    :'default_max_retries' => :'default_max_retries',
    :'latest_workflow_execution' => :'latest_workflow_execution',
    :'created_by_user' => :'created_by_user',
    :'created_by_group' => :'created_by_group',
    :'run_environment' => :'run_environment',
    :'enabled' => :'enabled',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'alert_methods' => :'alert_methods',
    :'workflow_task_instances' => :'workflow_task_instances',
    :'workflow_transitions' => :'workflow_transitions'
  }
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



402
403
404
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 402

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
118
119
120
121
122
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 114

def self.openapi_nullable
  Set.new([
    :'max_concurrency',
    :'max_age_seconds',
    :'latest_workflow_execution',
    :'created_by_group',
    :'run_environment',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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/cloudreactor_api_client/models/workflow.rb', line 89

def self.openapi_types
  {
    :'url' => :'String',
    :'uuid' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'dashboard_url' => :'String',
    :'schedule' => :'String',
    :'max_concurrency' => :'Integer',
    :'max_age_seconds' => :'Integer',
    :'default_max_retries' => :'Integer',
    :'latest_workflow_execution' => :'WorkflowExecutionSummary',
    :'created_by_user' => :'String',
    :'created_by_group' => :'Group',
    :'run_environment' => :'NameAndUuid',
    :'enabled' => :'Boolean',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'alert_methods' => :'Array<NameAndUuid>',
    :'workflow_task_instances' => :'Array<WorkflowTaskInstance>',
    :'workflow_transitions' => :'Array<WorkflowTransition>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 363

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      url == o.url &&
      uuid == o.uuid &&
      name == o.name &&
      description == o.description &&
      dashboard_url == o.dashboard_url &&
      schedule == o.schedule &&
      max_concurrency == o.max_concurrency &&
      max_age_seconds == o.max_age_seconds &&
      default_max_retries == o.default_max_retries &&
      latest_workflow_execution == o.latest_workflow_execution &&
      created_by_user == o.created_by_user &&
      created_by_group == o.created_by_group &&
      run_environment == o.run_environment &&
      enabled == o.enabled &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      alert_methods == o.alert_methods &&
      workflow_task_instances == o.workflow_task_instances &&
      workflow_transitions == o.workflow_transitions
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



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 432

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 = CloudReactorAPIClient.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



503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 503

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



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 409

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


389
390
391
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 389

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



395
396
397
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 395

def hash
  [url, uuid, name, description, dashboard_url, schedule, max_concurrency, max_age_seconds, default_max_retries, latest_workflow_execution, created_by_user, created_by_group, run_environment, enabled, created_at, updated_at, alert_methods, workflow_task_instances, workflow_transitions].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



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
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 224

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

  if @name.to_s.length > 200
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
  end

  if !@description.nil? && @description.to_s.length > 5000
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 5000.')
  end

  if !@schedule.nil? && @schedule.to_s.length > 1000
    invalid_properties.push('invalid value for "schedule", the character length must be smaller than or equal to 1000.')
  end

  if !@max_concurrency.nil? && @max_concurrency > 2147483647
    invalid_properties.push('invalid value for "max_concurrency", must be smaller than or equal to 2147483647.')
  end

  if !@max_concurrency.nil? && @max_concurrency < -2147483648
    invalid_properties.push('invalid value for "max_concurrency", must be greater than or equal to -2147483648.')
  end

  if !@max_age_seconds.nil? && @max_age_seconds > 2147483647
    invalid_properties.push('invalid value for "max_age_seconds", must be smaller than or equal to 2147483647.')
  end

  if !@max_age_seconds.nil? && @max_age_seconds < -2147483648
    invalid_properties.push('invalid value for "max_age_seconds", must be greater than or equal to -2147483648.')
  end

  if !@default_max_retries.nil? && @default_max_retries > 2147483647
    invalid_properties.push('invalid value for "default_max_retries", must be smaller than or equal to 2147483647.')
  end

  if !@default_max_retries.nil? && @default_max_retries < -2147483648
    invalid_properties.push('invalid value for "default_max_retries", must be greater than or equal to -2147483648.')
  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



479
480
481
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 479

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



485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 485

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



473
474
475
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 473

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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/cloudreactor_api_client/models/workflow.rb', line 271

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 200
  return false if !@description.nil? && @description.to_s.length > 5000
  return false if !@schedule.nil? && @schedule.to_s.length > 1000
  return false if !@max_concurrency.nil? && @max_concurrency > 2147483647
  return false if !@max_concurrency.nil? && @max_concurrency < -2147483648
  return false if !@max_age_seconds.nil? && @max_age_seconds > 2147483647
  return false if !@max_age_seconds.nil? && @max_age_seconds < -2147483648
  return false if !@default_max_retries.nil? && @default_max_retries > 2147483647
  return false if !@default_max_retries.nil? && @default_max_retries < -2147483648
  true
end