Class: IntersightClient::WorkflowWorkflowDefinition

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

Overview

Workflow definition is a collection of tasks that are sequenced in a certain way using control tasks. The tasks in the workflow definition is represented as a directed acyclic graph where each node in the graph is a task and the edges in the graph are transitions from one task to another.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 193

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

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

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

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

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

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

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

  if attributes.key?(:'license_entitlement')
    self.license_entitlement = attributes[:'license_entitlement']
  else
    self.license_entitlement = 'Base'
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  else
    self.version = 1
  end

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

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

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

Instance Attribute Details

#catalogObject

Returns the value of attribute catalog.



69
70
71
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 69

def catalog
  @catalog
end

#class_idObject

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

def class_id
  @class_id
end

#cloned_fromObject

Returns the value of attribute cloned_from.



71
72
73
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 71

def cloned_from
  @cloned_from
end

#default_versionObject

When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version.



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

def default_version
  @default_version
end

#descriptionObject

The description for this workflow.



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

def description
  @description
end

#input_definitionObject

Returns the value of attribute input_definition.



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

def input_definition
  @input_definition
end

#input_parameter_setObject

Returns the value of attribute input_parameter_set.



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

def input_parameter_set
  @input_parameter_set
end

#labelObject

A user friendly short name to identify the workflow. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_).



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

def label
  @label
end

#license_entitlementObject

