Class: OCI::Database::Models::CreateCrossRegionDisasterRecoveryDetails

Inherits:
CreateAutonomousDatabaseBase show all
Defined in:
lib/oci/database/models/create_cross_region_disaster_recovery_details.rb

Overview

The following are the details necessary to create a disaster recovery (DR) association for an existing Autonomous Database with a standby in a remote region. IMPORTANT For creating a standby databases in a cross-region DR association: - To create the standby database in a remote region, use the API endpoint in the region where the standby is located. For example, if the primary database is in the IAD region and the standby is in the PHX region, make the API call using the PHX endpoint (database.us-phoenix-1.oraclecloud.com). See API Endpoints for the list of Database Service API endpoints. - To create the request in the standby database, the sourceId value must be the OCID of the primary database. The following parameters are required for the cross-region standby database and must contain the same values as the source Autonomous Database: - remoteDisasterRecoveryType The following parameters are optional for the cross-region standby database. If included in the request, these parameters must contain the same values as the source Autonomous Database: - dbName - dbVersion - ecpuCount - dataStorageSizeInTB - customerContacts - scheduledOperations - isAutoScalingForStorageEnabled - definedTags - freeformTags - licenseModel - whitelistedIps - isMtlsConnectionRequired

Constant Summary

Constants inherited from CreateAutonomousDatabaseBase

OCI::Database::Models::CreateAutonomousDatabaseBase::AUTONOMOUS_MAINTENANCE_SCHEDULE_TYPE_ENUM, OCI::Database::Models::CreateAutonomousDatabaseBase::COMPUTE_MODEL_ENUM, OCI::Database::Models::CreateAutonomousDatabaseBase::DB_WORKLOAD_ENUM, OCI::Database::Models::CreateAutonomousDatabaseBase::LICENSE_MODEL_ENUM, OCI::Database::Models::CreateAutonomousDatabaseBase::SOURCE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateAutonomousDatabaseBase

#admin_password, #are_primary_whitelisted_ips_used, #autonomous_container_database_id, #autonomous_maintenance_schedule_type, #backup_retention_period_in_days, #character_set, #compartment_id, #compute_count, #compute_model, #cpu_core_count, #customer_contacts, #data_storage_size_in_gbs, #data_storage_size_in_tbs, #database_edition, #db_name, #db_tools_details, #db_version, #db_workload, #defined_tags, #display_name, #freeform_tags, #in_memory_percentage, #is_access_control_enabled, #is_auto_scaling_enabled, #is_auto_scaling_for_storage_enabled, #is_data_guard_enabled, #is_dedicated, #is_dev_tier, #is_free_tier, #is_local_data_guard_enabled, #is_mtls_connection_required, #is_preview_version_with_service_terms_accepted, #kms_key_id, #license_model, #ncharacter_set, #nsg_ids, #ocpu_count, #private_endpoint_ip, #private_endpoint_label, #resource_pool_leader_id, #resource_pool_summary, #scheduled_operations, #secret_id, #secret_version_number, #source, #standby_whitelisted_ips, #subnet_id, #vault_id, #whitelisted_ips

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateAutonomousDatabaseBase

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateCrossRegionDisasterRecoveryDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
# File 'lib/oci/database/models/create_cross_region_disaster_recovery_details.rb', line 224

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['source'] = 'CROSS_REGION_DISASTER_RECOVERY'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.source_id = attributes[:'sourceId'] if attributes[:'sourceId']

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

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

  self.remote_disaster_recovery_type = attributes[:'remoteDisasterRecoveryType'] if attributes[:'remoteDisasterRecoveryType']

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

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

  self.is_replicate_automatic_backups = attributes[:'isReplicateAutomaticBackups'] unless attributes[:'isReplicateAutomaticBackups'].nil?

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

  self.is_replicate_automatic_backups = attributes[:'is_replicate_automatic_backups'] unless attributes[:'is_replicate_automatic_backups'].nil?
end

Instance Attribute Details

#is_replicate_automatic_backupsBOOLEAN

If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database.

Returns:

  • (BOOLEAN)


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

def is_replicate_automatic_backups
  @is_replicate_automatic_backups
end

#remote_disaster_recovery_typeString

[Required] Indicates the cross-region disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.

Returns:

  • (String)


41
42
43
# File 'lib/oci/database/models/create_cross_region_disaster_recovery_details.rb', line 41

def remote_disaster_recovery_type
  @remote_disaster_recovery_type
end

#source_idString

[Required] The OCID of the source Autonomous Database that will be used to create a new peer database for the DR association.

Returns:

  • (String)


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

def source_id
  @source_id
end

Class Method Details

