Class: IntersightClient::WorkflowBatchExecutor

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

Overview

Intersight allows generic API tasks to be created by taking the API request body and a response parser specification in the form of content.Grammar object. Batch API associates the list of API requests to be executed as part of single task execution. Each API request takes the request body and a response parser specification.

Direct Known Subclasses

WorkflowBatchApiExecutor

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 136

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#batch ⇒ Object

Returns the value of attribute batch.



25
26
27
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 25

def batch
  @batch
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. The enum values provides the list of concrete types that can be instantiated from this abstract type.



20
21
22
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 20

def class_id
  @class_id
end

#constraints ⇒ Object

Returns the value of attribute constraints.



27
28
29
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 27

def constraints
  @constraints
end

#description ⇒ Object

A detailed description about the batch APIs.



30
31
32
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 30

def description
  @description
end

#name ⇒ Object

Name for the batch API task.



33
34
35
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 33

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. The enum values provides the list of concrete types that can be instantiated from this abstract type.



23
24
25
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 23

def object_type
  @object_type
end

#outcomes ⇒ Object

All the possible outcomes of this task are captured here. Outcomes property is a collection property of type workflow.Outcome objects. The outcomes can be mapped to the message to be shown. The outcomes are evaluated in the order they are given. At the end of the outcomes list, an catchall success/fail outcome can be added with condition as ‘true’. This is an optional property and if not specified the task will be marked as success.



36
37
38
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 36

def outcomes
  @outcomes
end

#output ⇒ Object

Intersight Orchestrator allows the extraction of required values from API responses using the API response grammar. These extracted values can be mapped to task output parameters defined in task definition. The mapping of API output parameters to the task output parameters is provided as JSON in this property.



39
40
41
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 39

def output
  @output
end

#retry_from_failed_api ⇒ Object

When an execution of a nth API in the Batch fails, Retry from falied API flag indicates if the execution should start from the nth API or the first API during task retry. By default the value is set to false.



42
43
44
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 42

def retry_from_failed_api
  @retry_from_failed_api
end

#skip_on_condition ⇒ Object

The skip expression, if provided, allows the batch API executor to skip the task execution when the given expression evaluates to true. The expression is given as such a golang template that has to be evaluated to a final content true/false. The expression is an optional and in case not provided, the API will always be executed.



45
46
47
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 45

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



91
92
93
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 91

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)



86
87
88
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 86

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'batch' => :'Batch',
    :'constraints' => :'Constraints',
    :'description' => :'Description',
    :'name' => :'Name',
    :'outcomes' => :'Outcomes',
    :'output' => :'Output',
    :'retry_from_failed_api' => :'RetryFromFailedApi',
    :'skip_on_condition' => :'SkipOnCondition'
  }
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



293
294
295
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 293

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



122
123
124
125
126
127
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 122

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



130
131
132
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 130

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
116
117
118
119
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 112

def self.openapi_nullable
  Set.new([
    :'batch',
    :'constraints',
    :'outcomes',
    :'output',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 96

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'batch' => :'Array<WorkflowApi>',
    :'constraints' => :'WorkflowTaskConstraints',
    :'description' => :'String',
    :'name' => :'String',
    :'outcomes' => :'Object',
    :'output' => :'Object',
    :'retry_from_failed_api' => :'Boolean',
    :'skip_on_condition' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 263

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      batch == o.batch &&
      constraints == o.constraints &&
      description == o.description &&
      name == o.name &&
      outcomes == o.outcomes &&
      output == o.output &&
      retry_from_failed_api == o.retry_from_failed_api &&
      skip_on_condition == o.skip_on_condition && 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



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
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 324

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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 395

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


280
281
282
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 280

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



286
287
288
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 286

def hash
  [class_id, object_type, batch, constraints, description, name, outcomes, output, retry_from_failed_api, skip_on_condition].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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 201

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

  if !@batch.nil? && @batch.length < 1
    invalid_properties.push('invalid value for "batch", number of items 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:

  • (Hash) —

    Returns the object in the form of hash



371
372
373
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 371

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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 377

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



365
366
367
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 365

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



220
221
222
223
224
225
226
227
228
229
 
# File 'lib/intersight_client/models/workflow_batch_executor.rb', line 220

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