Class: IntersightClient::BulkRequest

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

Overview

The bulk.Request API allows users to perform API actions (Create, Update or Delete) in bulk, on a given URI. It is possible to operate on multiple subpaths relative to the provided URI (For example, it would be possible to perform a PATCH action on multiple objects of a given REST resource type).

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

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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/intersight_client/models/bulk_request.rb', line 184

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

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

  if attributes.key?(:'action_on_error')
    self.action_on_error = attributes[:'action_on_error']
  else
    self.action_on_error = 'Stop'
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'verb')
    self.verb = attributes[:'verb']
  else
    self.verb = 'POST'
  end

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

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

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

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

Instance Attribute Details

#action_on_error ⇒ Object

The action to be taken when an error occurs during processing of the request. * ‘Stop` - Stop the processing of the request after the first error. * `Proceed` - Proceed with the processing of the request even when an error occurs.



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

def action_on_error
  @action_on_error
end

#actions ⇒ Object

Returns the value of attribute actions.



28
29
30
 
# File 'lib/intersight_client/models/bulk_request.rb', line 28

def actions
  @actions
end

#async_results ⇒ Object

An array of relationships to bulkSubRequestObj resources.



64
65
66
 
# File 'lib/intersight_client/models/bulk_request.rb', line 64

def async_results
  @async_results
end

#async_results_failed ⇒ Object

An array of relationships to bulkSubRequestObj resources.



67
68
69
 
# File 'lib/intersight_client/models/bulk_request.rb', line 67

def async_results_failed
  @async_results_failed
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.



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

def class_id
  @class_id
end

#completion_time ⇒ Object

The timestamp when the request processing completed.



31
32
33
 
# File 'lib/intersight_client/models/bulk_request.rb', line 31

def completion_time
  @completion_time
end

#headers ⇒ Object

Returns the value of attribute headers.



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

def headers
  @headers
end

#num_sub_requests ⇒ Object

The number of sub requests received in this request.



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

def num_sub_requests
  @num_sub_requests
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/bulk_request.rb', line 23

def object_type
  @object_type
end

#org_moid ⇒ Object

The moid of the organization under which this request was issued.



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

def org_moid
  @org_moid
end

#organization ⇒ Object

Returns the value of attribute organization.



69
70
71
 
# File 'lib/intersight_client/models/bulk_request.rb', line 69

def organization
  @organization
end

#request_received_time ⇒ Object

The timestamp when the request was received.



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

def request_received_time
  @request_received_time
end

#requests ⇒ Object

Returns the value of attribute requests.



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

def requests
  @requests
end

#results ⇒ Object

Returns the value of attribute results.



46
47
48
 
# File 'lib/intersight_client/models/bulk_request.rb', line 46

def results
  @results
end

#skip_duplicates ⇒ Object

Skip the already present objects.



49
50
51
 
# File 'lib/intersight_client/models/bulk_request.rb', line 49

def skip_duplicates
  @skip_duplicates
end

#status ⇒ Object

The processing status of the Request. * ‘NotStarted` - Indicates that the request processing has not begun yet. * `ObjPresenceCheckInProgress` - Indicates that the object presence check is in progress for this request. * `ObjPresenceCheckComplete` - Indicates that the object presence check is complete. * `ExecutionInProgress` - Indicates that the request processing is in progress. * `Completed` - Indicates that the request processing has been completed successfully. * `Failed` - Indicates that the processing of this request failed.



52
53
54
 
# File 'lib/intersight_client/models/bulk_request.rb', line 52

def status
  @status
end

#status_message ⇒ Object

The status message corresponding to the status.



55
56
57
 
# File 'lib/intersight_client/models/bulk_request.rb', line 55

def status_message
  @status_message
end

#uri ⇒ Object

The URI on which this bulk action is to be performed. The value will be used when there is no override in the SubRequest.



58
59
60
 
# File 'lib/intersight_client/models/bulk_request.rb', line 58

def uri
  @uri
end

#verb ⇒ Object