.attribute_mapObject

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'lib/oci/database/models/create_cross_region_disaster_recovery_details.rb', line 48

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'character_set': :'characterSet',
    'ncharacter_set': :'ncharacterSet',
    'db_name': :'dbName',
    'cpu_core_count': :'cpuCoreCount',
    'backup_retention_period_in_days': :'backupRetentionPeriodInDays',
    'compute_model': :'computeModel',
    'compute_count': :'computeCount',
    'ocpu_count': :'ocpuCount',
    'db_workload': :'dbWorkload',
    'data_storage_size_in_tbs': :'dataStorageSizeInTBs',
    'data_storage_size_in_gbs': :'dataStorageSizeInGBs',
    'is_free_tier': :'isFreeTier',
    'kms_key_id': :'kmsKeyId',
    'vault_id': :'vaultId',
    'admin_password': :'adminPassword',
    'display_name': :'displayName',
    'license_model': :'licenseModel',
    'is_preview_version_with_service_terms_accepted': :'isPreviewVersionWithServiceTermsAccepted',
    'is_auto_scaling_enabled': :'isAutoScalingEnabled',
    'is_dev_tier': :'isDevTier',
    'is_dedicated': :'isDedicated',
    'autonomous_container_database_id': :'autonomousContainerDatabaseId',
    'in_memory_percentage': :'inMemoryPercentage',
    'is_access_control_enabled': :'isAccessControlEnabled',
    'whitelisted_ips': :'whitelistedIps',
    'are_primary_whitelisted_ips_used': :'arePrimaryWhitelistedIpsUsed',
    'standby_whitelisted_ips': :'standbyWhitelistedIps',
    'is_data_guard_enabled': :'isDataGuardEnabled',
    'is_local_data_guard_enabled': :'isLocalDataGuardEnabled',
    'subnet_id': :'subnetId',
    'nsg_ids': :'nsgIds',
    'private_endpoint_label': :'privateEndpointLabel',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'private_endpoint_ip': :'privateEndpointIp',
    'db_version': :'dbVersion',
    'source': :'source',
    'customer_contacts': :'customerContacts',
    'is_mtls_connection_required': :'isMtlsConnectionRequired',
    'resource_pool_leader_id': :'resourcePoolLeaderId',
    'resource_pool_summary': :'resourcePoolSummary',
    'autonomous_maintenance_schedule_type': :'autonomousMaintenanceScheduleType',
    'scheduled_operations': :'scheduledOperations',
    'is_auto_scaling_for_storage_enabled': :'isAutoScalingForStorageEnabled',
    'database_edition': :'databaseEdition',
    'db_tools_details': :'dbToolsDetails',
    'secret_id': :'secretId',
    'secret_version_number': :'secretVersionNumber',
    'source_id': :'sourceId',
    'remote_disaster_recovery_type': :'remoteDisasterRecoveryType',
    'is_replicate_automatic_backups': :'isReplicateAutomaticBackups'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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
# File 'lib/oci/database/models/create_cross_region_disaster_recovery_details.rb', line 108

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'character_set': :'String',
    'ncharacter_set': :'String',
    'db_name': :'String',
    'cpu_core_count': :'Integer',
    'backup_retention_period_in_days': :'Integer',
    'compute_model': :'String',
    'compute_count': :'Float',
    'ocpu_count': :'Float',
    'db_workload': :'String',
    'data_storage_size_in_tbs': :'Integer',
    'data_storage_size_in_gbs': :'Integer',
    'is_free_tier': :'BOOLEAN',
    'kms_key_id': :'String',
    'vault_id': :'String',
    'admin_password': :'String',
    'display_name': :'String',
    'license_model': :'String',
    'is_preview_version_with_service_terms_accepted': :'BOOLEAN',
    'is_auto_scaling_enabled': :'BOOLEAN',
    'is_dev_tier': :'BOOLEAN',
    'is_dedicated': :'BOOLEAN',
    'autonomous_container_database_id': :'String',
    'in_memory_percentage': :'Integer',
    'is_access_control_enabled': :'BOOLEAN',
    'whitelisted_ips': :'Array<String>',
    'are_primary_whitelisted_ips_used': :'BOOLEAN',
    'standby_whitelisted_ips': :'Array<String>',
    'is_data_guard_enabled': :'BOOLEAN',
    'is_local_data_guard_enabled': :'BOOLEAN',
    'subnet_id': :'String',
    'nsg_ids': :'Array<String>',
    'private_endpoint_label': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'private_endpoint_ip': :'String',
    'db_version': :'String',
    'source': :'String',
    'customer_contacts': :'Array<OCI::Database::Models::CustomerContact>',
    'is_mtls_connection_required': :'BOOLEAN',
    'resource_pool_leader_id': :'String',
    'resource_pool_summary': :'OCI::Database::Models::ResourcePoolSummary',
    'autonomous_maintenance_schedule_type': :'String',
    'scheduled_operations': :'Array<OCI::Database::Models::ScheduledOperationDetails>',
    'is_auto_scaling_for_storage_enabled': :'BOOLEAN',
    'database_edition': :'String',
    'db_tools_details': :'Array<OCI::Database::Models::DatabaseTool>',
    'secret_id': :'String',
    'secret_version_number': :'Integer',
    'source_id': :'String',
    'remote_disaster_recovery_type': :'String',
    'is_replicate_automatic_backups': :'BOOLEAN'
    # 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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
