Class: IntersightClient::HyperflexVmSnapshotInfo

Inherits:
MoBaseMo
  • Object
show all
Defined in:
lib/intersight_client/models/hyperflex_vm_snapshot_info.rb

Overview

Virtual Machine Snapshot information like replication status, snapshot point and status.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

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

Initializes the object



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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 181

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

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

def class_id
  @class_id
end

#cluster_id_snap_map ⇒ Object

Returns the value of attribute cluster_id_snap_map.



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

def cluster_id_snap_map
  @cluster_id_snap_map
end

#display_status ⇒ Object

Combined status code from replication and snapshot status to display in the Intersight UI. * NONE - Snapshot replication state is none. * SUCCESS - Snapshot completed successfully. * FAILED - Snapshot failed replication status code. * PAUSED - Snapshot replication paused status code. * IN_USE - Snapshot replica in use status code. * STARTING - Snapshot replication starting. * REPLICATING - Snapshot replication in progress.



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

def display_status
  @display_status
end

#error ⇒ Object

Returns the value of attribute error.



30
31
32
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 30

def error
  @error
end

#label ⇒ Object

The name of the Virtual Machine and the time stamp of the snapshot.



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

def label
  @label
end

#mode ⇒ Object

Quiesce Mode for snapshot taken on Hyperflex cluster. * NONE - The snapshot quiesce mode is none. * CRASH - The snapshot quiesce mode is crash. * VMTOOLS - The snapshot quiesce mode is VMTOOLS. * APP_CONSISTENT - The snapshot quiesce mode is app consistent.



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

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

def object_type
  @object_type
end

#parent_snapshot ⇒ Object

Returns the value of attribute parent_snapshot.



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

def parent_snapshot
  @parent_snapshot
end

#replication_status ⇒ Object

Replication status of the least successful target cluster. * NONE - Snapshot replication state is none. * SUCCESS - Snapshot completed successfully. * FAILED - Snapshot failed replication status code. * PAUSED - Snapshot replication paused status code. * IN_USE - Snapshot replica in use status code. * STARTING - Snapshot replication starting. * REPLICATING - Snapshot replication in progress.



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

def replication_status
  @replication_status
end

#snapshot_error_msg ⇒ Object

Error message from snapshot creation or replcation if any exist.



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

def snapshot_error_msg
  @snapshot_error_msg
end

#snapshot_status ⇒ Object

Snapshot status of the source cluster. * SUCCESS - This snapshot status code is success. * FAILED - This snapshot status code is failed. * IN_PROGRESS - This snapshot status code is in progress. * DELETING - This snapshot status code is deleting. * DELETED - This snapshot status code is deleted. * NONE - This snapshot status code is none. * INIT - This snapshot status code is initializing.



47
48
49
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 47

def snapshot_status
  @snapshot_status
end

#source_timestamp ⇒ Object

Timestamp the snapshot was created on the source cluster.



50
51
52
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 50

def source_timestamp
  @source_timestamp
end

#src_cluster ⇒ Object

Returns the value of attribute src_cluster.



65
66
67
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 65

def src_cluster
  @src_cluster
end

#src_cluster_name ⇒ Object

Name of the cluster this snapshot resides on.



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

def src_cluster_name
  @src_cluster_name
end

#target_completion_timestamp ⇒ Object

Timestamp the snapshot was finished replicating on the target cluster.



56
57
58
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 56

def target_completion_timestamp
  @target_completion_timestamp
end

#tgt_cluster ⇒ Object

Returns the value of attribute tgt_cluster.



67
68
69
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 67

def tgt_cluster
  @tgt_cluster
end

#tgt_cluster_name ⇒ Object

Name of the cluster this snapshot is replicated to.



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

def tgt_cluster_name
  @tgt_cluster_name
end

#vm_backup_info ⇒ Object

Returns the value of attribute vm_backup_info.



69
70
71
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 69

def vm_backup_info
  @vm_backup_info
end

#vm_entity_reference ⇒ Object

Returns the value of attribute vm_entity_reference.



61
62
63
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 61

def vm_entity_reference
  @vm_entity_reference
end

#vm_snapshot_entity_reference ⇒ Object

Returns the value of attribute vm_snapshot_entity_reference.



63
64
65
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 63

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



125
126
127
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 125

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)



