Class: IntersightClient::StoragePureProtectionGroup

Inherits:
StorageBaseProtectionGroup show all
Defined in:
lib/intersight_client/models/storage_pure_protection_group.rb

Overview

Protection group entity in Pure storage array. A volume can be protected by associating with protection group either directly or indirectly (either host or host group). Snapshots are created on protected volume in local array or target array or both as per scheduler configuration.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from StorageBaseProtectionGroup

#name, #prefix, #replication_enabled, #snapshot_enabled

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 135

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#array ⇒ Object

Returns the value of attribute array.



33
34
35
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 33

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

def class_id
  @class_id
end

#host_groups ⇒ Object

An array of relationships to storagePureHostGroup resources.



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

def host_groups
  @host_groups
end

#hosts ⇒ Object

An array of relationships to storagePureHost resources.



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

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

def object_type
  @object_type
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



41
42
43
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 41

def registered_device
  @registered_device
end

#size ⇒ Object

Overall size of all snapshots in the protection group, represented in bytes.



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

def size
  @size
end

#source ⇒ Object

Name of PureStorage array name on which the protection group is created.



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

def source
  @source
end

#targets ⇒ Object

Returns the value of attribute targets.



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

def targets
  @targets
end

#volumes ⇒ Object

An array of relationships to storagePureVolume resources.



44
45
46
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 44

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



90
91
92
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 90

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)



85
86
87
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 85

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.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 69

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'size' => :'Size',
    :'source' => :'Source',
    :'targets' => :'Targets',
    :'array' => :'Array',
    :'host_groups' => :'HostGroups',
    :'hosts' => :'Hosts',
    :'registered_device' => :'RegisteredDevice',
    :'volumes' => :'Volumes'
  }
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



283
284
285
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 283

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



121
122
123
124
125
126
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 121

def self.openapi_all_of
  [
  :'StorageBaseProtectionGroup',
  :'StoragePureProtectionGroupAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



129
130
131
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 129

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



111
112
113
114
115
116
117
118
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 111

def self.openapi_nullable
  Set.new([
    :'targets',
    :'host_groups',
    :'hosts',
    :'volumes'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 95

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'size' => :'Integer',
    :'source' => :'String',
    :'targets' => :'Array<String>',
    :'array' => :'StoragePureArrayRelationship',
    :'host_groups' => :'Array<StoragePureHostGroupRelationship>',
    :'hosts' => :'Array<StoragePureHostRelationship>',
    :'registered_device' => :'AssetDeviceRegistrationRelationship',
    :'volumes' => :'Array<StoragePureVolumeRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      size == o.size &&
      source == o.source &&
      targets == o.targets &&
      array == o.array &&
      host_groups == o.host_groups &&
      hosts == o.hosts &&
      registered_device == o.registered_device &&
      volumes == o.volumes && 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



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
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 314

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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 385

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 290

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


270
271
272
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



276
277
278
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 276

def hash
  [class_id, object_type, size, source, targets, array, host_groups, hosts, registered_device, volumes].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



206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 206

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



361
362
363
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 361

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



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

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



355
356
357
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 355

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



221
222
223
224
225
226
227
228
229
 
# File 'lib/intersight_client/models/storage_pure_protection_group.rb', line 221

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["storage.PureProtectionGroup"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["storage.PureProtectionGroup"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end