Class: OCI::Database::Models::BackupDestination

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/backup_destination.rb

Overview

Backup destination details.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_NFS = 'NFS'.freeze,
  TYPE_RECOVERY_APPLIANCE = 'RECOVERY_APPLIANCE'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
NFS_MOUNT_TYPE_ENUM = 
[
  NFS_MOUNT_TYPE_SELF_MOUNT = 'SELF_MOUNT'.freeze,
  NFS_MOUNT_TYPE_AUTOMATED_MOUNT = 'AUTOMATED_MOUNT'.freeze,
  NFS_MOUNT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BackupDestination

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
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
 
# File 'lib/oci/database/models/backup_destination.rb', line 218

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  self.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.type = attributes[:'type'] if attributes[:'type']

  self.associated_databases = attributes[:'associatedDatabases'] if attributes[:'associatedDatabases']

  raise 'You cannot provide both :associatedDatabases and :associated_databases' if attributes.key?(:'associatedDatabases') && attributes.key?(:'associated_databases')

  self.associated_databases = attributes[:'associated_databases'] if attributes[:'associated_databases']

  self.associated_long_term_backups = attributes[:'associatedLongTermBackups'] if attributes[:'associatedLongTermBackups']

  raise 'You cannot provide both :associatedLongTermBackups and :associated_long_term_backups' if attributes.key?(:'associatedLongTermBackups') && attributes.key?(:'associated_long_term_backups')

  self.associated_long_term_backups = attributes[:'associated_long_term_backups'] if attributes[:'associated_long_term_backups']

  self.associated_long_term_backup_count = attributes[:'associatedLongTermBackupCount'] if attributes[:'associatedLongTermBackupCount']

  raise 'You cannot provide both :associatedLongTermBackupCount and :associated_long_term_backup_count' if attributes.key?(:'associatedLongTermBackupCount') && attributes.key?(:'associated_long_term_backup_count')

  self.associated_long_term_backup_count = attributes[:'associated_long_term_backup_count'] if attributes[:'associated_long_term_backup_count']

  self.connection_string = attributes[:'connectionString'] if attributes[:'connectionString']

  raise 'You cannot provide both :connectionString and :connection_string' if attributes.key?(:'connectionString') && attributes.key?(:'connection_string')

  self.connection_string = attributes[:'connection_string'] if attributes[:'connection_string']

  self.vpc_users = attributes[:'vpcUsers'] if attributes[:'vpcUsers']

  raise 'You cannot provide both :vpcUsers and :vpc_users' if attributes.key?(:'vpcUsers') && attributes.key?(:'vpc_users')

  self.vpc_users = attributes[:'vpc_users'] if attributes[:'vpc_users']

  self.local_mount_point_path = attributes[:'localMountPointPath'] if attributes[:'localMountPointPath']

  raise 'You cannot provide both :localMountPointPath and :local_mount_point_path' if attributes.key?(:'localMountPointPath') && attributes.key?(:'local_mount_point_path')

  self.local_mount_point_path = attributes[:'local_mount_point_path'] if attributes[:'local_mount_point_path']

  self.nfs_mount_type = attributes[:'nfsMountType'] if attributes[:'nfsMountType']

  raise 'You cannot provide both :nfsMountType and :nfs_mount_type' if attributes.key?(:'nfsMountType') && attributes.key?(:'nfs_mount_type')

  self.nfs_mount_type = attributes[:'nfs_mount_type'] if attributes[:'nfs_mount_type']

  self.nfs_server = attributes[:'nfsServer'] if attributes[:'nfsServer']

  raise 'You cannot provide both :nfsServer and :nfs_server' if attributes.key?(:'nfsServer') && attributes.key?(:'nfs_server')

  self.nfs_server = attributes[:'nfs_server'] if attributes[:'nfs_server']

  self.nfs_server_export = attributes[:'nfsServerExport'] if attributes[:'nfsServerExport']

  raise 'You cannot provide both :nfsServerExport and :nfs_server_export' if attributes.key?(:'nfsServerExport') && attributes.key?(:'nfs_server_export')

  self.nfs_server_export = attributes[:'nfs_server_export'] if attributes[:'nfs_server_export']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

  raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details')

  self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']

  self.total_storage_size_in_gbs = attributes[:'totalStorageSizeInGBs'] if attributes[:'totalStorageSizeInGBs']

  raise 'You cannot provide both :totalStorageSizeInGBs and :total_storage_size_in_gbs' if attributes.key?(:'totalStorageSizeInGBs') && attributes.key?(:'total_storage_size_in_gbs')

  self.total_storage_size_in_gbs = attributes[:'total_storage_size_in_gbs'] if attributes[:'total_storage_size_in_gbs']

  self.utilized_storage_size_in_gbs = attributes[:'utilizedStorageSizeInGBs'] if attributes[:'utilizedStorageSizeInGBs']

  raise 'You cannot provide both :utilizedStorageSizeInGBs and :utilized_storage_size_in_gbs' if attributes.key?(:'utilizedStorageSizeInGBs') && attributes.key?(:'utilized_storage_size_in_gbs')

  self.utilized_storage_size_in_gbs = attributes[:'utilized_storage_size_in_gbs'] if attributes[:'utilized_storage_size_in_gbs']

  self.time_at_which_storage_details_are_updated = attributes[:'timeAtWhichStorageDetailsAreUpdated'] if attributes[:'timeAtWhichStorageDetailsAreUpdated']

  raise 'You cannot provide both :timeAtWhichStorageDetailsAreUpdated and :time_at_which_storage_details_are_updated' if attributes.key?(:'timeAtWhichStorageDetailsAreUpdated') && attributes.key?(:'time_at_which_storage_details_are_updated')

  self.time_at_which_storage_details_are_updated = attributes[:'time_at_which_storage_details_are_updated'] if attributes[:'time_at_which_storage_details_are_updated']
end

Instance Attribute Details

#associated_databases ⇒ Array<OCI::Database::Models::AssociatedDatabaseDetails>

List of databases associated with the backup destination.

Returns:



49
50
51
 
# File 'lib/oci/database/models/backup_destination.rb', line 49

def associated_databases
  @associated_databases
end

#associated_long_term_backup_count ⇒ Integer

Indicates the number of long term backups of Autonomous AI Databases associated with this backup destination.

Returns:

  • (Integer) 


57
58
59
 
# File 'lib/oci/database/models/backup_destination.rb', line 57

def associated_long_term_backup_count
  @associated_long_term_backup_count
end

#associated_long_term_backups ⇒ Array<OCI::Database::Models::AssociatedLongTermBackup>

List of long term backups of Autonomous AI Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024.

Returns:



53
54
55
 
# File 'lib/oci/database/models/backup_destination.rb', line 53

def associated_long_term_backups
  @associated_long_term_backups
end

#compartment_id ⇒ String

The OCID of the compartment.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/database/models/backup_destination.rb', line 41

def compartment_id
  @compartment_id
end

#connection_string ⇒ String

For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/database/models/backup_destination.rb', line 61

def connection_string
  @connection_string
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:

  • (Hash<String, Hash<String, Object>>) 


110
111
112
 
# File 'lib/oci/database/models/backup_destination.rb', line 110

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The user-provided name of the backup destination.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/database/models/backup_destination.rb', line 37

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


104
105
106
 
# File 'lib/oci/database/models/backup_destination.rb', line 104

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the backup destination.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/database/models/backup_destination.rb', line 33

def id
  @id
end

#lifecycle_details ⇒ String

A descriptive text associated with the lifecycleState. Typically contains additional displayable text

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/database/models/backup_destination.rb', line 96

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current lifecycle state of the backup destination.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/database/models/backup_destination.rb', line 86

def lifecycle_state
  @lifecycle_state
end

#local_mount_point_path ⇒ String

The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/database/models/backup_destination.rb', line 70

def local_mount_point_path
  @local_mount_point_path
end

#nfs_mount_type ⇒ String

NFS Mount type for backup destination.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/database/models/backup_destination.rb', line 74

def nfs_mount_type
  @nfs_mount_type
end

#nfs_server ⇒ Array<String>

Host names or IP addresses for NFS Auto mount.

Returns:

  • (Array<String>) 


78
79
80
 
# File 'lib/oci/database/models/backup_destination.rb', line 78

def nfs_server
  @nfs_server
end

#nfs_server_export ⇒ String

Specifies the directory on which to mount the file system

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/database/models/backup_destination.rb', line 82

def nfs_server_export
  @nfs_server_export
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:

  • (Hash<String, Hash<String, Object>>) 


116
117
118
 
# File 'lib/oci/database/models/backup_destination.rb', line 116

def system_tags
  @system_tags
end

#time_at_which_storage_details_are_updated ⇒ DateTime

The time when the total storage size and the utilized storage size of the backup destination are updated.

Returns:

  • (DateTime) 


128
129
130
 
# File 'lib/oci/database/models/backup_destination.rb', line 128

def time_at_which_storage_details_are_updated
  @time_at_which_storage_details_are_updated
end

#time_created ⇒ DateTime

The date and time the backup destination was created.

Returns:

  • (DateTime) 


90
91
92
 
# File 'lib/oci/database/models/backup_destination.rb', line 90

def time_created
  @time_created
end

#total_storage_size_in_gbs ⇒ Integer

The total storage size of the backup destination in GBs, rounded to the nearest integer.

Returns:

  • (Integer) 


120
121
122
 
# File 'lib/oci/database/models/backup_destination.rb', line 120

def total_storage_size_in_gbs
  @total_storage_size_in_gbs
end

#type ⇒ String

Type of the backup destination.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/database/models/backup_destination.rb', line 45

def type
  @type
end

#utilized_storage_size_in_gbs ⇒ Integer

The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.

Returns:

  • (Integer) 


124
125
126
 
# File 'lib/oci/database/models/backup_destination.rb', line 124

def utilized_storage_size_in_gbs
  @utilized_storage_size_in_gbs
end

#vpc_users ⇒ Array<String>

For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

Returns:

  • (Array<String>) 


65
66
67
 
# File 'lib/oci/database/models/backup_destination.rb', line 65

def vpc_users
  @vpc_users
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/database/models/backup_destination.rb', line 131

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'type': :'type',
    'associated_databases': :'associatedDatabases',
    'associated_long_term_backups': :'associatedLongTermBackups',
    'associated_long_term_backup_count': :'associatedLongTermBackupCount',
    'connection_string': :'connectionString',
    'vpc_users': :'vpcUsers',
    'local_mount_point_path': :'localMountPointPath',
    'nfs_mount_type': :'nfsMountType',
    'nfs_server': :'nfsServer',
    'nfs_server_export': :'nfsServerExport',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'total_storage_size_in_gbs': :'totalStorageSizeInGBs',
    'utilized_storage_size_in_gbs': :'utilizedStorageSizeInGBs',
    'time_at_which_storage_details_are_updated': :'timeAtWhichStorageDetailsAreUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/database/models/backup_destination.rb', line 161

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'type': :'String',
    'associated_databases': :'Array<OCI::Database::Models::AssociatedDatabaseDetails>',
    'associated_long_term_backups': :'Array<OCI::Database::Models::AssociatedLongTermBackup>',
    'associated_long_term_backup_count': :'Integer',
    'connection_string': :'String',
    'vpc_users': :'Array<String>',
    'local_mount_point_path': :'String',
    'nfs_mount_type': :'String',
    'nfs_server': :'Array<String>',
    'nfs_server_export': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'total_storage_size_in_gbs': :'Integer',
    'utilized_storage_size_in_gbs': :'Integer',
    'time_at_which_storage_details_are_updated': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/oci/database/models/backup_destination.rb', line 392

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    type == other.type &&
    associated_databases == other.associated_databases &&
    associated_long_term_backups == other.associated_long_term_backups &&
    associated_long_term_backup_count == other.associated_long_term_backup_count &&
    connection_string == other.connection_string &&
    vpc_users == other.vpc_users &&
    local_mount_point_path == other.local_mount_point_path &&
    nfs_mount_type == other.nfs_mount_type &&
    nfs_server == other.nfs_server &&
    nfs_server_export == other.nfs_server_export &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    total_storage_size_in_gbs == other.total_storage_size_in_gbs &&
    utilized_storage_size_in_gbs == other.utilized_storage_size_in_gbs &&
    time_at_which_storage_details_are_updated == other.time_at_which_storage_details_are_updated
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



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/oci/database/models/backup_destination.rb', line 443

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


423
424
425
 
# File 'lib/oci/database/models/backup_destination.rb', line 423

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



432
433
434
 
# File 'lib/oci/database/models/backup_destination.rb', line 432

def hash
  [id, display_name, compartment_id, type, associated_databases, associated_long_term_backups, associated_long_term_backup_count, connection_string, vpc_users, local_mount_point_path, nfs_mount_type, nfs_server, nfs_server_export, lifecycle_state, time_created, lifecycle_details, freeform_tags, defined_tags, system_tags, total_storage_size_in_gbs, utilized_storage_size_in_gbs, time_at_which_storage_details_are_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



476
477
478
479
480
481
482
483
484
485
 
# File 'lib/oci/database/models/backup_destination.rb', line 476

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



470
471
472
 
# File 'lib/oci/database/models/backup_destination.rb', line 470

def to_s
  to_hash.to_s
end