Class: OCI::Database::Models::BackupDestinationDetails

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

Overview

Backup destination details

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_NFS = 'NFS'.freeze,
  TYPE_RECOVERY_APPLIANCE = 'RECOVERY_APPLIANCE'.freeze,
  TYPE_OBJECT_STORE = 'OBJECT_STORE'.freeze,
  TYPE_LOCAL = 'LOCAL'.freeze,
  TYPE_DBRS = 'DBRS'.freeze,
  TYPE_AWS_S3 = 'AWS_S3'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
BACKUP_RETENTION_POLICY_ON_TERMINATE_ENUM = 
[
  BACKUP_RETENTION_POLICY_ON_TERMINATE_RETAIN_PER_RETENTION_WINDOW = 'RETAIN_PER_RETENTION_WINDOW'.freeze,
  BACKUP_RETENTION_POLICY_ON_TERMINATE_RETAIN_FOR_72_HOURS = 'RETAIN_FOR_72_HOURS'.freeze,
  BACKUP_RETENTION_POLICY_ON_TERMINATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BackupDestinationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property

  • :id (String) —

    The value to assign to the #id property

  • :vpc_user (String) —

    The value to assign to the #vpc_user property

  • :vpc_password (String) —

    The value to assign to the #vpc_password property

  • :is_zero_data_loss_enabled (BOOLEAN) —

    The value to assign to the #is_zero_data_loss_enabled property

  • :internet_proxy (String) —

    The value to assign to the #internet_proxy property

  • :dbrs_policy_id (String) —

    The value to assign to the #dbrs_policy_id property

  • :is_retention_lock_enabled (BOOLEAN) —

    The value to assign to the #is_retention_lock_enabled property

  • :backup_retention_policy_on_terminate (String) —

    The value to assign to the #backup_retention_policy_on_terminate property

  • :is_remote (BOOLEAN) —

    The value to assign to the #is_remote property

  • :remote_region (String) —

    The value to assign to the #remote_region property



137
138
139
140
141
142
143
144
145
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
 
# File 'lib/oci/database/models/backup_destination_details.rb', line 137

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.type = attributes[:'type'] if attributes[:'type']

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

  self.vpc_user = attributes[:'vpcUser'] if attributes[:'vpcUser']

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

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

  self.vpc_password = attributes[:'vpcPassword'] if attributes[:'vpcPassword']

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

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

  self.is_zero_data_loss_enabled = attributes[:'isZeroDataLossEnabled'] unless attributes[:'isZeroDataLossEnabled'].nil?
  self.is_zero_data_loss_enabled = true if is_zero_data_loss_enabled.nil? && !attributes.key?(:'isZeroDataLossEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_zero_data_loss_enabled = attributes[:'is_zero_data_loss_enabled'] unless attributes[:'is_zero_data_loss_enabled'].nil?
  self.is_zero_data_loss_enabled = true if is_zero_data_loss_enabled.nil? && !attributes.key?(:'isZeroDataLossEnabled') && !attributes.key?(:'is_zero_data_loss_enabled') # rubocop:disable Style/StringLiterals

  self.internet_proxy = attributes[:'internetProxy'] if attributes[:'internetProxy']

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

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

  self.dbrs_policy_id = attributes[:'dbrsPolicyId'] if attributes[:'dbrsPolicyId']

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

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

  self.is_retention_lock_enabled = attributes[:'isRetentionLockEnabled'] unless attributes[:'isRetentionLockEnabled'].nil?

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

  self.is_retention_lock_enabled = attributes[:'is_retention_lock_enabled'] unless attributes[:'is_retention_lock_enabled'].nil?

  self.backup_retention_policy_on_terminate = attributes[:'backupRetentionPolicyOnTerminate'] if attributes[:'backupRetentionPolicyOnTerminate']
  self.backup_retention_policy_on_terminate = "RETAIN_FOR_72_HOURS" if backup_retention_policy_on_terminate.nil? && !attributes.key?(:'backupRetentionPolicyOnTerminate') # rubocop:disable Style/StringLiterals

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

  self.backup_retention_policy_on_terminate = attributes[:'backup_retention_policy_on_terminate'] if attributes[:'backup_retention_policy_on_terminate']
  self.backup_retention_policy_on_terminate = "RETAIN_FOR_72_HOURS" if backup_retention_policy_on_terminate.nil? && !attributes.key?(:'backupRetentionPolicyOnTerminate') && !attributes.key?(:'backup_retention_policy_on_terminate') # rubocop:disable Style/StringLiterals

  self.is_remote = attributes[:'isRemote'] unless attributes[:'isRemote'].nil?
  self.is_remote = false if is_remote.nil? && !attributes.key?(:'isRemote') # rubocop:disable Style/StringLiterals

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

  self.is_remote = attributes[:'is_remote'] unless attributes[:'is_remote'].nil?
  self.is_remote = false if is_remote.nil? && !attributes.key?(:'isRemote') && !attributes.key?(:'is_remote') # rubocop:disable Style/StringLiterals

  self.remote_region = attributes[:'remoteRegion'] if attributes[:'remoteRegion']

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

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

Instance Attribute Details

#backup_retention_policy_on_terminate ⇒ String

Defines the automatic and manual backup retention policy for the Autonomous AI Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'.

Returns:

  • (String) 


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

def backup_retention_policy_on_terminate
  @backup_retention_policy_on_terminate
end

#dbrs_policy_id ⇒ String

The OCID of the DBRS policy used for backup.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/database/models/backup_destination_details.rb', line 54

def dbrs_policy_id
  @dbrs_policy_id
end

#id ⇒ String

The OCID of the backup destination.

Returns:

  • (String) 


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

def id
  @id
end

#internet_proxy ⇒ String

Proxy URL to connect to object store.

Returns:

  • (String) 


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

def internet_proxy
  @internet_proxy
end

#is_remote ⇒ BOOLEAN

Indicates whether the backup destination is cross-region or local.

Returns:

  • (BOOLEAN) 


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

def is_remote
  @is_remote
end

#is_retention_lock_enabled ⇒ BOOLEAN

Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination.

Returns:

  • (BOOLEAN) 


62
63
64
 
# File 'lib/oci/database/models/backup_destination_details.rb', line 62

def is_retention_lock_enabled
  @is_retention_lock_enabled
end

#is_zero_data_loss_enabled ⇒ BOOLEAN

Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to TRUE if no value is given.

Returns:

  • (BOOLEAN) 


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

def is_zero_data_loss_enabled
  @is_zero_data_loss_enabled
end

#remote_region ⇒ String

The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/database/models/backup_destination_details.rb', line 80

def remote_region
  @remote_region
end

#type ⇒ String

[Required] Type of the database backup destination.

Returns:

  • (String) 


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

def type
  @type
end

#vpc_password ⇒ String

For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.

Returns:

  • (String) 


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

def vpc_password
  @vpc_password
end

#vpc_user ⇒ String

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

Returns:

  • (String) 


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

def vpc_user
  @vpc_user
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/database/models/backup_destination_details.rb', line 83

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'id': :'id',
    'vpc_user': :'vpcUser',
    'vpc_password': :'vpcPassword',
    'is_zero_data_loss_enabled': :'isZeroDataLossEnabled',
    'internet_proxy': :'internetProxy',
    'dbrs_policy_id': :'dbrsPolicyId',
    'is_retention_lock_enabled': :'isRetentionLockEnabled',
    'backup_retention_policy_on_terminate': :'backupRetentionPolicyOnTerminate',
    'is_remote': :'isRemote',
    'remote_region': :'remoteRegion'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/database/models/backup_destination_details.rb', line 102

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'id': :'String',
    'vpc_user': :'String',
    'vpc_password': :'String',
    'is_zero_data_loss_enabled': :'BOOLEAN',
    'internet_proxy': :'String',
    'dbrs_policy_id': :'String',
    'is_retention_lock_enabled': :'BOOLEAN',
    'backup_retention_policy_on_terminate': :'String',
    'is_remote': :'BOOLEAN',
    'remote_region': :'String'
    # 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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/database/models/backup_destination_details.rb', line 241

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

  self.class == other.class &&
    type == other.type &&
    id == other.id &&
    vpc_user == other.vpc_user &&
    vpc_password == other.vpc_password &&
    is_zero_data_loss_enabled == other.is_zero_data_loss_enabled &&
    internet_proxy == other.internet_proxy &&
    dbrs_policy_id == other.dbrs_policy_id &&
    is_retention_lock_enabled == other.is_retention_lock_enabled &&
    backup_retention_policy_on_terminate == other.backup_retention_policy_on_terminate &&
    is_remote == other.is_remote &&
    remote_region == other.remote_region
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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/oci/database/models/backup_destination_details.rb', line 281

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


261
262
263
 
# File 'lib/oci/database/models/backup_destination_details.rb', line 261

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



270
271
272
 
# File 'lib/oci/database/models/backup_destination_details.rb', line 270

def hash
  [type, id, vpc_user, vpc_password, is_zero_data_loss_enabled, internet_proxy, dbrs_policy_id, is_retention_lock_enabled, backup_retention_policy_on_terminate, is_remote, remote_region].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



314
315
316
317
318
319
320
321
322
323
 
# File 'lib/oci/database/models/backup_destination_details.rb', line 314

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



308
309
310
 
# File 'lib/oci/database/models/backup_destination_details.rb', line 308

def to_s
  to_hash.to_s
end