Class: IntersightClient::VirtualizationVmwareFolder

Inherits:
VirtualizationBaseFolder show all
Defined in:
lib/intersight_client/models/virtualization_vmware_folder.rb

Overview

A folder in a VMware vCenter. Folder can be created directly under the vCenter, under a datacenter, or inside another folder.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from VirtualizationBaseFolder

#identity, #name

Attributes inherited from VirtualizationBaseSourceDevice

#registered_device

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

  if attributes.key?(:'typeof_folder')
    self.typeof_folder = attributes[:'typeof_folder']
  else
    self.typeof_folder = 'Unknown'
  end

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

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

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

def class_id
  @class_id
end

#datacenter ⇒ Object

Returns the value of attribute datacenter.



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

def datacenter
  @datacenter
end

#hypervisor_manager ⇒ Object

Returns the value of attribute hypervisor_manager.



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

def hypervisor_manager
  @hypervisor_manager
end

#internal ⇒ Object

If a folder is internal, it will be set to true.



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

def internal
  @internal
end

#inventory_path ⇒ Object

Inventory path to the folder. Example - /DC/myFolder.



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

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

def object_type
  @object_type
end

#typeof_folder ⇒ Object

Determines the type of folder. e.g. vCenter folder, VM and Templete Folder, StorageFolder, NetworkFolder, Host and Cluster Folder. * ‘Unknown` - The type of the folder is unknown. It may not represent that the folder does not exist but indicates that something might be wrong. * `VMTemplateFolder` - The folder contains VMs and VM templates. * `StorageFolder` - The folder contains storage devices. * `HostClusterFolder` - The folder contains hosts and clusters. * `NetworkFolder` - The folder contains network items. * `VcenterFolder` - The folder created under a vCenter or vCenter folder.



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

def typeof_folder
  @typeof_folder
end

#vmware_folder ⇒ Object

Returns the value of attribute vmware_folder.



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

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



82
83
84
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 82

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)



77
78
79
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 77

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.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 63

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'internal' => :'Internal',
    :'inventory_path' => :'InventoryPath',
    :'typeof_folder' => :'TypeofFolder',
    :'datacenter' => :'Datacenter',
    :'hypervisor_manager' => :'HypervisorManager',
    :'vmware_folder' => :'VmwareFolder'
  }
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



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

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'VirtualizationBaseFolder',
  :'VirtualizationVmwareFolderAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



115
116
117
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 115

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



101
102
103
104
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 101

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 87

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'internal' => :'Boolean',
    :'inventory_path' => :'String',
    :'typeof_folder' => :'String',
    :'datacenter' => :'VirtualizationVmwareDatacenterRelationship',
    :'hypervisor_manager' => :'VirtualizationVmwareVcenterRelationship',
    :'vmware_folder' => :'VirtualizationVmwareFolderRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 237

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      internal == o.internal &&
      inventory_path == o.inventory_path &&
      typeof_folder == o.typeof_folder &&
      datacenter == o.datacenter &&
      hypervisor_manager == o.hypervisor_manager &&
      vmware_folder == o.vmware_folder && 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



296
297
298
299
300
301
302
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
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 296

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 367

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 272

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


252
253
254
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 252

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



258
259
260
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 258

def hash
  [class_id, object_type, internal, inventory_path, typeof_folder, datacenter, hypervisor_manager, vmware_folder].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



178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 178

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



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

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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 349

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



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

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



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/intersight_client/models/virtualization_vmware_folder.rb', line 193

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["virtualization.VmwareFolder"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["virtualization.VmwareFolder"])
  return false unless object_type_validator.valid?(@object_type)
  typeof_folder_validator = EnumAttributeValidator.new('String', ["Unknown", "VMTemplateFolder", "StorageFolder", "HostClusterFolder", "NetworkFolder", "VcenterFolder"])
  return false unless typeof_folder_validator.valid?(@typeof_folder)
  true && super
end