Class: OCI::Database::Models::DbBackupConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DbBackupConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/database/models/db_backup_config.rb', line 85

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

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

  self.auto_backup_enabled = attributes[:'auto_backup_enabled'] unless attributes[:'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.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']
end

Instance Attribute Details

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


31
32
33
 
# File 'lib/oci/database/models/db_backup_config.rb', line 31

def auto_backup_enabled
  @auto_backup_enabled
end

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


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

def auto_backup_window
  @auto_backup_window
end

#backup_destination_details ⇒ Array<OCI::Database::Models::BackupDestinationDetails>

Backup destination details.

Returns:



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

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


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

def recovery_window_in_days
  @recovery_window_in_days
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/database/models/db_backup_config.rb', line 52

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'auto_backup_enabled': :'autoBackupEnabled',
    'recovery_window_in_days': :'recoveryWindowInDays',
    'auto_backup_window': :'autoBackupWindow',
    'backup_destination_details': :'backupDestinationDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/database/models/db_backup_config.rb', line 64

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'auto_backup_enabled': :'BOOLEAN',
    'recovery_window_in_days': :'Integer',
    'auto_backup_window': :'String',
    'backup_destination_details': :'Array<OCI::Database::Models::BackupDestinationDetails>'
    # 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



136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/database/models/db_backup_config.rb', line 136

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

  self.class == other.class &&
    auto_backup_enabled == other.auto_backup_enabled &&
    recovery_window_in_days == other.recovery_window_in_days &&
    auto_backup_window == other.auto_backup_window &&
    backup_destination_details == other.backup_destination_details
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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/database/models/db_backup_config.rb', line 169

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


149
150
151
 
# File 'lib/oci/database/models/db_backup_config.rb', line 149

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



158
159
160
 
# File 'lib/oci/database/models/db_backup_config.rb', line 158

def hash
  [auto_backup_enabled, recovery_window_in_days, auto_backup_window, backup_destination_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/database/models/db_backup_config.rb', line 202

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



196
197
198
 
# File 'lib/oci/database/models/db_backup_config.rb', line 196

def to_s
  to_hash.to_s
end