Class: IntersightClient::UcsdBackupInfoAllOf

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

Overview

Definition of the list of properties defined in ‘ucsd.BackupInfo’, excluding properties defined in parent classes.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UcsdBackupInfoAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
245
246
247
248
249
250
251
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 161

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

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'ucsd.BackupInfo'
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#backup_file_name ⇒ Object

Auto generated backup File Name with combination of file prefix given an user input and the timestamp.



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

def backup_file_name
  @backup_file_name
end

#backup_location ⇒ Object

Backup location that contains the backup images for end device which can be used for restore operation.



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

def backup_location
  @backup_location
end

#backup_server_ip ⇒ Object

Backup server where backup images are maintained.



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

def backup_server_ip
  @backup_server_ip
end

#backup_size ⇒ Object

Size of the backup image in bytes.



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

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

def class_id
  @class_id
end

#connectors ⇒ Object

Returns the value of attribute connectors.



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

def connectors
  @connectors
end

#duration ⇒ Object

Time taken for the backup to be completed.



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

def duration
  @duration
end

#encryption_key ⇒ Object

The key used for encrypting the backup file.



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

def encryption_key
  @encryption_key
end

#failure_reason ⇒ Object

Reason for backup failure.



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

def failure_reason
  @failure_reason
end

#is_purged ⇒ Object

Backup image got purged or not. The backup images get purged based on the retention count set by the user in the backup config policy.



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

def is_purged
  @is_purged
end

#last_modified ⇒ Object

Last modified time when this backup record got updated.



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

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

def object_type
  @object_type
end

#percentage_completion ⇒ Object

Backup current precentage completion status information.



55
56
57
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 55

def percentage_completion
  @percentage_completion
end

#product_version ⇒ Object

The end device product version when the backup image was taken.



58
59
60
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 58

def product_version
  @product_version
end

#protocol ⇒ Object

Protocol used for the remote backup. possible values are FTP, SCP and SFTP. Not applicable for the localhost (127.0.0.1).



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

def protocol
  @protocol
end

#stage_completion ⇒ Object

Backup current status stage information.



64
65
66
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 64

def stage_completion
  @stage_completion
end

#start_time ⇒ Object

Start time of backup when it got initiated.



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

def start_time
  @start_time
end

#status ⇒ Object

Current status of Backup current.



70
71
72
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 70

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about



124
125
126
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 124

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



119
120
121
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 119

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'backup_file_name' => :'BackupFileName',
    :'backup_location' => :'BackupLocation',
    :'backup_server_ip' => :'BackupServerIp',
    :'backup_size' => :'BackupSize',
    :'connectors' => :'Connectors',
    :'duration' => :'Duration',
    :'encryption_key' => :'EncryptionKey',
    :'failure_reason' => :'FailureReason',
    :'is_purged' => :'IsPurged',
    :'last_modified' => :'LastModified',
    :'percentage_completion' => :'PercentageCompletion',
    :'product_version' => :'ProductVersion',
    :'protocol' => :'Protocol',
    :'stage_completion' => :'StageCompletion',
    :'start_time' => :'StartTime',
    :'status' => :'Status'
  }
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



340
341
342
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 340

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



153
154
155
156
157
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 153

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'backup_file_name' => :'String',
    :'backup_location' => :'String',
    :'backup_server_ip' => :'String',
    :'backup_size' => :'Integer',
    :'connectors' => :'Array<UcsdConnectorPack>',
    :'duration' => :'Integer',
    :'encryption_key' => :'String',
    :'failure_reason' => :'String',
    :'is_purged' => :'Boolean',
    :'last_modified' => :'Time',
    :'percentage_completion' => :'Integer',
    :'product_version' => :'String',
    :'protocol' => :'String',
    :'stage_completion' => :'String',
    :'start_time' => :'Time',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 302

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      backup_file_name == o.backup_file_name &&
      backup_location == o.backup_location &&
      backup_server_ip == o.backup_server_ip &&
      backup_size == o.backup_size &&
      connectors == o.connectors &&
      duration == o.duration &&
      encryption_key == o.encryption_key &&
      failure_reason == o.failure_reason &&
      is_purged == o.is_purged &&
      last_modified == o.last_modified &&
      percentage_completion == o.percentage_completion &&
      product_version == o.product_version &&
      protocol == o.protocol &&
      stage_completion == o.stage_completion &&
      start_time == o.start_time &&
      status == o.status
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



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 370

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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 441

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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 347

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


327
328
329
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 327

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



333
334
335
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 333

def hash
  [class_id, object_type, backup_file_name, backup_location, backup_server_ip, backup_size, connectors, duration, encryption_key, failure_reason, is_purged, last_modified, percentage_completion, product_version, protocol, stage_completion, start_time, status].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



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

def list_invalid_properties
  invalid_properties = Array.new
  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



417
418
419
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 417

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



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 423

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



411
412
413
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 411

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



270
271
272
273
274
275
276
277
278
 
# File 'lib/intersight_client/models/ucsd_backup_info_all_of.rb', line 270

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