Class: IntersightClient::VirtualizationBaseDatastore

Inherits:
VirtualizationBaseSourceDevice show all
Defined in:
lib/intersight_client/models/virtualization_base_datastore.rb

Overview

Common attributes of a datastore allocated to a hypervisor. Serves as a base class for all concrete datastore types. A datastore is assigned to a datacenter and virtual machines use it for storage. The datastore could be backed by NFS, VMFS, etc.

Direct Known Subclasses

VirtualizationVmwareDatastore

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

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

Initializes the object



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

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

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

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

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

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

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

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

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

Instance Attribute Details

#capacity ⇒ Object

Returns the value of attribute capacity.



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

def capacity
  @capacity
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/virtualization_base_datastore.rb', line 20

def class_id
  @class_id
end

#host_count ⇒ Object

Number of hosts attached to or supported-by this datastore.



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

def host_count
  @host_count
end

#identity ⇒ Object

The internally generated identity of this datastore. This entity is not manipulated by users. It aids in uniquely identifying the datastore object. For VMware, this is a MOR (managed object reference).



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

def identity
  @identity
end

#name ⇒ Object

Name of this datastore supplied by user. It is not the identity of the datastore. The name is subject to user manipulations.



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

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/virtualization_base_datastore.rb', line 23

def object_type
  @object_type
end

#type ⇒ Object

A string indicating the type of the datastore (VMFS, NFS, etc). * Unknown - The nature of the file system is unknown. * VMFS - It is a Virtual Machine Filesystem. * NFS - It is a Network File System. * vSAN - It is a virtual Storage Area Network file system. * VirtualVolume - A Virtual Volume datastore represents a storage container in a hypervisor server.



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

def type
  @type
end

#vm_count ⇒ Object

Number of virtual machines relying on (using) this datastore.



40
41
42
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 40

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



84
85
86
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 84

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)



79
80
81
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 79

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.



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 65

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'capacity' => :'Capacity',
    :'host_count' => :'HostCount',
    :'identity' => :'Identity',
    :'name' => :'Name',
    :'type' => :'Type',
    :'vm_count' => :'VmCount'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



268
269
270
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 268

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



110
111
112
113
114
115
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 110

def self.openapi_all_of
  [
  :'VirtualizationBaseDatastoreAllOf',
  :'VirtualizationBaseSourceDevice'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



118
119
120
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 118

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
107
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 89

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'capacity' => :'VirtualizationStorageCapacity',
    :'host_count' => :'Integer',
    :'identity' => :'String',
    :'name' => :'String',
    :'type' => :'String',
    :'vm_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      capacity == o.capacity &&
      host_count == o.host_count &&
      identity == o.identity &&
      name == o.name &&
      type == o.type &&
      vm_count == o.vm_count && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
334
335
336
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 299

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



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 370

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 275

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

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


255
256
257
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 255

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



261
262
263
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 261

def hash
  [class_id, object_type, capacity, host_count, identity, name, type, vm_count].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 181

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)



346
347
348
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 346

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 352

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



340
341
342
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 340

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/intersight_client/models/virtualization_base_datastore.rb', line 196

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["virtualization.VmwareDatastore"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["virtualization.VmwareDatastore"])
  return false unless object_type_validator.valid?(@object_type)
  type_validator = EnumAttributeValidator.new('String', ["Unknown", "VMFS", "NFS", "vSAN", "VirtualVolume"])
  return false unless type_validator.valid?(@type)
  true && super
end