Class: IntersightClient::WorkflowRollbackWorkflow

Inherits:
MoBaseMo
  • Object
show all
Defined in:
lib/intersight_client/models/workflow_rollback_workflow.rb

Overview

Rollback workflow contains details about the workflow instance, tasks to be rollback along with the status and workflow instances.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkflowRollbackWorkflow

Initializes the object

Parameters:

  • (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
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 129

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::WorkflowRollbackWorkflow` 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.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'workflow.RollbackWorkflow'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'workflow.RollbackWorkflow'
  end

  if attributes.key?(:'action')
    self.action = attributes[:'action']
  else
    self.action = 'None'
  end

  if attributes.key?(:'continue_on_task_failure')
    self.continue_on_task_failure = attributes[:'continue_on_task_failure']
  else
    self.continue_on_task_failure = true
  end

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

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

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

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

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

Instance Attribute Details

#action ⇒ Object

The action of the rollback workflow such as Create and Start. * ‘None` - If no action is set, then the default value is set to none for the action field. * `Create` - Create rollback workflow data for the execution of the rollback workflow. * `Start` - Start a new execution of the rollback workflow.



26
27
28
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 26

def action
  @action
end

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 20

def class_id
  @class_id
end

#continue_on_task_failure ⇒ Object

When set to true, if a task in the workflow fails, the rollback workflow continues to the subsequent task. When set to false, the rollback workflow execution halts if a task fails.



29
30
31
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 29

def continue_on_task_failure
  @continue_on_task_failure
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 23

def object_type
  @object_type
end

#primary_workflow ⇒ Object

Returns the value of attribute primary_workflow.



38
39
40
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 38

def primary_workflow
  @primary_workflow
end

#rollback_tasks ⇒ Object

Returns the value of attribute rollback_tasks.



31
32
33
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 31

def rollback_tasks
  @rollback_tasks
end

#rollback_workflows ⇒ Object

An array of relationships to workflowWorkflowInfo resources.



41
42
43
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 41

def rollback_workflows
  @rollback_workflows
end

#selected_tasks ⇒ Object

Returns the value of attribute selected_tasks.



33
34
35
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 33

def selected_tasks
  @selected_tasks
end

#status ⇒ Object

Status of the rollback workflow instance (Created, Running, Completed, Failed). * ‘None` - If no status is set, then the default value is set none for the status field. * `Created` - Status of the rollback workflow when it identifies the eligible tasks for rollback. * `Running` - Status of the rollback workflow when it is in-progress. * `Completed` - Status of the rollback workflow after execution is successful. * `Failed` - Status of the rollback workflow after execution results in failure.



36
37
38
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 36

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



86
87
88
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 86

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



81
82
83
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 81

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 66

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'action' => :'Action',
    :'continue_on_task_failure' => :'ContinueOnTaskFailure',
    :'rollback_tasks' => :'RollbackTasks',
    :'selected_tasks' => :'SelectedTasks',
    :'status' => :'Status',
    :'primary_workflow' => :'PrimaryWorkflow',
    :'rollback_workflows' => :'RollbackWorkflows'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



300
301
302
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 300

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



115
116
117
118
119
120
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 115

def self.openapi_all_of
  [
  :'MoBaseMo',
  :'WorkflowRollbackWorkflowAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



123
124
125
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 123

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
110
111
112
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 106

def self.openapi_nullable
  Set.new([
    :'rollback_tasks',
    :'selected_tasks',
    :'rollback_workflows'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 91

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'action' => :'String',
    :'continue_on_task_failure' => :'Boolean',
    :'rollback_tasks' => :'Array<WorkflowRollbackWorkflowTask>',
    :'selected_tasks' => :'Array<WorkflowRollbackWorkflowTask>',
    :'status' => :'String',
    :'primary_workflow' => :'WorkflowWorkflowInfoRelationship',
    :'rollback_workflows' => :'Array<WorkflowWorkflowInfoRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      action == o.action &&
      continue_on_task_failure == o.continue_on_task_failure &&
      rollback_tasks == o.rollback_tasks &&
      selected_tasks == o.selected_tasks &&
      status == o.status &&
      primary_workflow == o.primary_workflow &&
      rollback_workflows == o.rollback_workflows && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



331
332
333
334
335
336
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
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 331

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 = IntersightClient.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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 402

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 307

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  WorkflowRollbackWorkflow.openapi_types.each_pair do |key, type|
    if attributes[WorkflowRollbackWorkflow.attribute_map[key]].nil? && WorkflowRollbackWorkflow.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[WorkflowRollbackWorkflow.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[WorkflowRollbackWorkflow.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[WorkflowRollbackWorkflow.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[WorkflowRollbackWorkflow.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


287
288
289
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 287

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



293
294
295
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 293

def hash
  [class_id, object_type, action, continue_on_task_failure, rollback_tasks, selected_tasks, status, primary_workflow, rollback_workflows].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



200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 200

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



378
379
380
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 378

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 384

def to_hash
  hash = super
  WorkflowRollbackWorkflow.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = WorkflowRollbackWorkflow.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 presentation of the object



372
373
374
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 372

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/intersight_client/models/workflow_rollback_workflow.rb', line 215

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["workflow.RollbackWorkflow"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["workflow.RollbackWorkflow"])
  return false unless object_type_validator.valid?(@object_type)
  action_validator = EnumAttributeValidator.new('String', ["None", "Create", "Start"])
  return false unless action_validator.valid?(@action)
  status_validator = EnumAttributeValidator.new('String', ["None", "Created", "Running", "Completed", "Failed"])
  return false unless status_validator.valid?(@status)
  true && super
end