Class: IntersightClient::WorkflowTaskNotification

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

Overview

The push notification of the scheduled task received from conductor.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 184

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

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

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

  if attributes.key?(:'scheduled_time')
    self.scheduled_time = attributes[:'scheduled_time']
  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?(:'task_def_name')
    self.task_def_name = attributes[:'task_def_name']
  end

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

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

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

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

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

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

def class_id
  @class_id
end

#correlation_id ⇒ Object

The correlation id of the scheduled task.



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

def correlation_id
  @correlation_id
end

#end_time ⇒ Object

The end time of the scheduled task.



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

def end_time
  @end_time
end

#input ⇒ Object

The input of the scheduled task.



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

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

def object_type
  @object_type
end

#output ⇒ Object

The output of the scheduled task.



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

def output
  @output
end

#reason_for_incompletion ⇒ Object

The reason for incompletion status of the task.



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

def reason_for_incompletion
  @reason_for_incompletion
end

#reference_task_name ⇒ Object

The task reference name of the scheduled task.



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

def reference_task_name
  @reference_task_name
end

#retry_count ⇒ Object

The number of times the task retries on failure.



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

def retry_count
  @retry_count
end

#scheduled_time ⇒ Object

The scheduled time of the task.



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

def scheduled_time
  @scheduled_time
end

#start_time ⇒ Object

The start time of the scheduled task.



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

def start_time
  @start_time
end

#status ⇒ Object

The status of the scheduled task.



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

def status
  @status
end

#task_def_name ⇒ Object

The definition of the task explains about the task.



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

def task_def_name
  @task_def_name
end

#task_description ⇒ Object

The description of the task explains about the task.



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

def task_description
  @task_description
end

#task_id ⇒ Object

Unique id of the scheduled task.



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

def task_id
  @task_id
end

#task_type ⇒ Object

The type of the scheduled task.



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

def task_type
  @task_type
end

#update_time ⇒ Object

The update time of the scheduled task.



68
69
70
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 68

def update_time
  @update_time
end

#workflow_id ⇒ Object

The unique id of the running workflow containing this scheduled task.



71
72
73
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 71

def workflow_id
  @workflow_id
end

#workflow_task_type ⇒ Object

The type of the workflow task.



74
75
76
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 74

def workflow_task_type
  @workflow_task_type
end

#workflow_type ⇒ Object

The type of workflow containing this scheduled task.



77
78
79
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 77

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)



133
134
135
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 133

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)



128
129
130
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 128

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.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 102

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'correlation_id' => :'CorrelationId',
    :'end_time' => :'EndTime',
    :'input' => :'Input',
    :'output' => :'Output',
    :'reason_for_incompletion' => :'ReasonForIncompletion',
    :'reference_task_name' => :'ReferenceTaskName',
    :'retry_count' => :'RetryCount',
    :'scheduled_time' => :'ScheduledTime',
    :'start_time' => :'StartTime',
    :'status' => :'Status',
    :'task_def_name' => :'TaskDefName',
    :'task_description' => :'TaskDescription',
    :'task_id' => :'TaskId',
    :'task_type' => :'TaskType',
    :'update_time' => :'UpdateTime',
    :'workflow_id' => :'WorkflowId',
    :'workflow_task_type' => :'WorkflowTaskType',
    :'workflow_type' => :'WorkflowType'
  }
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



374
375
376
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 374

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



170
171
172
173
174
175
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 170

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



178
179
180
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 178

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



164
165
166
167
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 164

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

.openapi_types ⇒ Object

Attribute type mapping.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 138

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'correlation_id' => :'String',
    :'end_time' => :'String',
    :'input' => :'String',
    :'output' => :'String',
    :'reason_for_incompletion' => :'String',
    :'reference_task_name' => :'String',
    :'retry_count' => :'Float',
    :'scheduled_time' => :'String',
    :'start_time' => :'String',
    :'status' => :'String',
    :'task_def_name' => :'String',
    :'task_description' => :'String',
    :'task_id' => :'String',
    :'task_type' => :'String',
    :'update_time' => :'String',
    :'workflow_id' => :'String',
    :'workflow_task_type' => :'String',
    :'workflow_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 334

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 &&
      input == o.input &&
      output == o.output &&
      reason_for_incompletion == o.reason_for_incompletion &&
      reference_task_name == o.reference_task_name &&
      retry_count == o.retry_count &&
      scheduled_time == o.scheduled_time &&
      start_time == o.start_time &&
      status == o.status &&
      task_def_name == o.task_def_name &&
      task_description == o.task_description &&
      task_id == o.task_id &&
      task_type == o.task_type &&
      update_time == o.update_time &&
      workflow_id == o.workflow_id &&
      workflow_task_type == o.workflow_task_type &&
      workflow_type == o.workflow_type && 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



405
406
407
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
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 405

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



476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 476

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



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 381

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


361
362
363
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 361

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



367
368
369
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 367

def hash
  [class_id, object_type, correlation_id, end_time, input, output, reason_for_incompletion, reference_task_name, retry_count, scheduled_time, start_time, status, task_def_name, task_description, task_id, task_type, update_time, workflow_id, workflow_task_type, 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



287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 287

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



452
453
454
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 452

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



458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 458

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



446
447
448
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 446

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



302
303
304
305
306
307
308
309
310
 
# File 'lib/intersight_client/models/workflow_task_notification.rb', line 302

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