Class: IntersightClient::HyperflexClusterBackupPolicy

Inherits:
PolicyAbstractPolicy show all
Defined in:
lib/intersight_client/models/hyperflex_cluster_backup_policy.rb

Overview

Specifies cluster backup configuration for a HyperFlex Cluster.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from PolicyAbstractPolicy

#description, #name

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

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'backup_data_store_name')
    self.backup_data_store_name = attributes[:'backup_data_store_name']
  else
    self.backup_data_store_name = 'backup-source-ds'
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#backup_data_store_name ⇒ Object

Backup datastore name prefix used during the auto creation of the datastore. All VMs created in this datastore will be automatically backed up.



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

def backup_data_store_name
  @backup_data_store_name
end

#backup_data_store_size ⇒ Object

Replication data store size in backupDataStoreSizeUnit.



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

def backup_data_store_size
  @backup_data_store_size
end

#backup_data_store_size_unit ⇒ Object

Replication data store size.



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

def backup_data_store_size_unit
  @backup_data_store_size_unit
end

#backup_target ⇒ Object

Returns the value of attribute backup_target.



48
49
50
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 48

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

def class_id
  @class_id
end

#cluster_profiles ⇒ Object

An array of relationships to hyperflexClusterProfile resources.



51
52
53
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 51

def cluster_profiles
  @cluster_profiles
end

#data_store_encryption_enabled ⇒ Object

Whether the datastore is encrypted or not.



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

def data_store_encryption_enabled
  @data_store_encryption_enabled
end

#local_snapshot_retention_count ⇒ Object

Number of snapshots that will be retained as part of the Multi Point in Time support.



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

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

def object_type
  @object_type
end

#organization ⇒ Object

Returns the value of attribute organization.



53
54
55
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 53

def organization
  @organization
end

#replication_pair_name_prefix ⇒ Object

Replication cluster pairing name prefix.



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

def replication_pair_name_prefix
  @replication_pair_name_prefix
end

#replication_schedule ⇒ Object

Returns the value of attribute replication_schedule.



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

def replication_schedule
  @replication_schedule
end

#snapshot_retention_count ⇒ Object

Number of snapshots that will be retained as part of the Multi Point in Time support.



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

def snapshot_retention_count
  @snapshot_retention_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)



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

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)



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

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.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 78

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'backup_data_store_name' => :'BackupDataStoreName',
    :'backup_data_store_size' => :'BackupDataStoreSize',
    :'backup_data_store_size_unit' => :'BackupDataStoreSizeUnit',
    :'data_store_encryption_enabled' => :'DataStoreEncryptionEnabled',
    :'local_snapshot_retention_count' => :'LocalSnapshotRetentionCount',
    :'replication_pair_name_prefix' => :'ReplicationPairNamePrefix',
    :'replication_schedule' => :'ReplicationSchedule',
    :'snapshot_retention_count' => :'SnapshotRetentionCount',
    :'backup_target' => :'BackupTarget',
    :'cluster_profiles' => :'ClusterProfiles',
    :'organization' => :'Organization'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



367
368
369
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 367

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



134
135
136
137
138
139
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 134

def self.openapi_all_of
  [
  :'HyperflexClusterBackupPolicyAllOf',
  :'PolicyAbstractPolicy'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



142
143
144
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 142

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
130
131
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 126

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

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 107

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'backup_data_store_name' => :'String',
    :'backup_data_store_size' => :'Integer',
    :'backup_data_store_size_unit' => :'String',
    :'data_store_encryption_enabled' => :'Boolean',
    :'local_snapshot_retention_count' => :'Integer',
    :'replication_pair_name_prefix' => :'String',
    :'replication_schedule' => :'HyperflexReplicationSchedule',
    :'snapshot_retention_count' => :'Integer',
    :'backup_target' => :'HyperflexClusterRelationship',
    :'cluster_profiles' => :'Array<HyperflexClusterProfileRelationship>',
    :'organization' => :'OrganizationOrganizationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 334

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      backup_data_store_name == o.backup_data_store_name &&
      backup_data_store_size == o.backup_data_store_size &&
      backup_data_store_size_unit == o.backup_data_store_size_unit &&
      data_store_encryption_enabled == o.data_store_encryption_enabled &&
      local_snapshot_retention_count == o.local_snapshot_retention_count &&
      replication_pair_name_prefix == o.replication_pair_name_prefix &&
      replication_schedule == o.replication_schedule &&
      snapshot_retention_count == o.snapshot_retention_count &&
      backup_target == o.backup_target &&
      cluster_profiles == o.cluster_profiles &&
      organization == o.organization && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 398

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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 469

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 374

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


354
355
356
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 354

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



360
361
362
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 360

def hash
  [class_id, object_type, backup_data_store_name, backup_data_store_size, backup_data_store_size_unit, data_store_encryption_enabled, local_snapshot_retention_count, replication_pair_name_prefix, replication_schedule, snapshot_retention_count, backup_target, cluster_profiles, organization].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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 239

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

  if !@local_snapshot_retention_count.nil? && @local_snapshot_retention_count > 30
    invalid_properties.push('invalid value for "local_snapshot_retention_count", must be smaller than or equal to 30.')
  end

  if !@local_snapshot_retention_count.nil? && @local_snapshot_retention_count < 1
    invalid_properties.push('invalid value for "local_snapshot_retention_count", must be greater than or equal to 1.')
  end

  if !@snapshot_retention_count.nil? && @snapshot_retention_count > 30
    invalid_properties.push('invalid value for "snapshot_retention_count", must be smaller than or equal to 30.')
  end

  if !@snapshot_retention_count.nil? && @snapshot_retention_count < 1
    invalid_properties.push('invalid value for "snapshot_retention_count", must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



445
446
447
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 445

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 451

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



439
440
441
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 439

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • true if the model is valid



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy.rb', line 270

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hyperflex.ClusterBackupPolicy"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hyperflex.ClusterBackupPolicy"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@local_snapshot_retention_count.nil? && @local_snapshot_retention_count > 30
  return false if !@local_snapshot_retention_count.nil? && @local_snapshot_retention_count < 1
  return false if !@snapshot_retention_count.nil? && @snapshot_retention_count > 30
  return false if !@snapshot_retention_count.nil? && @snapshot_retention_count < 1
  true && super
end