Class: OCI::Database::Models::CreateStandbyDetails

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

Overview

Standby Creation Details.

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 = {}) ⇒ CreateStandbyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
222
223
224
225
226
227
228
229
 
# File 'lib/oci/database/models/create_standby_details.rb', line 152

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

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

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

  self.database_admin_password = attributes[:'databaseAdminPassword'] if attributes[:'databaseAdminPassword']

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

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

  self.source_tde_wallet_password = attributes[:'sourceTdeWalletPassword'] if attributes[:'sourceTdeWalletPassword']

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

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

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

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

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

#database_admin_password ⇒ String

[Required] The administrator password of the primary database in this Data Guard association.

The password MUST be the same as the primary admin password.

Returns:

  • (String) 


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

def database_admin_password
  @database_admin_password
end

#db_unique_name ⇒ String

Specifies the DB_UNIQUE_NAME of the peer database to be created.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database/models/create_standby_details.rb', line 48

def db_unique_name
  @db_unique_name
end

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


92
93
94
 
# File 'lib/oci/database/models/create_standby_details.rb', line 92

def defined_tags
  @defined_tags
end

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


86
87
88
 
# File 'lib/oci/database/models/create_standby_details.rb', line 86

def freeform_tags
  @freeform_tags
end

#is_active_data_guard_enabled ⇒ BOOLEAN

True if active Data Guard is enabled.

Returns:

  • (BOOLEAN) 


43
44
45
 
# File 'lib/oci/database/models/create_standby_details.rb', line 43

def is_active_data_guard_enabled
  @is_active_data_guard_enabled
end

#protection_mode ⇒ String

[Required] The protection mode of this Data Guard. 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_standby_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) 


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

def sid_prefix
  @sid_prefix
end

#source_database_id ⇒ String

[Required] The OCID of the source database.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/database/models/create_standby_details.rb', line 25

def source_database_id
  @source_database_id
end

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

Returns:



39
40
41
 
# File 'lib/oci/database/models/create_standby_details.rb', line 39

def source_encryption_key_location_details
  @source_encryption_key_location_details
end

#source_tde_wallet_password ⇒ String

[Required] The TDE wallet password of the source database specified by 'sourceDatabaseId'.

Returns:

  • (String) 


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

def source_tde_wallet_password
  @source_tde_wallet_password
end

#storage_size_details ⇒ OCI::Database::Models::DatabaseStorageSizeDetails

Returns:



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

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


75
76
77
 
# File 'lib/oci/database/models/create_standby_details.rb', line 75

def transport_type
  @transport_type
end

Class Method Details

.attribute_map ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/database/models/create_standby_details.rb', line 95

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'source_database_id': :'sourceDatabaseId',
    'database_admin_password': :'databaseAdminPassword',
    'source_tde_wallet_password': :'sourceTdeWalletPassword',
    'source_encryption_key_location_details': :'sourceEncryptionKeyLocationDetails',
    'is_active_data_guard_enabled': :'isActiveDataGuardEnabled',
    'db_unique_name': :'dbUniqueName',
    'sid_prefix': :'sidPrefix',
    'protection_mode': :'protectionMode',
    'transport_type': :'transportType',
    'storage_size_details': :'storageSizeDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'source_database_id': :'String',
    'database_admin_password': :'String',
    'source_tde_wallet_password': :'String',
    'source_encryption_key_location_details': :'OCI::Database::Models::EncryptionKeyLocationDetails',
    'is_active_data_guard_enabled': :'BOOLEAN',
    'db_unique_name': :'String',
    'sid_prefix': :'String',
    'protection_mode': :'String',
    'transport_type': :'String',
    'storage_size_details': :'OCI::Database::Models::DatabaseStorageSizeDetails',
    '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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/database/models/create_standby_details.rb', line 254

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

  self.class == other.class &&
    source_database_id == other.source_database_id &&
    database_admin_password == other.database_admin_password &&
    source_tde_wallet_password == other.source_tde_wallet_password &&
    source_encryption_key_location_details == other.source_encryption_key_location_details &&
    is_active_data_guard_enabled == other.is_active_data_guard_enabled &&
    db_unique_name == other.db_unique_name &&
    sid_prefix == other.sid_prefix &&
    protection_mode == other.protection_mode &&
    transport_type == other.transport_type &&
    storage_size_details == other.storage_size_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



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

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


275
276
277
 
# File 'lib/oci/database/models/create_standby_details.rb', line 275

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



284
285
286
 
# File 'lib/oci/database/models/create_standby_details.rb', line 284

def hash
  [source_database_id, database_admin_password, source_tde_wallet_password, source_encryption_key_location_details, is_active_data_guard_enabled, db_unique_name, sid_prefix, protection_mode, transport_type, storage_size_details, freeform_tags, 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



328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/database/models/create_standby_details.rb', line 328

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



322
323
324
 
# File 'lib/oci/database/models/create_standby_details.rb', line 322

def to_s
  to_hash.to_s
end