Class: OCI::Database::Models::CreateRefreshableAutonomousDatabaseCloneDetails

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

Overview

Details to create an Oracle Autonomous Database refreshable clone.

Constant Summary collapse

REFRESHABLE_MODE_ENUM = 
[
  REFRESHABLE_MODE_AUTOMATIC = 'AUTOMATIC'.freeze,
  REFRESHABLE_MODE_MANUAL = 'MANUAL'.freeze
].freeze
OPEN_MODE_ENUM = 
[
  OPEN_MODE_READ_ONLY = 'READ_ONLY'.freeze,
  OPEN_MODE_READ_WRITE = 'READ_WRITE'.freeze
].freeze

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, #byol_compute_count_limit, #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, #encryption_key, #freeform_tags, #in_memory_percentage, #is_access_control_enabled, #is_auto_scaling_enabled, #is_auto_scaling_for_storage_enabled, #is_backup_retention_locked, #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, #security_attributes, #source, #standby_whitelisted_ips, #subnet_id, #subscription_id, #vault_id, #whitelisted_ips

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateAutonomousDatabaseBase

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateRefreshableAutonomousDatabaseCloneDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



251
252
253
254
255
256
257
258
259
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
 
# File 'lib/oci/database/models/create_refreshable_autonomous_database_clone_details.rb', line 251

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

  attributes['source'] = 'CLONE_TO_REFRESHABLE'

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

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

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

  self.auto_refresh_frequency_in_seconds = attributes[:'autoRefreshFrequencyInSeconds'] if attributes[:'autoRefreshFrequencyInSeconds']

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

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

  self.auto_refresh_point_lag_in_seconds = attributes[:'autoRefreshPointLagInSeconds'] if attributes[:'autoRefreshPointLagInSeconds']

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

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

  self.time_of_auto_refresh_start = attributes[:'timeOfAutoRefreshStart'] if attributes[:'timeOfAutoRefreshStart']

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

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

  self.open_mode = attributes[:'openMode'] if attributes[:'openMode']

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

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

Instance Attribute Details

#auto_refresh_frequency_in_seconds ⇒ Integer

The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the timeOfAutoRefreshStart parameter.

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/oci/database/models/create_refreshable_autonomous_database_clone_details.rb', line 33

def auto_refresh_frequency_in_seconds
  @auto_refresh_frequency_in_seconds
end

#auto_refresh_point_lag_in_seconds ⇒ Integer

The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens.

Returns:

  • (Integer) 


37
38
39
 
# File 'lib/oci/database/models/create_refreshable_autonomous_database_clone_details.rb', line 37

def auto_refresh_point_lag_in_seconds
  @auto_refresh_point_lag_in_seconds
end

#open_mode ⇒ String

Indicates the Autonomous Database mode. The database can be opened in READ_ONLY or READ_WRITE mode.

This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Returns:

  • (String) 


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

def open_mode
  @open_mode
end

#refreshable_mode ⇒ String

The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/database/models/create_refreshable_autonomous_database_clone_details.rb', line 29

def refreshable_mode
  @refreshable_mode
end

#source_id ⇒ String

[Required] The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.

Returns:

  • (String) 


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

def source_id
  @source_id
end

#time_of_auto_refresh_start ⇒ DateTime

The the date and time that auto-refreshing will begin for an Autonomous Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the autoRefreshFrequencyInSeconds parameter.

Returns:

  • (DateTime) 


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

def time_of_auto_refresh_start
  @time_of_auto_refresh_start
end

Class Method Details

.attribute_map ⇒ Object

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



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
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/database/models/create_refreshable_autonomous_database_clone_details.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'subscription_id': :'subscriptionId',
    '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',
    'encryption_key': :'encryptionKey',
    'admin_password': :'adminPassword',
    'display_name': :'displayName',
    'license_model': :'licenseModel',
    'byol_compute_count_limit': :'byolComputeCountLimit',
    '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',
    'security_attributes': :'securityAttributes',
    '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',
    'is_backup_retention_locked': :'isBackupRetentionLocked',
    'secret_id': :'secretId',
    'secret_version_number': :'secretVersionNumber',
    'source_id': :'sourceId',
    'refreshable_mode': :'refreshableMode',
    'auto_refresh_frequency_in_seconds': :'autoRefreshFrequencyInSeconds',
    'auto_refresh_point_lag_in_seconds': :'autoRefreshPointLagInSeconds',
    'time_of_auto_refresh_start': :'timeOfAutoRefreshStart',
    'open_mode': :'openMode'
    # 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
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/database/models/create_refreshable_autonomous_database_clone_details.rb', line 119

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'subscription_id': :'String',
    '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',
    'encryption_key': :'OCI::Database::Models::AutonomousDatabaseEncryptionKeyDetails',
    'admin_password': :'String',
    'display_name': :'String',
    'license_model': :'String',
    'byol_compute_count_limit': :'Float',
    '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>>',
    'security_attributes': :'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>',
    'is_backup_retention_locked': :'BOOLEAN',
    'secret_id': :'String',
    'secret_version_number': :'Integer',
    'source_id': :'String',
    'refreshable_mode': :'String',
    'auto_refresh_frequency_in_seconds': :'Integer',
    'auto_refresh_point_lag_in_seconds': :'Integer',
    'time_of_auto_refresh_start': :'DateTime',
    'open_mode': :'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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/oci/database/models/create_refreshable_autonomous_database_clone_details.rb', line 321

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

  self.class == other.class &&
    subscription_id == other.subscription_id &&
    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 &&
    encryption_key == other.encryption_key &&
    admin_password == other.admin_password &&
    display_name == other.display_name &&
    license_model == other.license_model &&
    byol_compute_count_limit == other.byol_compute_count_limit &&
    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 &&
    security_attributes == other.security_attributes &&
    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 &&
    is_backup_retention_locked == other.is_backup_retention_locked &&
    secret_id == other.secret_id &&
    secret_version_number == other.secret_version_number &&
    source_id == other.source_id &&
    refreshable_mode == other.refreshable_mode &&
    auto_refresh_frequency_in_seconds == other.auto_refresh_frequency_in_seconds &&
    auto_refresh_point_lag_in_seconds == other.auto_refresh_point_lag_in_seconds &&
    time_of_auto_refresh_start == other.time_of_auto_refresh_start &&
    open_mode == other.open_mode
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



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/oci/database/models/create_refreshable_autonomous_database_clone_details.rb', line 410

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


390
391
392
 
# File 'lib/oci/database/models/create_refreshable_autonomous_database_clone_details.rb', line 390

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



399
400
401
 
# File 'lib/oci/database/models/create_refreshable_autonomous_database_clone_details.rb', line 399

def hash
  [subscription_id, 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, encryption_key, admin_password, display_name, license_model, byol_compute_count_limit, 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, security_attributes, 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, is_backup_retention_locked, secret_id, secret_version_number, source_id, refreshable_mode, auto_refresh_frequency_in_seconds, auto_refresh_point_lag_in_seconds, time_of_auto_refresh_start, open_mode].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



443
444
445
446
447
448
449
450
451
452
 
# File 'lib/oci/database/models/create_refreshable_autonomous_database_clone_details.rb', line 443

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



437
438
439
 
# File 'lib/oci/database/models/create_refreshable_autonomous_database_clone_details.rb', line 437

def to_s
  to_hash.to_s
end