Class: IntersightClient::StoragePureSnapshotSchedule

Inherits:
StorageBaseSnapshotSchedule show all
Defined in:
lib/intersight_client/models/storage_pure_snapshot_schedule.rb

Overview

PureStorage FlashArray snapshot schedule configuration entity.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from StorageBaseSnapshotSchedule

#frequency, #name, #retention_time, #snapshot_time

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



116
117
118
119
120
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
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 116

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

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

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

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

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

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

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

Instance Attribute Details

#array ⇒ Object

Returns the value of attribute array.



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

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_snapshot_schedule.rb', line 20

def class_id
  @class_id
end

#daily_limit ⇒ Object

Total number of snapshots per day to be available on source above and over the specified retention time. PureStorage FlashArray maintains all created snapshot until retention period. Daily limit is applied only on the snapshots once retention time is expired. In case of, daily limit is less than the number of snapshot available on source, system select snapshots evenly spaced out throughout the day.



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

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

def object_type
  @object_type
end

#protection_group ⇒ Object

Returns the value of attribute protection_group.



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

def protection_group
  @protection_group
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



35
36
37
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 35

def registered_device
  @registered_device
end

#snapshot_expiry_time ⇒ Object

Duration to keep the daily limit snapshots on source array. StorageArray deletes the snapshots permanently from source beyond this period.



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

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



78
79
80
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 78

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)



73
74
75
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 73

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'daily_limit' => :'DailyLimit',
    :'snapshot_expiry_time' => :'SnapshotExpiryTime',
    :'array' => :'Array',
    :'protection_group' => :'ProtectionGroup',
    :'registered_device' => :'RegisteredDevice'
  }
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



241
242
243
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 241

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'StorageBaseSnapshotSchedule',
  :'StoragePureSnapshotScheduleAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



110
111
112
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 110

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 96

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 83

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'daily_limit' => :'Integer',
    :'snapshot_expiry_time' => :'String',
    :'array' => :'StoragePureArrayRelationship',
    :'protection_group' => :'StoragePureProtectionGroupRelationship',
    :'registered_device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      daily_limit == o.daily_limit &&
      snapshot_expiry_time == o.snapshot_expiry_time &&
      array == o.array &&
      protection_group == o.protection_group &&
      registered_device == o.registered_device && 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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 272

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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 343

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


228
229
230
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



234
235
236
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 234

def hash
  [class_id, object_type, daily_limit, snapshot_expiry_time, array, protection_group, registered_device].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



167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 167

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



319
320
321
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 319

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 325

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



313
314
315
 
# File 'lib/intersight_client/models/storage_pure_snapshot_schedule.rb', line 313

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



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

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