Class: OCI::DistributedDatabase::Models::DistributedDbBackupConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/distributed_database/models/distributed_db_backup_config.rb

Overview

Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

AUTO_BACKUP_WINDOW_ENUM = 
[
  AUTO_BACKUP_WINDOW_SLOT_ONE = 'SLOT_ONE'.freeze,
  AUTO_BACKUP_WINDOW_SLOT_TWO = 'SLOT_TWO'.freeze,
  AUTO_BACKUP_WINDOW_SLOT_THREE = 'SLOT_THREE'.freeze,
  AUTO_BACKUP_WINDOW_SLOT_FOUR = 'SLOT_FOUR'.freeze,
  AUTO_BACKUP_WINDOW_SLOT_FIVE = 'SLOT_FIVE'.freeze,
  AUTO_BACKUP_WINDOW_SLOT_SIX = 'SLOT_SIX'.freeze,
  AUTO_BACKUP_WINDOW_SLOT_SEVEN = 'SLOT_SEVEN'.freeze,
  AUTO_BACKUP_WINDOW_SLOT_EIGHT = 'SLOT_EIGHT'.freeze,
  AUTO_BACKUP_WINDOW_SLOT_NINE = 'SLOT_NINE'.freeze,
  AUTO_BACKUP_WINDOW_SLOT_TEN = 'SLOT_TEN'.freeze,
  AUTO_BACKUP_WINDOW_SLOT_ELEVEN = 'SLOT_ELEVEN'.freeze,
  AUTO_BACKUP_WINDOW_SLOT_TWELVE = 'SLOT_TWELVE'.freeze,
  AUTO_BACKUP_WINDOW_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AUTO_FULL_BACKUP_WINDOW_ENUM = 
[
  AUTO_FULL_BACKUP_WINDOW_SLOT_ONE = 'SLOT_ONE'.freeze,
  AUTO_FULL_BACKUP_WINDOW_SLOT_TWO = 'SLOT_TWO'.freeze,
  AUTO_FULL_BACKUP_WINDOW_SLOT_THREE = 'SLOT_THREE'.freeze,
  AUTO_FULL_BACKUP_WINDOW_SLOT_FOUR = 'SLOT_FOUR'.freeze,
  AUTO_FULL_BACKUP_WINDOW_SLOT_FIVE = 'SLOT_FIVE'.freeze,
  AUTO_FULL_BACKUP_WINDOW_SLOT_SIX = 'SLOT_SIX'.freeze,
  AUTO_FULL_BACKUP_WINDOW_SLOT_SEVEN = 'SLOT_SEVEN'.freeze,
  AUTO_FULL_BACKUP_WINDOW_SLOT_EIGHT = 'SLOT_EIGHT'.freeze,
  AUTO_FULL_BACKUP_WINDOW_SLOT_NINE = 'SLOT_NINE'.freeze,
  AUTO_FULL_BACKUP_WINDOW_SLOT_TEN = 'SLOT_TEN'.freeze,
  AUTO_FULL_BACKUP_WINDOW_SLOT_ELEVEN = 'SLOT_ELEVEN'.freeze,
  AUTO_FULL_BACKUP_WINDOW_SLOT_TWELVE = 'SLOT_TWELVE'.freeze,
  AUTO_FULL_BACKUP_WINDOW_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AUTO_FULL_BACKUP_DAY_ENUM = 
[
  AUTO_FULL_BACKUP_DAY_SUNDAY = 'SUNDAY'.freeze,
  AUTO_FULL_BACKUP_DAY_MONDAY = 'MONDAY'.freeze,
  AUTO_FULL_BACKUP_DAY_TUESDAY = 'TUESDAY'.freeze,
  AUTO_FULL_BACKUP_DAY_WEDNESDAY = 'WEDNESDAY'.freeze,
  AUTO_FULL_BACKUP_DAY_THURSDAY = 'THURSDAY'.freeze,
  AUTO_FULL_BACKUP_DAY_FRIDAY = 'FRIDAY'.freeze,
  AUTO_FULL_BACKUP_DAY_SATURDAY = 'SATURDAY'.freeze,
  AUTO_FULL_BACKUP_DAY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
BACKUP_DELETION_POLICY_ENUM = 
[
  BACKUP_DELETION_POLICY_DELETE_IMMEDIATELY = 'DELETE_IMMEDIATELY'.freeze,
  BACKUP_DELETION_POLICY_DELETE_AFTER_RETENTION_PERIOD = 'DELETE_AFTER_RETENTION_PERIOD'.freeze,
  BACKUP_DELETION_POLICY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DistributedDbBackupConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 168

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.is_auto_backup_enabled = attributes[:'isAutoBackupEnabled'] unless attributes[:'isAutoBackupEnabled'].nil?

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

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

  self.recovery_window_in_days = attributes[:'recoveryWindowInDays'] if attributes[:'recoveryWindowInDays']

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

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

  self.auto_backup_window = attributes[:'autoBackupWindow'] if attributes[:'autoBackupWindow']

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

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

  self.auto_full_backup_window = attributes[:'autoFullBackupWindow'] if attributes[:'autoFullBackupWindow']

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

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

  self.auto_full_backup_day = attributes[:'autoFullBackupDay'] if attributes[:'autoFullBackupDay']
  self.auto_full_backup_day = "SUNDAY" if auto_full_backup_day.nil? && !attributes.key?(:'autoFullBackupDay') # rubocop:disable Style/StringLiterals

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

  self.auto_full_backup_day = attributes[:'auto_full_backup_day'] if attributes[:'auto_full_backup_day']
  self.auto_full_backup_day = "SUNDAY" if auto_full_backup_day.nil? && !attributes.key?(:'autoFullBackupDay') && !attributes.key?(:'auto_full_backup_day') # rubocop:disable Style/StringLiterals

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

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

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

  self.is_remote_backup_enabled = attributes[:'isRemoteBackupEnabled'] unless attributes[:'isRemoteBackupEnabled'].nil?

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

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

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

  self.backup_destination_details = attributes[:'backupDestinationDetails'] if attributes[:'backupDestinationDetails']

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

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

  self.backup_deletion_policy = attributes[:'backupDeletionPolicy'] if attributes[:'backupDeletionPolicy']

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

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

Instance Attribute Details

#auto_backup_window ⇒ String

Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 78

def auto_backup_window
  @auto_backup_window
end

#auto_full_backup_day ⇒ String

Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 88

def auto_full_backup_day
  @auto_full_backup_day
end

#auto_full_backup_window ⇒ String

Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 84

def auto_full_backup_window
  @auto_full_backup_window
end

#backup_deletion_policy ⇒ String

This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently… - RETAIN will keep the backups as per the policy defined for database backups.

Returns:

  • (String) 


114
115
116
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 114

def backup_deletion_policy
  @backup_deletion_policy
end

#backup_destination_details ⇒ Array<OCI::DistributedDatabase::Models::DistributedDbBackupDestination>

Backup destination details.

Returns:



110
111
112
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 110

def backup_destination_details
  @backup_destination_details
end

#can_run_immediate_full_backup ⇒ BOOLEAN

If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

Returns:

  • (BOOLEAN) 


92
93
94
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 92

def can_run_immediate_full_backup
  @can_run_immediate_full_backup
end

#is_auto_backup_enabled ⇒ BOOLEAN

If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

Returns:

  • (BOOLEAN) 


65
66
67
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 65

def is_auto_backup_enabled
  @is_auto_backup_enabled
end

#is_remote_backup_enabled ⇒ BOOLEAN

If set to true, configures automatic incremental backups in the local region (the region of the DB system) and the remote region with a default frequency of 1 hour. If you previously used RMAN or dbcli to configure backups, using the Console or the API for manged backups creates a new backup configuration for your database. The new configuration replaces the configuration created with RMAN or dbcli. This means that you can no longer rely on your previously configured unmanaged backups to work.

Returns:

  • (BOOLEAN) 


99
100
101
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 99

def is_remote_backup_enabled
  @is_remote_backup_enabled
end

#recovery_window_in_days ⇒ Integer

Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

Returns:

  • (Integer) 


72
73
74
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 72

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


106
107
108
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 106

def remote_region
  @remote_region
end

Class Method Details

.attribute_map ⇒ Object

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 117

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_auto_backup_enabled': :'isAutoBackupEnabled',
    'recovery_window_in_days': :'recoveryWindowInDays',
    'auto_backup_window': :'autoBackupWindow',
    'auto_full_backup_window': :'autoFullBackupWindow',
    'auto_full_backup_day': :'autoFullBackupDay',
    'can_run_immediate_full_backup': :'canRunImmediateFullBackup',
    'is_remote_backup_enabled': :'isRemoteBackupEnabled',
    'remote_region': :'remoteRegion',
    'backup_destination_details': :'backupDestinationDetails',
    'backup_deletion_policy': :'backupDeletionPolicy'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 135

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_auto_backup_enabled': :'BOOLEAN',
    'recovery_window_in_days': :'Integer',
    'auto_backup_window': :'String',
    'auto_full_backup_window': :'String',
    'auto_full_backup_day': :'String',
    'can_run_immediate_full_backup': :'BOOLEAN',
    'is_remote_backup_enabled': :'BOOLEAN',
    'remote_region': :'String',
    'backup_destination_details': :'Array<OCI::DistributedDatabase::Models::DistributedDbBackupDestination>',
    'backup_deletion_policy': :'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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 298

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

  self.class == other.class &&
    is_auto_backup_enabled == other.is_auto_backup_enabled &&
    recovery_window_in_days == other.recovery_window_in_days &&
    auto_backup_window == other.auto_backup_window &&
    auto_full_backup_window == other.auto_full_backup_window &&
    auto_full_backup_day == other.auto_full_backup_day &&
    can_run_immediate_full_backup == other.can_run_immediate_full_backup &&
    is_remote_backup_enabled == other.is_remote_backup_enabled &&
    remote_region == other.remote_region &&
    backup_destination_details == other.backup_destination_details &&
    backup_deletion_policy == other.backup_deletion_policy
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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 337

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


317
318
319
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 317

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



326
327
328
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 326

def hash
  [is_auto_backup_enabled, recovery_window_in_days, auto_backup_window, auto_full_backup_window, auto_full_backup_day, can_run_immediate_full_backup, is_remote_backup_enabled, remote_region, backup_destination_details, backup_deletion_policy].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



370
371
372
373
374
375
376
377
378
379
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 370

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



364
365
366
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_config.rb', line 364

def to_s
  to_hash.to_s
end