Class: IntersightClient::WorkflowPendingDynamicWorkflowInfo

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

Overview

Information for a pending Dynamic Workflow Instance before it is run. Validation needs to be done on the dynamic workflow tasks before starting. After it begins, it will be tracked with regular WorkflowInstance.

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 = {}) ⇒ WorkflowPendingDynamicWorkflowInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
224
225
226
227
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 150

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#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_pending_dynamic_workflow_info.rb', line 20

def class_id
  @class_id
end

#input ⇒ Object

The inputs of the workflow.



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

def input
  @input
end

#name ⇒ Object

A name for the pending dynamic workflow.



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

def name
  @name
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_pending_dynamic_workflow_info.rb', line 23

def object_type
  @object_type
end

#pending_services ⇒ Object

Returns the value of attribute pending_services.



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

def pending_services
  @pending_services
end

#src ⇒ Object

The src is workflow owner service.



34
35
36
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 34

def src
  @src
end

#status ⇒ Object

The current status of the PendingDynamicWorkflowInfo. * ‘GatheringTasks` - Dynamic workflow is gathering tasks before workflow can start execution. * `Waiting` - Dynamic workflow is in waiting state and not yet started execution.



37
38
39
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 37

def status
  @status
end

#wait_on_duplicate ⇒ Object

When set to true workflow engine will wait for a duplicate to finish before starting a new one.



40
41
42
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 40

def wait_on_duplicate
  @wait_on_duplicate
end

#workflow_action_task_lists ⇒ Object

Returns the value of attribute workflow_action_task_lists.



42
43
44
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 42

def workflow_action_task_lists
  @workflow_action_task_lists
end

#workflow_ctx ⇒ Object

Returns the value of attribute workflow_ctx.



44
45
46
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 44

def workflow_ctx
  @workflow_ctx
end

#workflow_info ⇒ Object

Returns the value of attribute workflow_info.



52
53
54
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 52

def workflow_info
  @workflow_info
end

#workflow_key ⇒ Object

This key contains workflow, initiator and target name. Workflow engine uses the key to do workflow dedup.



47
48
49
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 47

def workflow_key
  @workflow_key
end

#workflow_meta ⇒ Object

The metadata of the workflow.



50
51
52
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 50

def workflow_meta
  @workflow_meta
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)



101
102
103
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 101

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)



96
97
98
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 96

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.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 77

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'input' => :'Input',
    :'name' => :'Name',
    :'pending_services' => :'PendingServices',
    :'src' => :'Src',
    :'status' => :'Status',
    :'wait_on_duplicate' => :'WaitOnDuplicate',
    :'workflow_action_task_lists' => :'WorkflowActionTaskLists',
    :'workflow_ctx' => :'WorkflowCtx',
    :'workflow_key' => :'WorkflowKey',
    :'workflow_meta' => :'WorkflowMeta',
    :'workflow_info' => :'WorkflowInfo'
  }
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



323
324
325
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 323

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



136
137
138
139
140
141
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 136

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



144
145
146
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 144

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



125
126
127
128
129
130
131
132
133
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 125

def self.openapi_nullable
  Set.new([
    :'input',
    :'pending_services',
    :'workflow_action_task_lists',
    :'workflow_ctx',
    :'workflow_meta',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 106

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'input' => :'Object',
    :'name' => :'String',
    :'pending_services' => :'Array<String>',
    :'src' => :'String',
    :'status' => :'String',
    :'wait_on_duplicate' => :'Boolean',
    :'workflow_action_task_lists' => :'Array<WorkflowDynamicWorkflowActionTaskList>',
    :'workflow_ctx' => :'WorkflowWorkflowCtx',
    :'workflow_key' => :'String',
    :'workflow_meta' => :'Object',
    :'workflow_info' => :'WorkflowWorkflowInfoRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 290

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      input == o.input &&
      name == o.name &&
      pending_services == o.pending_services &&
      src == o.src &&
      status == o.status &&
      wait_on_duplicate == o.wait_on_duplicate &&
      workflow_action_task_lists == o.workflow_action_task_lists &&
      workflow_ctx == o.workflow_ctx &&
      workflow_key == o.workflow_key &&
      workflow_meta == o.workflow_meta &&
      workflow_info == o.workflow_info && super(o)
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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 354

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:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 425

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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 330

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


310
311
312
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 310

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



316
317
318
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 316

def hash
  [class_id, object_type, input, name, pending_services, src, status, wait_on_duplicate, workflow_action_task_lists, workflow_ctx, workflow_key, workflow_meta, workflow_info].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



231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 231

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:

  • (Hash) —

    Returns the object in the form of hash



401
402
403
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 401

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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 407

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



395
396
397
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 395

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



246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/intersight_client/models/workflow_pending_dynamic_workflow_info.rb', line 246

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["workflow.PendingDynamicWorkflowInfo"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["workflow.PendingDynamicWorkflowInfo"])
  return false unless object_type_validator.valid?(@object_type)
  status_validator = EnumAttributeValidator.new('String', ["GatheringTasks", "Waiting"])
  return false unless status_validator.valid?(@status)
  true && super
end