Class: IntersightClient::StorageNetAppVolume

Inherits:
StorageBaseStorageContainer show all
Defined in:
lib/intersight_client/models/storage_net_app_volume.rb

Overview

NetApp volume are data containers that enable you to partition and manage your data.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from StorageBaseStorageContainer

#created_time, #name, #storage_utilization

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

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
241
242
243
244
 
# File 'lib/intersight_client/models/storage_net_app_volume.rb', line 157

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

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

  if attributes.key?(:'autosize_mode')
    self.autosize_mode = attributes[:'autosize_mode']
  else
    self.autosize_mode = 'off'
  end

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

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

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

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

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

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

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  else
    self.state = 'offline'
  end

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

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

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

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

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

Instance Attribute Details

#array ⇒ Object

Returns the value of attribute array.



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

def array
  @array
end

#autosize_mode ⇒ Object

The autosize mode for NetApp Volume. Modes can be off or grow or grow_shrink. * ‘off` - The volume will not grow or shrink in size in response to the amount of used space. * `grow` - The volume will automatically grow when used space in the volume is above the grow threshold. * `grow_shrink` - The volume will grow or shrink in size in response to the amount of used space.



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

def autosize_mode
  @autosize_mode
end

#avg_performance_metrics ⇒ Object

Returns the value of attribute avg_performance_metrics.



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

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

def class_id
  @class_id
end

#disk_pool ⇒ Object

An array of relationships to storageNetAppAggregate resources.



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

def disk_pool
  @disk_pool
end

#export_policy_name ⇒ Object

The name of the Export Policy.



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

def export_policy_name
  @export_policy_name
end

#key ⇒ Object

Unique identifier of NetApp Volume across data center.



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

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

def object_type
  @object_type
end

#snapshot_policy_name ⇒ Object

The name of the Snapshot Policy.



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

def snapshot_policy_name
  @snapshot_policy_name
end

#snapshot_policy_uuid ⇒ Object

The UUID of the Snapshot Policy.



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

def snapshot_policy_uuid
  @snapshot_policy_uuid
end

#snapshot_utilized_capacity ⇒ Object

The total space used by Snapshot copies in the volume represented in bytes.



43
44
45
 
# File 'lib/intersight_client/models/storage_net_app_volume.rb', line 43

def snapshot_utilized_capacity
  @snapshot_utilized_capacity
end

#state ⇒ Object

The current state of a NetApp volume. * ‘offline` - Read and write access to the volume is not allowed. * `online` - Read and write access to the volume is allowed. * `error` - Storage volume state of error type. * `mixed` - The constituents of a FlexGroup volume are not all in the same state.



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

def state
  @state
end

#tenant ⇒ Object

Returns the value of attribute tenant.



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

def tenant
  @tenant
end

#type ⇒ Object