License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks. * ‘Base` - Base as a License type. It is default license type. * `Essential` - Essential as a License type. * `Standard` - Standard as a License type. * `Advantage` - Advantage as a License type. * `Premier` - Premier as a License type. * `IWO-Essential` - IWO-Essential as a License type. * `IWO-Advantage` - IWO-Advantage as a License type. * `IWO-Premier` - IWO-Premier as a License type.



39
40
41
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 39

def license_entitlement
  @license_entitlement
end

#max_task_countObject

The maximum number of tasks that can be executed on this workflow.



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

def max_task_count
  @max_task_count
end

#max_worker_task_countObject

The maximum number of external (worker) tasks that can be executed on this workflow.



45
46
47
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 45

def max_worker_task_count
  @max_worker_task_count
end

#nameObject

The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_).



48
49
50
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 48

def name
  @name
end

#object_typeObject

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_workflow_definition.rb', line 23

def object_type
  @object_type
end

#output_definitionObject

Returns the value of attribute output_definition.



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

def output_definition
  @output_definition
end

#output_parametersObject

The output mappings for the workflow. The outputs for workflows will generally be task output variables that we want to export out at the end of the workflow. The format to specify the mapping is ‘$Source.output.JsonPath’, where ‘Source’ is the name of the task within the workflow. Any task output can be mapped to a workflow output as long as the types are compatible. It’s followed by a JSON path expression to extract JSON fragment from source’s output.



53
54
55
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 53

def output_parameters
  @output_parameters
end

#propertiesObject

Returns the value of attribute properties.



55
56
57
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 55

def properties
  @properties
end

#tasksObject

Returns the value of attribute tasks.



57
58
59
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 57

def tasks
  @tasks
end

#ui_input_filtersObject

Returns the value of attribute ui_input_filters.



59
60
61
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 59

def ui_input_filters
  @ui_input_filters
end

#ui_rendering_dataObject

This will hold the data needed for workflow to be rendered in the user interface.



62
63
64
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 62

def ui_rendering_data
  @ui_rendering_data
end

#validation_informationObject

Returns the value of attribute validation_information.



64
65
66
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 64

def validation_information
  @validation_information
end

#versionObject

The version of the workflow to support multiple versions.



67
68
69
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 67

def version
  @version
end

#workflow_metadataObject

Returns the value of attribute workflow_metadata.



73
74
75
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 73

def 
  @workflow_metadata
end

Class Method Details

.acceptable_attribute_mapObject

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



131
132
133
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 131

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

.acceptable_attributesObject

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



126
127
128
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 126

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

.attribute_mapObject

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 98

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'default_version' => :'DefaultVersion',
    :'description' => :'Description',
    :'input_definition' => :'InputDefinition',
    :'input_parameter_set' => :'InputParameterSet',
    :'label' => :'Label',
    :'license_entitlement' => :'LicenseEntitlement',
    :'max_task_count' => :'MaxTaskCount',
    :'max_worker_task_count' => :'MaxWorkerTaskCount',
    :'name' => :'Name',
    :'output_definition' => :'OutputDefinition',
    :'output_parameters' => :'OutputParameters',
    :'properties' => :'Properties',
    :'tasks' => :'Tasks',
    :'ui_input_filters' => :'UiInputFilters',
    :'ui_rendering_data' => :'UiRenderingData',
    :'validation_information' => :'ValidationInformation',
    :'version' => :'Version',
    :'catalog' => :'Catalog',
    :'cloned_from' => :'ClonedFrom',
    :'workflow_metadata' => :'WorkflowMetadata'
  }
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



468
469
470
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 468

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



179
180
181
182
183
184
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 179

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

.openapi_discriminator_nameObject

discriminator’s property name in OpenAPI v3



187
188
189
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 187

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullableObject

List of attributes with nullable: true



164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 164

def self.openapi_nullable
  Set.new([
    :'input_definition',
    :'input_parameter_set',
    :'output_definition',
    :'output_parameters',
    :'properties',
    :'tasks',
    :'ui_input_filters',
    :'ui_rendering_data',
    :'validation_information',
  ])
end

.openapi_typesObject

Attribute type mapping.



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
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 136

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'default_version' => :'Boolean',
    :'description' => :'String',
    :'input_definition' => :'Array<WorkflowBaseDataType>',
    :'input_parameter_set' => :'Array<WorkflowParameterSet>',
    :'label' => :'String',
    :'license_entitlement' => :'String',
    :'max_task_count' => :'Integer',
    :'max_worker_task_count' => :'Integer',
    :'name' => :'String',
    :'output_definition' => :'Array<WorkflowBaseDataType>',
    :'output_parameters' => :'Object',
    :'properties' => :'WorkflowWorkflowProperties',
    :'tasks' => :'Array<WorkflowWorkflowTask>',
    :'ui_input_filters' => :'Array<WorkflowUiInputFilter>',
    :'ui_rendering_data' => :'Object',
    :'validation_information' => :'WorkflowValidationInformation',
    :'version' => :'Integer',
    :'catalog' => :'WorkflowCatalogRelationship',
    :'cloned_from' => :'WorkflowWorkflowDefinitionRelationship',
    :'workflow_metadata' => :'WorkflowWorkflowMetadataRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 426

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      default_version == o.default_version &&
      description == o.description &&
      input_definition == o.input_definition &&
      input_parameter_set == o.input_parameter_set &&
      label == o.label &&
      license_entitlement == o.license_entitlement &&
      max_task_count == o.max_task_count &&
      max_worker_task_count == o.max_worker_task_count &&
      name == o.name &&
      output_definition == o.output_definition &&
      output_parameters == o.output_parameters &&
      properties == o.properties &&
      tasks == o.tasks &&
      ui_input_filters == o.ui_input_filters &&
      ui_rendering_data == o.ui_rendering_data &&
      validation_information == o.validation_information &&
      version == o.version &&
      catalog == o.catalog &&
      cloned_from == o.cloned_from &&
       == o. && 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



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 499

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



570
571
572
573
574
575
576
577
578
579
580
581
582
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 570

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



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 475

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


455
456
457
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 455

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



461
462
463
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 461

def hash
  [class_id, object_type, default_version, description, input_definition, input_parameter_set, label, license_entitlement, max_task_count, max_worker_task_count, name, output_definition, output_parameters, properties, tasks, ui_input_filters, ui_rendering_data, validation_information, version, catalog, cloned_from, ].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 318

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

  pattern = Regexp.new(/^[a-zA-Z0-9]+[\sa-zA-Z0-9_.\/:-]{1,92}$/)
  if !@label.nil? && @label !~ pattern
    invalid_properties.push("invalid value for \"label\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_.-]{1,64}$/)
  if !@name.nil? && @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  end

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



546
547
548
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 546

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 552

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

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



540
541
542
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 540

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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
# File 'lib/intersight_client/models/workflow_workflow_definition.rb', line 347

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["workflow.WorkflowDefinition"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["workflow.WorkflowDefinition"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@label.nil? && @label !~ Regexp.new(/^[a-zA-Z0-9]+[\sa-zA-Z0-9_.\/:-]{1,92}$/)
  license_entitlement_validator = EnumAttributeValidator.new('String', ["Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier"])
  return false unless license_entitlement_validator.valid?(@license_entitlement)
  return false if !@name.nil? && @name !~ Regexp.new(/^[a-zA-Z0-9_.-]{1,64}$/)
  return false if !@version.nil? && @version < 1
  true && super
end