Class: IntersightClient::WorkflowTaskDefinition

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

Overview

Used to define a task which can be included within a workflow. Task definition conveys the intent that we want to achieve with the task. We can have a standalone task definition that is bound to a single implementation for that task, or we can define an TaskDefinition that will serve as the interface task definition which is linked to multiple implementation tasks. Each implemented TaskDefinition will be bound to its own implementation so we can achieve a case where single TaskDefinition has multiple implementations.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'workflow.TaskDefinition'
  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?(:'internal_properties')
    self.internal_properties = attributes[:'internal_properties']
  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?(:'name')
    self.name = attributes[:'name']
  end

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

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

  if attributes.key?(:'secure_prop_access')
    self.secure_prop_access = attributes[:'secure_prop_access']
  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?(:'implemented_tasks')
    if (value = attributes[:'implemented_tasks']).is_a?(Array)
      self.implemented_tasks = value
    end
  end

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

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

Instance Attribute Details

#catalog ⇒ Object

Returns the value of attribute catalog.



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

def catalog
  @catalog
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_task_definition.rb', line 20

def class_id
  @class_id
end

#cloned_from ⇒ Object

Returns the value of attribute cloned_from.



54
55
56
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 54

def cloned_from
  @cloned_from
end

#default_version ⇒ Object

When true this will be the task version that is used when a specific task definition version is not specified. The very first task definition created with a name will be set as the default version, after that user can explicitly set any version of the task definition as the default version.



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

def default_version
  @default_version
end

#description ⇒ Object

A user friendly description about task on what operations are done as part of the task execution and any other specific information about task input and output.



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

def description
  @description
end

#implemented_tasks ⇒ Object

An array of relationships to workflowTaskDefinition resources.



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

def implemented_tasks
  @implemented_tasks
end

#interface_task ⇒ Object

Returns the value of attribute interface_task.



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

def interface_task
  @interface_task
end

#internal_properties ⇒ Object

Returns the value of attribute internal_properties.



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

def internal_properties
  @internal_properties
end

#label ⇒ Object

A user friendly short name to identify the task definition. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), single quote (‘), forward slash (/), or an underscore (_) and must be at least 2 characters.



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

def label
  @label
end

#license_entitlement ⇒ Object

License entitlement required to run this task. It is determined by license requirement of features. * 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.



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

def license_entitlement
  @license_entitlement
end

#name ⇒ Object

The name of the task definition. The name should follow this convention <Verb or Action><Category><Vendor><Product><Noun or object> Verb or Action is a required portion of the name and this must be part of the pre-approved verb list. Category is an optional field and this will refer to the broad category of the task referring to the type of resource or endpoint. If there is no specific category then use "Generic" if required. Vendor is an optional field and this will refer to the specific vendor this task applies to. If the task is generic and not tied to a vendor, then do not specify anything. Product is an optional field, this will contain the vendor product and model when desired. Noun or object is a required field and this will contain the noun or object on which the action is being performed. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), or an underscore (_). Examples SendEmail - This is a task in Generic category for sending email. NewStorageVolume - This is a vendor agnostic task under Storage device category for creating a new volume.



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

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

def object_type
  @object_type
end

#properties ⇒ Object

Returns the value of attribute properties.



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

def properties
  @properties
end

#rollback_tasks ⇒ Object

Returns the value of attribute rollback_tasks.



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

def rollback_tasks
  @rollback_tasks
end

#secure_prop_access ⇒ Object

If set to true, the task requires access to secure properties and uses an encryption token associated with a workflow moid to encrypt or decrypt the secure properties.



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

def secure_prop_access
  @secure_prop_access
end

#task_metadata ⇒ Object

Returns the value of attribute task_metadata.



61
62
63
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 61

def task_metadata
  @task_metadata
end

#version ⇒ Object

The version of the task definition so we can support multiple versions of a task definition.



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

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



114
115
116
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 114

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)



109
110
111
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 109

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.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 86

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'default_version' => :'DefaultVersion',
    :'description' => :'Description',
    :'internal_properties' => :'InternalProperties',
    :'label' => :'Label',
    :'license_entitlement' => :'LicenseEntitlement',
    :'name' => :'Name',
    :'properties' => :'Properties',
    :'rollback_tasks' => :'RollbackTasks',
    :'secure_prop_access' => :'SecurePropAccess',
    :'version' => :'Version',
    :'catalog' => :'Catalog',
    :'cloned_from' => :'ClonedFrom',
    :'implemented_tasks' => :'ImplementedTasks',
    :'interface_task' => :'InterfaceTask',
    :'task_metadata' => :'TaskMetadata'
  }
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



410
411
412
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 410

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



152
153
154
155
156
157
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 152

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



160
161
162
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 160

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



142
143
144
145
146
147
148
149
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 142

def self.openapi_nullable
  Set.new([
    :'internal_properties',
    :'properties',
    :'rollback_tasks',
    :'implemented_tasks',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 119

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'default_version' => :'Boolean',
    :'description' => :'String',
    :'internal_properties' => :'WorkflowInternalProperties',
    :'label' => :'String',
    :'license_entitlement' => :'String',
    :'name' => :'String',
    :'properties' => :'WorkflowProperties',
    :'rollback_tasks' => :'Array<WorkflowRollbackTask>',
    :'secure_prop_access' => :'Boolean',
    :'version' => :'Integer',
    :'catalog' => :'WorkflowCatalogRelationship',
    :'cloned_from' => :'WorkflowTaskDefinitionRelationship',
    :'implemented_tasks' => :'Array<WorkflowTaskDefinitionRelationship>',
    :'interface_task' => :'WorkflowTaskDefinitionRelationship',
    :'task_metadata' => :'WorkflowTaskMetadataRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 373

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 &&
      internal_properties == o.internal_properties &&
      label == o.label &&
      license_entitlement == o.license_entitlement &&
      name == o.name &&
      properties == o.properties &&
      rollback_tasks == o.rollback_tasks &&
      secure_prop_access == o.secure_prop_access &&
      version == o.version &&
      catalog == o.catalog &&
      cloned_from == o.cloned_from &&
      implemented_tasks == o.implemented_tasks &&
      interface_task == o.interface_task &&
      task_metadata == o.task_metadata && 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



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
470
471
472
473
474
475
476
477
478
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 441

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



512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 512

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



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 417

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


397
398
399
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 397

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



403
404
405
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 403

def hash
  [class_id, object_type, default_version, description, internal_properties, label, license_entitlement, name, properties, rollback_tasks, secure_prop_access, version, catalog, cloned_from, implemented_tasks, interface_task, task_metadata].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



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

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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



488
489
490
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 488

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



494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 494

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



482
483
484
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 482

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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/intersight_client/models/workflow_task_definition.rb', line 294

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["workflow.TaskDefinition"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["workflow.TaskDefinition"])
  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