The type of operation to be performed. One of - Post (Create), Patch (Update) or Delete (Remove). The value will be used when there is no override in the SubRequest. * ‘POST` - Used to create a REST resource. * `PATCH` - Used to update a REST resource. * `DELETE` - Used to delete a REST resource.



61
62
63
 
# File 'lib/intersight_client/models/bulk_request.rb', line 61

def verb
  @verb
end

#workflow_info ⇒ Object

Returns the value of attribute workflow_info.



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

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



127
128
129
 
# File 'lib/intersight_client/models/bulk_request.rb', line 127

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)



122
123
124
 
# File 'lib/intersight_client/models/bulk_request.rb', line 122

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.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/intersight_client/models/bulk_request.rb', line 96

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'action_on_error' => :'ActionOnError',
    :'actions' => :'Actions',
    :'completion_time' => :'CompletionTime',
    :'headers' => :'Headers',
    :'num_sub_requests' => :'NumSubRequests',
    :'org_moid' => :'OrgMoid',
    :'request_received_time' => :'RequestReceivedTime',
    :'requests' => :'Requests',
    :'results' => :'Results',
    :'skip_duplicates' => :'SkipDuplicates',
    :'status' => :'Status',
    :'status_message' => :'StatusMessage',
    :'uri' => :'Uri',
    :'verb' => :'Verb',
    :'async_results' => :'AsyncResults',
    :'async_results_failed' => :'AsyncResultsFailed',
    :'organization' => :'Organization',
    :'workflow_info' => :'WorkflowInfo'
  }
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



428
429
430
 
# File 'lib/intersight_client/models/bulk_request.rb', line 428

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/bulk_request.rb', line 170

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



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

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/intersight_client/models/bulk_request.rb', line 158

def self.openapi_nullable
  Set.new([
    :'actions',
    :'headers',
    :'requests',
    :'results',
    :'async_results',
    :'async_results_failed',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/intersight_client/models/bulk_request.rb', line 132

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'action_on_error' => :'String',
    :'actions' => :'Array<String>',
    :'completion_time' => :'String',
    :'headers' => :'Array<BulkHttpHeader>',
    :'num_sub_requests' => :'Integer',
    :'org_moid' => :'String',
    :'request_received_time' => :'String',
    :'requests' => :'Array<BulkSubRequest>',
    :'results' => :'Array<BulkApiResult>',
    :'skip_duplicates' => :'Boolean',
    :'status' => :'String',
    :'status_message' => :'String',
    :'uri' => :'String',
    :'verb' => :'String',
    :'async_results' => :'Array<BulkSubRequestObjRelationship>',
    :'async_results_failed' => :'Array<BulkSubRequestObjRelationship>',
    :'organization' => :'OrganizationOrganizationRelationship',
    :'workflow_info' => :'WorkflowWorkflowInfoRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/intersight_client/models/bulk_request.rb', line 388

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      action_on_error == o.action_on_error &&
      actions == o.actions &&
      completion_time == o.completion_time &&
      headers == o.headers &&
      num_sub_requests == o.num_sub_requests &&
      org_moid == o.org_moid &&
      request_received_time == o.request_received_time &&
      requests == o.requests &&
      results == o.results &&
      skip_duplicates == o.skip_duplicates &&
      status == o.status &&
      status_message == o.status_message &&
      uri == o.uri &&
      verb == o.verb &&
      async_results == o.async_results &&
      async_results_failed == o.async_results_failed &&
      organization == o.organization &&
      workflow_info == o.workflow_info && 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



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/intersight_client/models/bulk_request.rb', line 459

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



530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/intersight_client/models/bulk_request.rb', line 530

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



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/intersight_client/models/bulk_request.rb', line 435

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


415
416
417
 
# File 'lib/intersight_client/models/bulk_request.rb', line 415

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



421
422
423
 
# File 'lib/intersight_client/models/bulk_request.rb', line 421

def hash
  [class_id, object_type, action_on_error, actions, completion_time, headers, num_sub_requests, org_moid, request_received_time, requests, results, skip_duplicates, status, status_message, uri, verb, async_results, async_results_failed, organization, workflow_info].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



305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/intersight_client/models/bulk_request.rb', line 305

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



506
507
508
 
# File 'lib/intersight_client/models/bulk_request.rb', line 506

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



512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/intersight_client/models/bulk_request.rb', line 512

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



500
501
502
 
# File 'lib/intersight_client/models/bulk_request.rb', line 500

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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/intersight_client/models/bulk_request.rb', line 320

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["bulk.Request"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["bulk.Request"])
  return false unless object_type_validator.valid?(@object_type)
  action_on_error_validator = EnumAttributeValidator.new('String', ["Stop", "Proceed"])
  return false unless action_on_error_validator.valid?(@action_on_error)
  status_validator = EnumAttributeValidator.new('String', ["NotStarted", "ObjPresenceCheckInProgress", "ObjPresenceCheckComplete", "ExecutionInProgress", "Completed", "Failed"])
  return false unless status_validator.valid?(@status)
  verb_validator = EnumAttributeValidator.new('String', ["POST", "PATCH", "DELETE"])
  return false unless verb_validator.valid?(@verb)
  true && super
end