Class: IntersightClient::WorkflowWorkflowNotification

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

Overview

The push notification received from conductor of the workflow which are in terminal state. Terminal state can be completed, failed, terminated, timed out.

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

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 164

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

def class_id
  @class_id
end

#correlation_id ⇒ Object

The correlationId of the workflow.



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

def correlation_id
  @correlation_id
end

#end_time ⇒ Object

The end time of the workflow.



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

def end_time
  @end_time
end

#event ⇒ Object

The event of the workflow.



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

def event
  @event
end

#execution_time ⇒ Object

The execution time of the workflow.



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

def execution_time
  @execution_time
end

#failed_reference_task_names ⇒ Object

The reference task names of the failed tasks.



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

def failed_reference_task_names
  @failed_reference_task_names
end

#input ⇒ Object

The input of the workflow.



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

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

def object_type
  @object_type
end

#output ⇒ Object

The output of the workflow.



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

def output
  @output
end

#reason_for_incompletion ⇒ Object

The reason for incompletion status of the workflow.



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

def reason_for_incompletion
  @reason_for_incompletion
end

#start_time ⇒ Object

The start time of the workflow.



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

def start_time
  @start_time
end

#status ⇒ Object

The final status of the workflow.



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

def status
  @status
end

#update_time ⇒ Object

The last update time of the workflow.



56
57
58
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 56

def update_time
  @update_time
end

#version ⇒ Object

The version of the workflow.



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

def version
  @version
end

#workflow_id ⇒ Object

The unique id of the workflow.



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

def workflow_id
  @workflow_id
end

#workflow_type ⇒ Object

The type of the workflow.



65
66
67
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 65

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



117
118
119
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 117

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)



112
113
114
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 112

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.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 90

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'correlation_id' => :'CorrelationId',
    :'end_time' => :'EndTime',
    :'event' => :'Event',
    :'execution_time' => :'ExecutionTime',
    :'failed_reference_task_names' => :'FailedReferenceTaskNames',
    :'input' => :'Input',
    :'output' => :'Output',
    :'reason_for_incompletion' => :'ReasonForIncompletion',
    :'start_time' => :'StartTime',
    :'status' => :'Status',
    :'update_time' => :'UpdateTime',
    :'version' => :'Version',
    :'workflow_id' => :'WorkflowId',
    :'workflow_type' => :'WorkflowType'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



334
335
336
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 334

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



150
151
152
153
154
155
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 150

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



158
159
160
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 158

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



144
145
146
147
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 144

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'correlation_id' => :'String',
    :'end_time' => :'String',
    :'event' => :'String',
    :'execution_time' => :'Float',
    :'failed_reference_task_names' => :'String',
    :'input' => :'String',
    :'output' => :'String',
    :'reason_for_incompletion' => :'String',
    :'start_time' => :'String',
    :'status' => :'String',
    :'update_time' => :'String',
    :'version' => :'Integer',
    :'workflow_id' => :'String',
    :'workflow_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 298

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      correlation_id == o.correlation_id &&
      end_time == o.end_time &&
      event == o.event &&
      execution_time == o.execution_time &&
      failed_reference_task_names == o.failed_reference_task_names &&
      input == o.input &&
      output == o.output &&
      reason_for_incompletion == o.reason_for_incompletion &&
      start_time == o.start_time &&
      status == o.status &&
      update_time == o.update_time &&
      version == o.version &&
      workflow_id == o.workflow_id &&
      workflow_type == o.workflow_type && 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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
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_workflow_notification.rb', line 365

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



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 436

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


321
322
323
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 321

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



327
328
329
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 327

def hash
  [class_id, object_type, correlation_id, end_time, event, execution_time, failed_reference_task_names, input, output, reason_for_incompletion, start_time, status, update_time, version, workflow_id, workflow_type].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



251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 251

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:

  • Returns the object in the form of hash



412
413
414
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 412

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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 418

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



406
407
408
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 406

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



266
267
268
269
270
271
272
273
274
 
# File 'lib/intersight_client/models/workflow_workflow_notification.rb', line 266

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