Class: OCI::Database::Models::BackupDestinationSummary

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

Overview

Backup destination details, including the list of databases using the backup destination.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :type (String) —

    The value to assign to the #type property

  • :associated_databases (Array<OCI::Database::Models::AssociatedDatabaseDetails>) —

    The value to assign to the #associated_databases property

  • :connection_string (String) —

    The value to assign to the #connection_string property

  • :vpc_users (Array<String>) —

    The value to assign to the #vpc_users property

  • :local_mount_point_path (String) —

    The value to assign to the #local_mount_point_path property

  • :nfs_mount_type (String) —

    The value to assign to the #nfs_mount_type property

  • :nfs_server (Array<String>) —

    The value to assign to the #nfs_server property

  • :nfs_server_export (String) —

    The value to assign to the #nfs_server_export property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 173

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

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  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.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']
end

Instance Attribute Details

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

List of databases associated with the backup destination.

Returns:



48
49
50
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 48

def associated_databases
  @associated_databases
end

#compartment_id ⇒ String

The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 40

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) 


52
53
54
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 52

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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Returns:

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


101
102
103
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 101

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The user-provided name of the backup destination.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 36

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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


95
96
97
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 95

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the backup destination.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 32

def id
  @id
end

#lifecycle_details ⇒ String

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

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 87

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current lifecycle state of the backup destination.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 77

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) 


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

def local_mount_point_path
  @local_mount_point_path
end

#nfs_mount_type ⇒ String

NFS Mount type for backup destination.

Returns:

  • (String) 


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

def nfs_mount_type
  @nfs_mount_type
end

#nfs_server ⇒ Array<String>

Host names or IP addresses for NFS Auto mount.

Returns:

  • (Array<String>) 


69
70
71
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 69

def nfs_server
  @nfs_server
end

#nfs_server_export ⇒ String

Specifies the directory on which to mount the file system

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 73

def nfs_server_export
  @nfs_server_export
end

#time_created ⇒ DateTime

The date and time the backup destination was created.

Returns:

  • (DateTime) 


81
82
83
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 81

def time_created
  @time_created
end

#type ⇒ String

Type of the backup destination.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 44

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


56
57
58
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 56

def vpc_users
  @vpc_users
end

Class Method Details

.attribute_map ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 104

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'type': :'type',
    'associated_databases': :'associatedDatabases',
    '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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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>',
    '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>>'
    # 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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 314

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 &&
    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
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



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 359

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


339
340
341
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 339

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



348
349
350
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 348

def hash
  [id, display_name, compartment_id, type, associated_databases, 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].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



392
393
394
395
396
397
398
399
400
401
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 392

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



386
387
388
 
# File 'lib/oci/database/models/backup_destination_summary.rb', line 386

def to_s
  to_hash.to_s
end