Class: IntersightClient::BulkSubRequestObj

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

Overview

The sub request object is created for every subrequest in the incoming request.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 157

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#body ⇒ Object

Returns the value of attribute body.



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

def body
  @body
end

#body_string ⇒ Object

The body of the sub-request in string format.



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

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

def class_id
  @class_id
end

#execution_completion_time ⇒ Object

The time at which processing of this request completed.



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

def execution_completion_time
  @execution_completion_time
end

#execution_start_time ⇒ Object

The time at which processing of this request started.



34
35
36
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 34

def execution_start_time
  @execution_start_time
end

#is_object_present ⇒ Object

This flag indicates if an already existing object was found or not after execution of the action CheckObjectPresence.



37
38
39
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 37

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

def object_type
  @object_type
end

#request ⇒ Object

Returns the value of attribute request.



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

def request
  @request
end

#result ⇒ Object

Returns the value of attribute result.



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

def result
  @result
end

#skip_duplicates ⇒ Object

Skip the already present objects. The value from the Request.



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

def skip_duplicates
  @skip_duplicates
end

#status ⇒ Object

The status of the request. * ‘Pending` - Indicates that the request is yet to be processed. * `ObjPresenceCheckInProgress` - Indicates that the checking for object presence is in progress. * `ObjPresenceCheckInComplete` - Indicates that the request is being processed. * `ObjPresenceCheckFailed` - Indicates that the checking for object presence failed. * `Processing` - Indicates that the request is being processed. * `TimedOut` - Indicates that the request processing timed out. * `Completed` - Indicates that the request processing is complete. * `Skipped` - Indicates that the request was skipped.



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

def status
  @status
end

#system_defined_object_detected ⇒ Object

This flag indicates if the a system defined object was detected after execution of the action CheckObjectPresence.



48
49
50
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 48

def system_defined_object_detected
  @system_defined_object_detected
end

#target_moid ⇒ Object

Used with PATCH & DELETE actions. The moid of an existing object instance.



51
52
53
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 51

def target_moid
  @target_moid
end

#uri ⇒ Object

The URI on which this bulk action is to be performed.



54
55
56
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 54

def uri
  @uri
end

#verb ⇒ Object

The type of operation to be performed. One of - Post (Create), Patch (Update) or Delete (Remove). * ‘POST` - Used to create a REST resource. * `PATCH` - Used to update a REST resource. * `DELETE` - Used to delete a REST resource.



57
58
59
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 57

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



110
111
112
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 110

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)



105
106
107
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 105

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'body' => :'Body',
    :'body_string' => :'BodyString',
    :'execution_completion_time' => :'ExecutionCompletionTime',
    :'execution_start_time' => :'ExecutionStartTime',
    :'is_object_present' => :'IsObjectPresent',
    :'result' => :'Result',
    :'skip_duplicates' => :'SkipDuplicates',
    :'status' => :'Status',
    :'system_defined_object_detected' => :'SystemDefinedObjectDetected',
    :'target_moid' => :'TargetMoid',
    :'uri' => :'Uri',
    :'verb' => :'Verb',
    :'request' => :'Request'
  }
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



350
351
352
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 350

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



143
144
145
146
147
148
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 143

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



151
152
153
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 151

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



136
137
138
139
140
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 136

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'body' => :'MoBaseMo',
    :'body_string' => :'String',
    :'execution_completion_time' => :'String',
    :'execution_start_time' => :'String',
    :'is_object_present' => :'Boolean',
    :'result' => :'BulkApiResult',
    :'skip_duplicates' => :'Boolean',
    :'status' => :'String',
    :'system_defined_object_detected' => :'Boolean',
    :'target_moid' => :'String',
    :'uri' => :'String',
    :'verb' => :'String',
    :'request' => :'BulkRequestRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 315

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      body == o.body &&
      body_string == o.body_string &&
      execution_completion_time == o.execution_completion_time &&
      execution_start_time == o.execution_start_time &&
      is_object_present == o.is_object_present &&
      result == o.result &&
      skip_duplicates == o.skip_duplicates &&
      status == o.status &&
      system_defined_object_detected == o.system_defined_object_detected &&
      target_moid == o.target_moid &&
      uri == o.uri &&
      verb == o.verb &&
      request == o.request && 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



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 381

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



452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 452

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



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 357

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


337
338
339
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 337

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



343
344
345
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 343

def hash
  [class_id, object_type, body, body_string, execution_completion_time, execution_start_time, is_object_present, result, skip_duplicates, status, system_defined_object_detected, target_moid, uri, verb, request].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



244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 244

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



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

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



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 434

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



422
423
424
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 422

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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/intersight_client/models/bulk_sub_request_obj.rb', line 259

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["bulk.SubRequestObj"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["bulk.SubRequestObj"])
  return false unless object_type_validator.valid?(@object_type)
  status_validator = EnumAttributeValidator.new('String', ["Pending", "ObjPresenceCheckInProgress", "ObjPresenceCheckInComplete", "ObjPresenceCheckFailed", "Processing", "TimedOut", "Completed", "Skipped"])
  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