Class: IntersightClient::WorkflowApiAllOf

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

Overview

Definition of the list of properties defined in ‘workflow.Api’, excluding properties defined in parent classes.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkflowApiAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 143

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#asset_target_moid ⇒ Object

Asset target defines the remote target endpoints which are either managed by Intersight or their service APIs are invoked from Intersight. Generic API executor service Jasmine can invoke these remote APIs via its executors. Asset targets can be accessed directly for cloud targets or via an associated Intersight Assist. Prerequisite to use asset targets is to persist the target details. Asset target MoRef can be given as task input of type TargetDataType. Fusion determines and populates the target context with the Assist if associated with. It is set internally at the API level. In case of an associated assist, it is used by Assist to fetch the target details and form the API request to send to endpoints. In case of cloud asset targets, Jasmine fetched the target details from DB, forms the API request and sends it to the target.



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

def asset_target_moid
  @asset_target_moid
end

#body ⇒ Object

The optional request body that is sent as part of this API request. The request body can contain a golang template that can be populated with task input parameters and previous API output parameters.



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

def body
  @body
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_api_all_of.rb', line 20

def class_id
  @class_id
end

#content_type ⇒ Object

Intersight Orchestrator, with the support of response parser specification, can extract the values from API responses and map them to task output parameters. The value extraction is supported for response content types XML, JSON and Text. The type of the content that gets passed as payload and response in this API. The supported values are json, xml, text.



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

def content_type
  @content_type
end

#description ⇒ Object

A description that task designer can add to individual API requests that explain what the API call is about.



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

def description
  @description
end

#error_content_type ⇒ Object

Intersight Orchestrator, with the support of response parser specification, can extract the values from API responses and map them to task output parameters. The value extraction is supported for response content types XML, JSON and Text. Optional input to specify the content type in case of error API response. This should be used if the content type of error response is different from that of the success response. If not specified, contentType input value is used to parse the error response.



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

def error_content_type
  @error_content_type
end

#label ⇒ Object

A user friendly label that task designers have given to the batch API request.



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

def label
  @label
end

#name ⇒ Object

A reference name for this API request within the batch API request. This name shall be used to map the API output parameters to subsequent API input parameters within a batch API task.



44
45
46
 
# File 'lib/intersight_client/models/workflow_api_all_of.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. 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_api_all_of.rb', line 23

def object_type
  @object_type
end

#outcomes ⇒ Object

All the possible outcomes of this API 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.



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

def outcomes
  @outcomes
end

#response_spec ⇒ Object

The optional grammar specification for parsing the response to extract the required values. The specification should have extraction specification specified for all the API output parameters.



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

def response_spec
  @response_spec
end

#skip_on_condition ⇒ Object

The skip expression, if provided, allows the batch API executor to skip the api 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.



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

def skip_on_condition
  @skip_on_condition
end

#start_delay ⇒ Object

The delay in seconds after which the API needs to be executed. By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution. Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.



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

def start_delay
  @start_delay
end

#timeout ⇒ Object

The duration in seconds by which the API response is expected from the API target. If the end point does not respond for the API request within this timeout duration, the task will be marked as failed.



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

def timeout
  @timeout
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about



109
110
111
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 109

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



104
105
106
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 104

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 84

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'asset_target_moid' => :'AssetTargetMoid',
    :'body' => :'Body',
    :'content_type' => :'ContentType',
    :'description' => :'Description',
    :'error_content_type' => :'ErrorContentType',
    :'label' => :'Label',
    :'name' => :'Name',
    :'outcomes' => :'Outcomes',
    :'response_spec' => :'ResponseSpec',
    :'skip_on_condition' => :'SkipOnCondition',
    :'start_delay' => :'StartDelay',
    :'timeout' => :'Timeout'
  }
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



296
297
298
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 296

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'outcomes',
    :'response_spec',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 114

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'asset_target_moid' => :'String',
    :'body' => :'String',
    :'content_type' => :'String',
    :'description' => :'String',
    :'error_content_type' => :'String',
    :'label' => :'String',
    :'name' => :'String',
    :'outcomes' => :'Object',
    :'response_spec' => :'Object',
    :'skip_on_condition' => :'String',
    :'start_delay' => :'Integer',
    :'timeout' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      asset_target_moid == o.asset_target_moid &&
      body == o.body &&
      content_type == o.content_type &&
      description == o.description &&
      error_content_type == o.error_content_type &&
      label == o.label &&
      name == o.name &&
      outcomes == o.outcomes &&
      response_spec == o.response_spec &&
      skip_on_condition == o.skip_on_condition &&
      start_delay == o.start_delay &&
      timeout == o.timeout
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



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
362
363
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 326

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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 397

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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 303

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


283
284
285
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 283

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



289
290
291
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 289

def hash
  [class_id, object_type, asset_target_moid, body, content_type, description, error_content_type, label, name, outcomes, response_spec, skip_on_condition, start_delay, timeout].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



215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 215

def list_invalid_properties
  invalid_properties = Array.new
  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



373
374
375
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 373

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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 379

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



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

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



230
231
232
233
234
235
236
237
238
 
# File 'lib/intersight_client/models/workflow_api_all_of.rb', line 230

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["workflow.CliCommand", "workflow.FileOperations", "workflow.SshSession", "workflow.WebApi", "workflow.XmlApi"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["workflow.CliCommand", "workflow.FileOperations", "workflow.SshSession", "workflow.WebApi", "workflow.XmlApi"])
  return false unless object_type_validator.valid?(@object_type)
  true
end