NetApp volume type. The volume type can be Read-write, Data-protection, or Load-sharing. * ‘data-protection` - Prevents modification of the data on the Volume. * `read-write` - Data on the Volume can be modified. * `load-sharing` - The volume type is Load Sharing DP.



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

def type
  @type
end

#uuid ⇒ Object

Universally unique identifier of a NetApp Volume.



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

def uuid
  @uuid
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/storage_net_app_volume.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/storage_net_app_volume.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/storage_net_app_volume.rb', line 84

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'autosize_mode' => :'AutosizeMode',
    :'avg_performance_metrics' => :'AvgPerformanceMetrics',
    :'export_policy_name' => :'ExportPolicyName',
    :'key' => :'Key',
    :'snapshot_policy_name' => :'SnapshotPolicyName',
    :'snapshot_policy_uuid' => :'SnapshotPolicyUuid',
    :'snapshot_utilized_capacity' => :'SnapshotUtilizedCapacity',
    :'state' => :'State',
    :'type' => :'Type',
    :'uuid' => :'Uuid',
    :'array' => :'Array',
    :'disk_pool' => :'DiskPool',
    :'tenant' => :'Tenant'
  }
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



400
401
402
 
# File 'lib/intersight_client/models/storage_net_app_volume.rb', line 400

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/storage_net_app_volume.rb', line 143

def self.openapi_all_of
  [
  :'StorageBaseStorageContainer',
  :'StorageNetAppVolumeAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



151
152
153
 
# File 'lib/intersight_client/models/storage_net_app_volume.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/storage_net_app_volume.rb', line 136

def self.openapi_nullable
  Set.new([
    :'disk_pool',
  ])
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/storage_net_app_volume.rb', line 115

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'autosize_mode' => :'String',
    :'avg_performance_metrics' => :'StorageNetAppPerformanceMetricsAverage',
    :'export_policy_name' => :'String',
    :'key' => :'String',
    :'snapshot_policy_name' => :'String',
    :'snapshot_policy_uuid' => :'String',
    :'snapshot_utilized_capacity' => :'Integer',
    :'state' => :'String',
    :'type' => :'String',
    :'uuid' => :'String',
    :'array' => :'StorageNetAppClusterRelationship',
    :'disk_pool' => :'Array<StorageNetAppAggregateRelationship>',
    :'tenant' => :'StorageNetAppStorageVmRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/intersight_client/models/storage_net_app_volume.rb', line 365

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      autosize_mode == o.autosize_mode &&
      avg_performance_metrics == o.avg_performance_metrics &&
      export_policy_name == o.export_policy_name &&
      key == o.key &&
      snapshot_policy_name == o.snapshot_policy_name &&
      snapshot_policy_uuid == o.snapshot_policy_uuid &&
      snapshot_utilized_capacity == o.snapshot_utilized_capacity &&
      state == o.state &&
      type == o.type &&
      uuid == o.uuid &&
      array == o.array &&
      disk_pool == o.disk_pool &&
      tenant == o.tenant && 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



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/intersight_client/models/storage_net_app_volume.rb', line 431

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



502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/intersight_client/models/storage_net_app_volume.rb', line 502

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



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/intersight_client/models/storage_net_app_volume.rb', line 407

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


387
388
389
 
# File 'lib/intersight_client/models/storage_net_app_volume.rb', line 387

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



393
394
395
 
# File 'lib/intersight_client/models/storage_net_app_volume.rb', line 393

def hash
  [class_id, object_type, autosize_mode, avg_performance_metrics, export_policy_name, key, snapshot_policy_name, snapshot_policy_uuid, snapshot_utilized_capacity, state, type, uuid, array, disk_pool, tenant].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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/intersight_client/models/storage_net_app_volume.rb', line 248

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

  pattern = Regexp.new(/^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
  if !@snapshot_policy_uuid.nil? && @snapshot_policy_uuid !~ pattern
    invalid_properties.push("invalid value for \"snapshot_policy_uuid\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
  if !@uuid.nil? && @uuid !~ pattern
    invalid_properties.push("invalid value for \"uuid\", must conform to the pattern #{pattern}.")
  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



478
479
480
 
# File 'lib/intersight_client/models/storage_net_app_volume.rb', line 478

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



484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/intersight_client/models/storage_net_app_volume.rb', line 484

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



472
473
474
 
# File 'lib/intersight_client/models/storage_net_app_volume.rb', line 472

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



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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["storage.NetAppVolume"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["storage.NetAppVolume"])
  return false unless object_type_validator.valid?(@object_type)
  autosize_mode_validator = EnumAttributeValidator.new('String', ["off", "grow", "grow_shrink"])
  return false unless autosize_mode_validator.valid?(@autosize_mode)
  return false if !@snapshot_policy_uuid.nil? && @snapshot_policy_uuid !~ Regexp.new(/^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
  state_validator = EnumAttributeValidator.new('String', ["offline", "online", "error", "mixed"])
  return false unless state_validator.valid?(@state)
  type_validator = EnumAttributeValidator.new('String', ["data-protection", "read-write", "load-sharing"])
  return false unless type_validator.valid?(@type)
  return false if !@uuid.nil? && @uuid !~ Regexp.new(/^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
  true && super
end