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
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):



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

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.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_databasesArray<OCI::Database::Models::AssociatedDatabaseDetails>

List of databases associated with the backup destination.



42
43
44
# File 'lib/oci/database/models/backup_destination_summary.rb', line 42

def associated_databases
  @associated_databases
end

#compartment_idString

The OCID of the compartment.

Returns:

  • (String)


34
35
36
# File 'lib/oci/database/models/backup_destination_summary.rb', line 34

def compartment_id
  @compartment_id
end

#connection_stringString

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

Returns:

  • (String)


46
47
48
# File 'lib/oci/database/models/backup_destination_summary.rb', line 46

def connection_string
  @connection_string
end

#defined_tagsHash<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>>)


83
84
85
# File 'lib/oci/database/models/backup_destination_summary.rb', line 83

def defined_tags
  @defined_tags
end

#display_nameString

The user-provided name of the backup destination.

Returns:

  • (String)


30
31
32
# File 'lib/oci/database/models/backup_destination_summary.rb', line 30

def display_name
  @display_name
end

#freeform_tagsHash<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>)


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

def freeform_tags
  @freeform_tags
end

#idString

The OCID of the backup destination.

Returns:

  • (String)


26
27
28
# File 'lib/oci/database/models/backup_destination_summary.rb', line 26

def id
  @id
end

#lifecycle_detailsString

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

Returns:

  • (String)


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

The current lifecycle state of the backup destination.

Returns:

  • (String)


59
60
61
# File 'lib/oci/database/models/backup_destination_summary.rb', line 59

def lifecycle_state
  @lifecycle_state
end

#local_mount_point_pathString

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)


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

def local_mount_point_path
  @local_mount_point_path
end

#time_createdDateTime

The date and time the backup destination was created.

Returns:

  • (DateTime)


63
64
65
# File 'lib/oci/database/models/backup_destination_summary.rb', line 63

def time_created
  @time_created
end

#typeString

Type of the backup destination.

Returns:

  • (String)


38
39
40
# File 'lib/oci/database/models/backup_destination_summary.rb', line 38

def type
  @type
end

#vpc_usersArray<String>

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

Returns:

  • (Array<String>)


50
51
52
# File 'lib/oci/database/models/backup_destination_summary.rb', line 50

def vpc_users
  @vpc_users
end

Class Method Details

.attribute_mapObject

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/oci/database/models/backup_destination_summary.rb', line 86

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',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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 107

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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
# File 'lib/oci/database/models/backup_destination_summary.rb', line 256

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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
# File 'lib/oci/database/models/backup_destination_summary.rb', line 298

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


278
279
280
# File 'lib/oci/database/models/backup_destination_summary.rb', line 278

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



287
288
289
# File 'lib/oci/database/models/backup_destination_summary.rb', line 287

def hash
  [id, display_name, compartment_id, type, associated_databases, connection_string, vpc_users, local_mount_point_path, lifecycle_state, time_created, lifecycle_details, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



331
332
333
334
335
336
337
338
339
340
# File 'lib/oci/database/models/backup_destination_summary.rb', line 331

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



325
326
327
# File 'lib/oci/database/models/backup_destination_summary.rb', line 325

def to_s
  to_hash.to_s
end