# File 'lib/oci/database/models/create_cross_region_disaster_recovery_details.rb', line 260

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    character_set == other.character_set &&
    ncharacter_set == other.ncharacter_set &&
    db_name == other.db_name &&
    cpu_core_count == other.cpu_core_count &&
    backup_retention_period_in_days == other.backup_retention_period_in_days &&
    compute_model == other.compute_model &&
    compute_count == other.compute_count &&
    ocpu_count == other.ocpu_count &&
    db_workload == other.db_workload &&
    data_storage_size_in_tbs == other.data_storage_size_in_tbs &&
    data_storage_size_in_gbs == other.data_storage_size_in_gbs &&
    is_free_tier == other.is_free_tier &&
    kms_key_id == other.kms_key_id &&
    vault_id == other.vault_id &&
    admin_password == other.admin_password &&
    display_name == other.display_name &&
    license_model == other.license_model &&
    is_preview_version_with_service_terms_accepted == other.is_preview_version_with_service_terms_accepted &&
    is_auto_scaling_enabled == other.is_auto_scaling_enabled &&
    is_dev_tier == other.is_dev_tier &&
    is_dedicated == other.is_dedicated &&
    autonomous_container_database_id == other.autonomous_container_database_id &&
    in_memory_percentage == other.in_memory_percentage &&
    is_access_control_enabled == other.is_access_control_enabled &&
    whitelisted_ips == other.whitelisted_ips &&
    are_primary_whitelisted_ips_used == other.are_primary_whitelisted_ips_used &&
    standby_whitelisted_ips == other.standby_whitelisted_ips &&
    is_data_guard_enabled == other.is_data_guard_enabled &&
    is_local_data_guard_enabled == other.is_local_data_guard_enabled &&
    subnet_id == other.subnet_id &&
    nsg_ids == other.nsg_ids &&
    private_endpoint_label == other.private_endpoint_label &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    private_endpoint_ip == other.private_endpoint_ip &&
    db_version == other.db_version &&
    source == other.source &&
    customer_contacts == other.customer_contacts &&
    is_mtls_connection_required == other.is_mtls_connection_required &&
    resource_pool_leader_id == other.resource_pool_leader_id &&
    resource_pool_summary == other.resource_pool_summary &&
    autonomous_maintenance_schedule_type == other.autonomous_maintenance_schedule_type &&
    scheduled_operations == other.scheduled_operations &&
    is_auto_scaling_for_storage_enabled == other.is_auto_scaling_for_storage_enabled &&
    database_edition == other.database_edition &&
    db_tools_details == other.db_tools_details &&
    secret_id == other.secret_id &&
    secret_version_number == other.secret_version_number &&
    source_id == other.source_id &&
    remote_disaster_recovery_type == other.remote_disaster_recovery_type &&
    is_replicate_automatic_backups == other.is_replicate_automatic_backups
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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
# File 'lib/oci/database/models/create_cross_region_disaster_recovery_details.rb', line 341

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


321
322
323
# File 'lib/oci/database/models/create_cross_region_disaster_recovery_details.rb', line 321

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



330
331
332
# File 'lib/oci/database/models/create_cross_region_disaster_recovery_details.rb', line 330

def hash
  [compartment_id, character_set, ncharacter_set, db_name, cpu_core_count, backup_retention_period_in_days, compute_model, compute_count, ocpu_count, db_workload, data_storage_size_in_tbs, data_storage_size_in_gbs, is_free_tier, kms_key_id, vault_id, admin_password, display_name, license_model, is_preview_version_with_service_terms_accepted, is_auto_scaling_enabled, is_dev_tier, is_dedicated, autonomous_container_database_id, in_memory_percentage, is_access_control_enabled, whitelisted_ips, are_primary_whitelisted_ips_used, standby_whitelisted_ips, is_data_guard_enabled, is_local_data_guard_enabled, subnet_id, nsg_ids, private_endpoint_label, freeform_tags, defined_tags, private_endpoint_ip, db_version, source, customer_contacts, is_mtls_connection_required, resource_pool_leader_id, resource_pool_summary, autonomous_maintenance_schedule_type, scheduled_operations, is_auto_scaling_for_storage_enabled, database_edition, db_tools_details, secret_id, secret_version_number, source_id, remote_disaster_recovery_type, is_replicate_automatic_backups].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



374
375
376
377
378
379
380
381
382
383
# File 'lib/oci/database/models/create_cross_region_disaster_recovery_details.rb', line 374

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



368
369
370
# File 'lib/oci/database/models/create_cross_region_disaster_recovery_details.rb', line 368

def to_s
  to_hash.to_s
end