Class: OCI::Database::Models::AutonomousDatabaseDataguardAssociation

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

Overview

The properties that define dataguard association between two different Autonomous Databases. Note that Autonomous Databases inherit DataGuard association from parent Autonomous Container Database. No actions can be taken on AutonomousDatabaseDataguardAssociation, usage is strictly informational.

Constant Summary collapse

ROLE_ENUM = 
[
  ROLE_PRIMARY = 'PRIMARY'.freeze,
  ROLE_STANDBY = 'STANDBY'.freeze,
  ROLE_DISABLED_STANDBY = 'DISABLED_STANDBY'.freeze,
  ROLE_BACKUP_COPY = 'BACKUP_COPY'.freeze,
  ROLE_SNAPSHOT_STANDBY = 'SNAPSHOT_STANDBY'.freeze,
  ROLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_ROLE_CHANGE_IN_PROGRESS = 'ROLE_CHANGE_IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNAVAILABLE = 'UNAVAILABLE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PEER_ROLE_ENUM = 
[
  PEER_ROLE_PRIMARY = 'PRIMARY'.freeze,
  PEER_ROLE_STANDBY = 'STANDBY'.freeze,
  PEER_ROLE_DISABLED_STANDBY = 'DISABLED_STANDBY'.freeze,
  PEER_ROLE_BACKUP_COPY = 'BACKUP_COPY'.freeze,
  PEER_ROLE_SNAPSHOT_STANDBY = 'SNAPSHOT_STANDBY'.freeze,
  PEER_ROLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PEER_AUTONOMOUS_DATABASE_LIFE_CYCLE_STATE_ENUM = 
[
  PEER_AUTONOMOUS_DATABASE_LIFE_CYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  PEER_AUTONOMOUS_DATABASE_LIFE_CYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  PEER_AUTONOMOUS_DATABASE_LIFE_CYCLE_STATE_ROLE_CHANGE_IN_PROGRESS = 'ROLE_CHANGE_IN_PROGRESS'.freeze,
  PEER_AUTONOMOUS_DATABASE_LIFE_CYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  PEER_AUTONOMOUS_DATABASE_LIFE_CYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  PEER_AUTONOMOUS_DATABASE_LIFE_CYCLE_STATE_FAILED = 'FAILED'.freeze,
  PEER_AUTONOMOUS_DATABASE_LIFE_CYCLE_STATE_UNAVAILABLE = 'UNAVAILABLE'.freeze,
  PEER_AUTONOMOUS_DATABASE_LIFE_CYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  PEER_AUTONOMOUS_DATABASE_LIFE_CYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PROTECTION_MODE_ENUM = 
[
  PROTECTION_MODE_MAXIMUM_AVAILABILITY = 'MAXIMUM_AVAILABILITY'.freeze,
  PROTECTION_MODE_MAXIMUM_PERFORMANCE = 'MAXIMUM_PERFORMANCE'.freeze,
  PROTECTION_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AutonomousDatabaseDataguardAssociation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
242
243
244
245
246
247
248
249
250
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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 217

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

  self.autonomous_database_id = attributes[:'autonomousDatabaseId'] if attributes[:'autonomousDatabaseId']

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.peer_role = attributes[:'peerRole'] if attributes[:'peerRole']

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

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

  self.peer_autonomous_database_id = attributes[:'peerAutonomousDatabaseId'] if attributes[:'peerAutonomousDatabaseId']

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

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

  self.peer_autonomous_database_life_cycle_state = attributes[:'peerAutonomousDatabaseLifeCycleState'] if attributes[:'peerAutonomousDatabaseLifeCycleState']

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

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

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

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

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

  self.apply_rate = attributes[:'applyRate'] if attributes[:'applyRate']

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

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

  self.is_automatic_failover_enabled = attributes[:'isAutomaticFailoverEnabled'] unless attributes[:'isAutomaticFailoverEnabled'].nil?

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

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

  self.transport_lag = attributes[:'transportLag'] if attributes[:'transportLag']

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

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

  self.time_last_synced = attributes[:'timeLastSynced'] if attributes[:'timeLastSynced']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_last_role_changed = attributes[:'timeLastRoleChanged'] if attributes[:'timeLastRoleChanged']

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

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

Instance Attribute Details

#apply_lag ⇒ String

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database.

Example: 9 seconds

Returns:

  • (String) 


113
114
115
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 113

def apply_lag
  @apply_lag
end

#apply_rate ⇒ String

The rate at which redo logs are synced between the associated databases.

Example: 180 Mb per second

Returns:

  • (String) 


120
121
122
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 120

def apply_rate
  @apply_rate
end

#autonomous_database_id ⇒ String

[Required] The OCID of the Autonomous Database that has a relationship with the peer Autonomous Database.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 70

def autonomous_database_id
  @autonomous_database_id
end

#id ⇒ String

[Required] The OCID of the Autonomous Dataguard created for Autonomous Container Database where given Autonomous Database resides in.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 65

def id
  @id
end

#is_automatic_failover_enabled ⇒ BOOLEAN

Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association

Returns:

  • (BOOLEAN) 


125
126
127
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 125

def is_automatic_failover_enabled
  @is_automatic_failover_enabled
end

#lifecycle_details ⇒ String

Additional information about the current lifecycleState, if available.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 84

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of Autonomous Data Guard.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 79

def lifecycle_state
  @lifecycle_state
end

#peer_autonomous_database_id ⇒ String

The OCID of the peer Autonomous Database.

Returns:

  • (String) 


94
95
96
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 94

def peer_autonomous_database_id
  @peer_autonomous_database_id
end

#peer_autonomous_database_life_cycle_state ⇒ String

The current state of Autonomous Data Guard.

Returns:

  • (String) 


98
99
100
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 98

def peer_autonomous_database_life_cycle_state
  @peer_autonomous_database_life_cycle_state
end

#peer_role ⇒ String

[Required] The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Returns:

  • (String) 


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

def peer_role
  @peer_role
end

#protection_mode ⇒ String

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

Returns:

  • (String) 


105
106
107
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 105

def protection_mode
  @protection_mode
end

#role ⇒ String

[Required] The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Returns:

  • (String) 


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

def role
  @role
end

#time_created ⇒ DateTime

The date and time the Data Guard association was created.

Returns:

  • (DateTime) 


141
142
143
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 141

def time_created
  @time_created
end

#time_last_role_changed ⇒ DateTime

The date and time when the last role change action happened.

Returns:

  • (DateTime) 


145
146
147
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 145

def time_last_role_changed
  @time_last_role_changed
end

#time_last_synced ⇒ DateTime

The date and time of the last update to the apply lag, apply rate, and transport lag values.

Returns:

  • (DateTime) 


137
138
139
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 137

def time_last_synced
  @time_last_synced
end

#transport_lag ⇒ String

The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database.

Example: 7 seconds

Returns:

  • (String) 


133
134
135
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 133

def transport_lag
  @transport_lag
end

Class Method Details

.attribute_map ⇒ Object

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 148

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'autonomous_database_id': :'autonomousDatabaseId',
    'role': :'role',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'peer_role': :'peerRole',
    'peer_autonomous_database_id': :'peerAutonomousDatabaseId',
    'peer_autonomous_database_life_cycle_state': :'peerAutonomousDatabaseLifeCycleState',
    'protection_mode': :'protectionMode',
    'apply_lag': :'applyLag',
    'apply_rate': :'applyRate',
    'is_automatic_failover_enabled': :'isAutomaticFailoverEnabled',
    'transport_lag': :'transportLag',
    'time_last_synced': :'timeLastSynced',
    'time_created': :'timeCreated',
    'time_last_role_changed': :'timeLastRoleChanged'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'autonomous_database_id': :'String',
    'role': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'peer_role': :'String',
    'peer_autonomous_database_id': :'String',
    'peer_autonomous_database_life_cycle_state': :'String',
    'protection_mode': :'String',
    'apply_lag': :'String',
    'apply_rate': :'String',
    'is_automatic_failover_enabled': :'BOOLEAN',
    'transport_lag': :'String',
    'time_last_synced': :'DateTime',
    'time_created': :'DateTime',
    'time_last_role_changed': :'DateTime'
    # 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



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 384

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

  self.class == other.class &&
    id == other.id &&
    autonomous_database_id == other.autonomous_database_id &&
    role == other.role &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    peer_role == other.peer_role &&
    peer_autonomous_database_id == other.peer_autonomous_database_id &&
    peer_autonomous_database_life_cycle_state == other.peer_autonomous_database_life_cycle_state &&
    protection_mode == other.protection_mode &&
    apply_lag == other.apply_lag &&
    apply_rate == other.apply_rate &&
    is_automatic_failover_enabled == other.is_automatic_failover_enabled &&
    transport_lag == other.transport_lag &&
    time_last_synced == other.time_last_synced &&
    time_created == other.time_created &&
    time_last_role_changed == other.time_last_role_changed
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



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 429

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


409
410
411
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 409

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



418
419
420
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 418

def hash
  [id, autonomous_database_id, role, lifecycle_state, lifecycle_details, peer_role, peer_autonomous_database_id, peer_autonomous_database_life_cycle_state, protection_mode, apply_lag, apply_rate, is_automatic_failover_enabled, transport_lag, time_last_synced, time_created, time_last_role_changed].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



462
463
464
465
466
467
468
469
470
471
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 462

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



456
457
458
 
# File 'lib/oci/database/models/autonomous_database_dataguard_association.rb', line 456

def to_s
  to_hash.to_s
end