Class: IntersightClient::BulkMoMerger

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

Overview

The MO Merger interface facilitates merging of all or selected properties of any MO instance to one or more MO instances. The "Sources" array should contain the list of source MO instances as MoRef objects. The "Targets" array should contain the list of target MO instances as MoRef objects. The "TargetConfig" property is applicable only for a merge operation. If a configuration action needs to be applied on all target MOs, it can be specified using this property.

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

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



122
123
124
125
126
127
128
129
130
131
132
133
134
135
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
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 122

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

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

  if attributes.key?(:'merge_action')
    self.merge_action = attributes[:'merge_action']
  else
    self.merge_action = 'Merge'
  end

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

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

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

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

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

def class_id
  @class_id
end

#merge_action ⇒ Object

The type of merge action to be applied on the target MOs. * ‘Merge` - The null properties/relationships of the source MO will be ignored for the target MO. The non-null properties/relationships of the source will override the target MO properties/relationships. * `Replace` - Merge action as described in RFC 7386. The null properties/relationships of the source MO will be deleted on the target MO.The non-null properties/relationships of the source will override the target MO properties/relationships.When source object type is different from target, only the properties common to both source and target will be affected.Other properties on the target will be ignored.



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

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

def object_type
  @object_type
end

#organization ⇒ Object

Returns the value of attribute organization.



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

def organization
  @organization
end

#responses ⇒ Object

Returns the value of attribute responses.



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

def responses
  @responses
end

#sources ⇒ Object

Returns the value of attribute sources.



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

def sources
  @sources
end

#target_config ⇒ Object

Returns the value of attribute target_config.



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

def target_config
  @target_config
end

#targets ⇒ Object

Returns the value of attribute targets.



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

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



80
81
82
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 80

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)



75
76
77
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 75

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.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 61

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'merge_action' => :'MergeAction',
    :'responses' => :'Responses',
    :'sources' => :'Sources',
    :'target_config' => :'TargetConfig',
    :'targets' => :'Targets',
    :'organization' => :'Organization'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



272
273
274
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 272

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



108
109
110
111
112
113
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 108

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



116
117
118
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 116

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
103
104
105
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 99

def self.openapi_nullable
  Set.new([
    :'responses',
    :'sources',
    :'targets',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 85

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'merge_action' => :'String',
    :'responses' => :'Array<BulkRestResult>',
    :'sources' => :'Array<MoBaseMo>',
    :'target_config' => :'MoBaseMo',
    :'targets' => :'Array<MoBaseMo>',
    :'organization' => :'OrganizationOrganizationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      merge_action == o.merge_action &&
      responses == o.responses &&
      sources == o.sources &&
      target_config == o.target_config &&
      targets == o.targets &&
      organization == o.organization && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 303

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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 374

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 279

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

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method

Parameters:

  • to be compared

Returns:



259
260
261
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



265
266
267
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 265

def hash
  [class_id, object_type, merge_action, responses, sources, target_config, targets, organization].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



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 185

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:

  • Returns the object in the form of hash



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

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 356

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



344
345
346
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 344

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/intersight_client/models/bulk_mo_merger.rb', line 200

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["bulk.MoMerger"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["bulk.MoMerger"])
  return false unless object_type_validator.valid?(@object_type)
  merge_action_validator = EnumAttributeValidator.new('String', ["Merge", "Replace"])
  return false unless merge_action_validator.valid?(@merge_action)
  true && super
end