120
121
122
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 120

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.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 94

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'cluster_id_snap_map' => :'ClusterIdSnapMap',
    :'display_status' => :'DisplayStatus',
    :'error' => :'Error',
    :'label' => :'Label',
    :'mode' => :'Mode',
    :'parent_snapshot' => :'ParentSnapshot',
    :'replication_status' => :'ReplicationStatus',
    :'snapshot_error_msg' => :'SnapshotErrorMsg',
    :'snapshot_status' => :'SnapshotStatus',
    :'source_timestamp' => :'SourceTimestamp',
    :'src_cluster_name' => :'SrcClusterName',
    :'target_completion_timestamp' => :'TargetCompletionTimestamp',
    :'tgt_cluster_name' => :'TgtClusterName',
    :'vm_entity_reference' => :'VmEntityReference',
    :'vm_snapshot_entity_reference' => :'VmSnapshotEntityReference',
    :'src_cluster' => :'SrcCluster',
    :'tgt_cluster' => :'TgtCluster',
    :'vm_backup_info' => :'VmBackupInfo'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



429
430
431
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 429

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



167
168
169
170
171
172
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 167

def self.openapi_all_of
  [
  :'HyperflexVmSnapshotInfoAllOf',
  :'MoBaseMo'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



175
176
177
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 175

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



156
157
158
159
160
161
162
163
164
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 156

def self.openapi_nullable
  Set.new([
    :'cluster_id_snap_map',
    :'error',
    :'parent_snapshot',
    :'vm_entity_reference',
    :'vm_snapshot_entity_reference',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 130

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'cluster_id_snap_map' => :'Array<HyperflexMapClusterIdToStSnapshotPoint>',
    :'display_status' => :'String',
    :'error' => :'HyperflexErrorStack',
    :'label' => :'String',
    :'mode' => :'String',
    :'parent_snapshot' => :'HyperflexEntityReference',
    :'replication_status' => :'String',
    :'snapshot_error_msg' => :'String',
    :'snapshot_status' => :'String',
    :'source_timestamp' => :'Integer',
    :'src_cluster_name' => :'String',
    :'target_completion_timestamp' => :'Integer',
    :'tgt_cluster_name' => :'String',
    :'vm_entity_reference' => :'HyperflexEntityReference',
    :'vm_snapshot_entity_reference' => :'HyperflexEntityReference',
    :'src_cluster' => :'HyperflexClusterRelationship',
    :'tgt_cluster' => :'HyperflexClusterRelationship',
    :'vm_backup_info' => :'HyperflexVmBackupInfoRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 389

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      cluster_id_snap_map == o.cluster_id_snap_map &&
      display_status == o.display_status &&
      error == o.error &&
      label == o.label &&
      mode == o.mode &&
      parent_snapshot == o.parent_snapshot &&
      replication_status == o.replication_status &&
      snapshot_error_msg == o.snapshot_error_msg &&
      snapshot_status == o.snapshot_status &&
      source_timestamp == o.source_timestamp &&
      src_cluster_name == o.src_cluster_name &&
      target_completion_timestamp == o.target_completion_timestamp &&
      tgt_cluster_name == o.tgt_cluster_name &&
      vm_entity_reference == o.vm_entity_reference &&
      vm_snapshot_entity_reference == o.vm_snapshot_entity_reference &&
      src_cluster == o.src_cluster &&
      tgt_cluster == o.tgt_cluster &&
      vm_backup_info == o.vm_backup_info && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 460

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



531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 531

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



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 436

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

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


416
417
418
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 416

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



422
423
424
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 422

def hash
  [class_id, object_type, cluster_id_snap_map, display_status, error, label, mode, parent_snapshot, replication_status, snapshot_error_msg, snapshot_status, source_timestamp, src_cluster_name, target_completion_timestamp, tgt_cluster_name, vm_entity_reference, vm_snapshot_entity_reference, src_cluster, tgt_cluster, vm_backup_info].hash
end

#list_invalid_properties ⇒ Object

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



294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 294

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)



507
508
509
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 507

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 513

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



501
502
503
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 501

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/intersight_client/models/hyperflex_vm_snapshot_info.rb', line 309

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hyperflex.VmSnapshotInfo"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hyperflex.VmSnapshotInfo"])
  return false unless object_type_validator.valid?(@object_type)
  display_status_validator = EnumAttributeValidator.new('String', ["NONE", "SUCCESS", "FAILED", "PAUSED", "IN_USE", "STARTING", "REPLICATING"])
  return false unless display_status_validator.valid?(@display_status)
  mode_validator = EnumAttributeValidator.new('String', ["NONE", "CRASH", "VMTOOLS", "APP_CONSISTENT"])
  return false unless mode_validator.valid?(@mode)
  replication_status_validator = EnumAttributeValidator.new('String', ["NONE", "SUCCESS", "FAILED", "PAUSED", "IN_USE", "STARTING", "REPLICATING"])
  return false unless replication_status_validator.valid?(@replication_status)
  snapshot_status_validator = EnumAttributeValidator.new('String', ["SUCCESS", "FAILED", "IN_PROGRESS", "DELETING", "DELETED", "NONE", "INIT"])
  return false unless snapshot_status_validator.valid?(@snapshot_status)
  true && super
end