Class: IntersightClient::WorkflowActionWorkflowDefinition

Inherits:
MoBaseComplexType show all
Defined in:
lib/intersight_client/models/workflow_action_workflow_definition.rb

Overview

Definition to capture the workflow definition which will be used in the action of a solution definition.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkflowActionWorkflowDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#catalog_moid ⇒ Object

Specify the catalog moid that this workflow belongs. When catalog moid is not specified then the catalog of the solution is used first and if no workflow can be found in that catalog, then the shared catalog from Intersight is used.



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

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

def class_id
  @class_id
end

#description ⇒ Object

The description of this workflow instance.



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

def description
  @description
end

#input_parameters ⇒ Object

Capture the mapping of ActionDefinition inputDefinition to workflow definition.



32
33
34
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 32

def input_parameters
  @input_parameters
end

#label ⇒ Object

A user defined label identifier of the workflow used for UI display.



35
36
37
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 35

def label
  @label
end

#name ⇒ Object

The name of the workflow, this name must be unique across all the workflow definition used within the action definitions.



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

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

def object_type
  @object_type
end

#version ⇒ Object

The workflow definition version to use as subworkflow. When no version is specified then the default version of the workflow at the time of creating or updating this workflow is used.



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

def version
  @version
end

#workflow_definition_name ⇒ Object

The qualified name of workflow that should be executed.



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

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



89
90
91
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 89

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)



84
85
86
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 84

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.



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 69

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'catalog_moid' => :'CatalogMoid',
    :'description' => :'Description',
    :'input_parameters' => :'InputParameters',
    :'label' => :'Label',
    :'name' => :'Name',
    :'version' => :'Version',
    :'workflow_definition_name' => :'WorkflowDefinitionName'
  }
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



282
283
284
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 282

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'MoBaseComplexType',
  :'WorkflowActionWorkflowDefinitionAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



124
125
126
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 124

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



109
110
111
112
113
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 109

def self.openapi_nullable
  Set.new([
    :'input_parameters',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 94

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'catalog_moid' => :'String',
    :'description' => :'String',
    :'input_parameters' => :'Object',
    :'label' => :'String',
    :'name' => :'String',
    :'version' => :'Integer',
    :'workflow_definition_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      catalog_moid == o.catalog_moid &&
      description == o.description &&
      input_parameters == o.input_parameters &&
      label == o.label &&
      name == o.name &&
      version == o.version &&
      workflow_definition_name == o.workflow_definition_name && 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



313
314
315
316
317
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
344
345
346
347
348
349
350
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 313

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



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

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


269
270
271
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



275
276
277
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 275

def hash
  [class_id, object_type, catalog_moid, description, input_parameters, label, name, version, workflow_definition_name].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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 189

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_:-]{1,64}$/)
  if !@name.nil? && @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  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



360
361
362
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 360

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 366

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



354
355
356
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 354

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



209
210
211
212
213
214
215
216
217
218
 
# File 'lib/intersight_client/models/workflow_action_workflow_definition.rb', line 209

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["workflow.ActionWorkflowDefinition"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["workflow.ActionWorkflowDefinition"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@name.nil? && @name !~ Regexp.new(/^[a-zA-Z0-9_:-]{1,64}$/)
  true && super
end