Class: IntersightClient::WorkflowSolutionDefinition

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

Overview

Solution definition is a collection of actions and associated workflow definition that can be used to deploy a solution.

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

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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

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

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

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

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

  if attributes.key?(:'delete_instance_on_decommission')
    self.delete_instance_on_decommission = attributes[:'delete_instance_on_decommission']
  else
    self.delete_instance_on_decommission = false
  end

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

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

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

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

Instance Attribute Details

#action_definitions ⇒ Object

An array of relationships to workflowSolutionActionDefinition resources.



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

def action_definitions
  @action_definitions
end

#allow_multiple_solution_instances ⇒ Object

Solution definition can declare that only one instance can be allowed within the customer account.



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

def allow_multiple_solution_instances
  @allow_multiple_solution_instances
end

#catalog ⇒ Object

Returns the value of attribute catalog.



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

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

def class_id
  @class_id
end

#cvd_id ⇒ Object

The Cisco Validated Design (CVD) Identifier that this solution provides.



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

def cvd_id
  @cvd_id
end

#delete_instance_on_decommission ⇒ Object

The flag to indicate that solution instance will be deleted after the completion of decommission action.



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

def delete_instance_on_decommission
  @delete_instance_on_decommission
end

#description ⇒ Object

The description for this solution which provides information on what are the pre-requisites to deploy the solution and what features are supported on the solution.



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

def description
  @description
end

#label ⇒ Object

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



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

def label
  @label
end

#license_entitlement ⇒ Object

License entitlement required to run this solution. * ‘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.



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

def license_entitlement
  @license_entitlement
end

#name ⇒ Object

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



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

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

def object_type
  @object_type
end

#output_definition ⇒ Object

Returns the value of attribute output_definition.



46
47
48
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 46

def output_definition
  @output_definition
end

#version ⇒ Object

The version of the solution to support multiple versions.



49
50
51
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 49

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)



103
104
105
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 103

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)



98
99
100
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 98

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'allow_multiple_solution_instances' => :'AllowMultipleSolutionInstances',
    :'cvd_id' => :'CvdId',
    :'delete_instance_on_decommission' => :'DeleteInstanceOnDecommission',
    :'description' => :'Description',
    :'label' => :'Label',
    :'license_entitlement' => :'LicenseEntitlement',
    :'name' => :'Name',
    :'output_definition' => :'OutputDefinition',
    :'version' => :'Version',
    :'action_definitions' => :'ActionDefinitions',
    :'catalog' => :'Catalog'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



377
378
379
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 377

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



143
144
145
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 143

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



127
128
129
130
131
132
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'allow_multiple_solution_instances' => :'Boolean',
    :'cvd_id' => :'String',
    :'delete_instance_on_decommission' => :'Boolean',
    :'description' => :'String',
    :'label' => :'String',
    :'license_entitlement' => :'String',
    :'name' => :'String',
    :'output_definition' => :'Array<WorkflowBaseDataType>',
    :'version' => :'Integer',
    :'action_definitions' => :'Array<WorkflowSolutionActionDefinitionRelationship>',
    :'catalog' => :'WorkflowCatalogRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      allow_multiple_solution_instances == o.allow_multiple_solution_instances &&
      cvd_id == o.cvd_id &&
      delete_instance_on_decommission == o.delete_instance_on_decommission &&
      description == o.description &&
      label == o.label &&
      license_entitlement == o.license_entitlement &&
      name == o.name &&
      output_definition == o.output_definition &&
      version == o.version &&
      action_definitions == o.action_definitions &&
      catalog == o.catalog && 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



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 408

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



479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 479

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



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 384

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


364
365
366
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 364

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



370
371
372
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 370

def hash
  [class_id, object_type, allow_multiple_solution_instances, cvd_id, delete_instance_on_decommission, description, label, license_entitlement, name, output_definition, version, action_definitions, catalog].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



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_solution_definition.rb', line 236

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:

  • Returns the object in the form of hash



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

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



461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 461

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



449
450
451
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 449

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/intersight_client/models/workflow_solution_definition.rb', line 265

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