Class: IntersightClient::WorkflowWorkflowProperties

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

Overview

Properties for a workflow definition.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkflowWorkflowProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



119
120
121
122
123
124
125
126
127
128
129
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
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 119

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

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

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

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

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

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

  if attributes.key?(:'support_status')
    self.support_status = attributes[:'support_status']
  else
    self.support_status = 'Supported'
  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_workflow_properties.rb', line 20

def class_id
  @class_id
end

#cloneable ⇒ Object

When set to false workflow is not cloneable. It is set to true only if Workflow is not internal and it does not have any internal tasks.



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

def cloneable
  @cloneable
end

#enable_debug ⇒ Object

Enabling this flag will capture request and response details as debug logs for tasks that are using workflow.BatchApi for implementation. For other tasks in the workflow which are not based on workflow.BatchApi logs will not be generated.



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

def enable_debug
  @enable_debug
end

#external_meta ⇒ Object

When set to false the workflow is owned by the system and used for internal services. Such workflows cannot be directly used by external entities.



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

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

def object_type
  @object_type
end

#retryable ⇒ Object

When true, this workflow can be retried if has not been modified for more than a period of 2 weeks.



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

def retryable
  @retryable
end

#support_status ⇒ Object

Supported status of the definition. * Supported - The definition is a supported version and there will be no changes to the mandatory inputs or outputs. * Beta - The definition is a Beta version and this version can under go changes until the version is marked supported. * Deprecated - The version of definition is deprecated and typically there will be a higher version of the same definition that has been added.



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

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



81
82
83
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 81

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)



76
77
78
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 76

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.



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 63

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'cloneable' => :'Cloneable',
    :'enable_debug' => :'EnableDebug',
    :'external_meta' => :'ExternalMeta',
    :'retryable' => :'Retryable',
    :'support_status' => :'SupportStatus'
  }
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



266
267
268
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 266

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



105
106
107
108
109
110
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 105

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



113
114
115
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 113

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 99

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 86

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'cloneable' => :'Boolean',
    :'enable_debug' => :'Boolean',
    :'external_meta' => :'Boolean',
    :'retryable' => :'Boolean',
    :'support_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      cloneable == o.cloneable &&
      enable_debug == o.enable_debug &&
      external_meta == o.external_meta &&
      retryable == o.retryable &&
      support_status == o.support_status && 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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 297

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 368

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 273

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


253
254
255
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



259
260
261
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 259

def hash
  [class_id, object_type, cloneable, enable_debug, external_meta, retryable, support_status].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



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 180

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



344
345
346
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 344

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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 350

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



338
339
340
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 338

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



195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/intersight_client/models/workflow_workflow_properties.rb', line 195

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["workflow.WorkflowProperties"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["workflow.WorkflowProperties"])
  return false unless object_type_validator.valid?(@object_type)
  support_status_validator = EnumAttributeValidator.new('String', ["Supported", "Beta", "Deprecated"])
  return false unless support_status_validator.valid?(@support_status)
  true && super
end