Class: OCI::Database::Models::CreateDatabaseForStandbyDbSystemDetails

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

Overview

Details for creating a database for a standby db system with dataguard.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

PROTECTION_MODE_ENUM = 
[
  PROTECTION_MODE_MAXIMUM_AVAILABILITY = 'MAXIMUM_AVAILABILITY'.freeze,
  PROTECTION_MODE_MAXIMUM_PERFORMANCE = 'MAXIMUM_PERFORMANCE'.freeze,
  PROTECTION_MODE_MAXIMUM_PROTECTION = 'MAXIMUM_PROTECTION'.freeze
].freeze
TRANSPORT_TYPE_ENUM = 
[
  TRANSPORT_TYPE_SYNC = 'SYNC'.freeze,
  TRANSPORT_TYPE_ASYNC = 'ASYNC'.freeze,
  TRANSPORT_TYPE_FASTSYNC = 'FASTSYNC'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDatabaseForStandbyDbSystemDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 158

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

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

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

  self.tde_wallet_password = attributes[:'tdeWalletPassword'] if attributes[:'tdeWalletPassword']

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

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

  self.database_software_image_id = attributes[:'databaseSoftwareImageId'] if attributes[:'databaseSoftwareImageId']

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

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

  self.is_active_data_guard_enabled = attributes[:'isActiveDataGuardEnabled'] unless attributes[:'isActiveDataGuardEnabled'].nil?

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

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

  self.db_domain = attributes[:'dbDomain'] if attributes[:'dbDomain']

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

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

  self.sid_prefix = attributes[:'sidPrefix'] if attributes[:'sidPrefix']

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

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

  self.db_unique_name = attributes[:'dbUniqueName'] if attributes[:'dbUniqueName']

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

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

  self.protection_mode = attributes[:'protectionMode'] if attributes[:'protectionMode']

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

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

  self.source_encryption_key_location_details = attributes[:'sourceEncryptionKeyLocationDetails'] if attributes[:'sourceEncryptionKeyLocationDetails']

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

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

  self.transport_type = attributes[:'transportType'] if attributes[:'transportType']

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

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

  self.db_backup_config = attributes[:'dbBackupConfig'] if attributes[:'dbBackupConfig']

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

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

  self.database_freeform_tags = attributes[:'databaseFreeformTags'] if attributes[:'databaseFreeformTags']

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

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

  self.database_defined_tags = attributes[:'databaseDefinedTags'] if attributes[:'databaseDefinedTags']

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

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

Instance Attribute Details

#admin_password ⇒ String

[Required] For SYS, SYSTEM, and PDB Admin, enter the same password as the primary admin password.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 28

def admin_password
  @admin_password
end

#database_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.

Returns:

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


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

def database_defined_tags
  @database_defined_tags
end

#database_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.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


89
90
91
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 89

def database_freeform_tags
  @database_freeform_tags
end

#database_software_image_id ⇒ String

The database software image OCID

Returns:

  • (String) 


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

def database_software_image_id
  @database_software_image_id
end

#db_backup_config ⇒ OCI::Database::Models::DbBackupConfig

Returns:



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

def db_backup_config
  @db_backup_config
end

#db_domain ⇒ String

The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.

Returns:

  • (String) 


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

def db_domain
  @db_domain
end

#db_unique_name ⇒ String

The DB_UNIQUE_NAME of the Oracle Database.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 53

def db_unique_name
  @db_unique_name
end

#is_active_data_guard_enabled ⇒ BOOLEAN

True if active Data Guard is enabled.

Returns:

  • (BOOLEAN) 


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

def is_active_data_guard_enabled
  @is_active_data_guard_enabled
end

#protection_mode ⇒ String

[Required] The protection mode of this Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 60

def protection_mode
  @protection_mode
end

#sid_prefix ⇒ String

Specifies a prefix for the Oracle SID of the database to be created.

Returns:

  • (String) 


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

def sid_prefix
  @sid_prefix
end

#source_encryption_key_location_details ⇒ OCI::Database::Models::EncryptionKeyLocationDetails

Returns:



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

def source_encryption_key_location_details
  @source_encryption_key_location_details
end

#tde_wallet_password ⇒ String

For TDE Wallet, enter the same password as the primary wallet password.

Returns:

  • (String) 


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

def tde_wallet_password
  @tde_wallet_password
end

#transport_type ⇒ String

[Required] The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC

  • MAXIMUM_PERFORMANCE - ASYNC

  • MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 78

def transport_type
  @transport_type
end

Class Method Details

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 98

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'admin_password': :'adminPassword',
    'tde_wallet_password': :'tdeWalletPassword',
    'database_software_image_id': :'databaseSoftwareImageId',
    'is_active_data_guard_enabled': :'isActiveDataGuardEnabled',
    'db_domain': :'dbDomain',
    'sid_prefix': :'sidPrefix',
    'db_unique_name': :'dbUniqueName',
    'protection_mode': :'protectionMode',
    'source_encryption_key_location_details': :'sourceEncryptionKeyLocationDetails',
    'transport_type': :'transportType',
    'db_backup_config': :'dbBackupConfig',
    'database_freeform_tags': :'databaseFreeformTags',
    'database_defined_tags': :'databaseDefinedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 119

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'admin_password': :'String',
    'tde_wallet_password': :'String',
    'database_software_image_id': :'String',
    'is_active_data_guard_enabled': :'BOOLEAN',
    'db_domain': :'String',
    'sid_prefix': :'String',
    'db_unique_name': :'String',
    'protection_mode': :'String',
    'source_encryption_key_location_details': :'OCI::Database::Models::EncryptionKeyLocationDetails',
    'transport_type': :'String',
    'db_backup_config': :'OCI::Database::Models::DbBackupConfig',
    'database_freeform_tags': :'Hash<String, String>',
    'database_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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 266

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

  self.class == other.class &&
    admin_password == other.admin_password &&
    tde_wallet_password == other.tde_wallet_password &&
    database_software_image_id == other.database_software_image_id &&
    is_active_data_guard_enabled == other.is_active_data_guard_enabled &&
    db_domain == other.db_domain &&
    sid_prefix == other.sid_prefix &&
    db_unique_name == other.db_unique_name &&
    protection_mode == other.protection_mode &&
    source_encryption_key_location_details == other.source_encryption_key_location_details &&
    transport_type == other.transport_type &&
    db_backup_config == other.db_backup_config &&
    database_freeform_tags == other.database_freeform_tags &&
    database_defined_tags == other.database_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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 308

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


288
289
290
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 288

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



297
298
299
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 297

def hash
  [admin_password, tde_wallet_password, database_software_image_id, is_active_data_guard_enabled, db_domain, sid_prefix, db_unique_name, protection_mode, source_encryption_key_location_details, transport_type, db_backup_config, database_freeform_tags, database_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



341
342
343
344
345
346
347
348
349
350
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 341

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



335
336
337
 
# File 'lib/oci/database/models/create_database_for_standby_db_system_details.rb', line 335

def to_s
  to_hash.to_s
end