Class: OCI::Database::Models::DataGuardAssociation

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

Overview

The properties that define a Data Guard association.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

For information about endpoints and signing API requests, see [About the API](docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see [SDKS and Other Tools](docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdks.htm).

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE',
LIFECYCLE_STATE_UPDATING = 'UPDATING',
LIFECYCLE_STATE_TERMINATING = 'TERMINATING',
LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
LIFECYCLE_STATE_FAILED = 'FAILED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
PEER_ROLE_ENUM = 
[PEER_ROLE_PRIMARY = 'PRIMARY',
PEER_ROLE_STANDBY = 'STANDBY',
PEER_ROLE_DISABLED_STANDBY = 'DISABLED_STANDBY',
PEER_ROLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
PROTECTION_MODE_ENUM = 
[PROTECTION_MODE_MAXIMUM_AVAILABILITY = 'MAXIMUM_AVAILABILITY',
PROTECTION_MODE_MAXIMUM_PERFORMANCE = 'MAXIMUM_PERFORMANCE',
PROTECTION_MODE_MAXIMUM_PROTECTION = 'MAXIMUM_PROTECTION',
PROTECTION_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
ROLE_ENUM = 
[ROLE_PRIMARY = 'PRIMARY',
ROLE_STANDBY = 'STANDBY',
ROLE_DISABLED_STANDBY = 'DISABLED_STANDBY',
ROLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
TRANSPORT_TYPE_ENUM = 
[TRANSPORT_TYPE_SYNC = 'SYNC',
TRANSPORT_TYPE_ASYNC = 'ASYNC',
TRANSPORT_TYPE_FASTSYNC = 'FASTSYNC',
TRANSPORT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataGuardAssociation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :apply_lag (String) —

    The value to assign to the #apply_lag property

  • :apply_rate (String) —

    The value to assign to the #apply_rate property

  • :database_id (String) —

    The value to assign to the #database_id property

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :peer_data_guard_association_id (String) —

    The value to assign to the #peer_data_guard_association_id property

  • :peer_database_id (String) —

    The value to assign to the #peer_database_id property

  • :peer_db_home_id (String) —

    The value to assign to the #peer_db_home_id property

  • :peer_db_system_id (String) —

    The value to assign to the #peer_db_system_id property

  • :peer_role (String) —

    The value to assign to the #peer_role property

  • :protection_mode (String) —

    The value to assign to the #protection_mode property

  • :role (String) —

    The value to assign to the #role property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :transport_type (String) —

    The value to assign to the #transport_type property



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
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
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
 
# File 'lib/oci/database/models/data_guard_association.rb', line 145

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}

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

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

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

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

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

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

  if attributes[:'databaseId']
    self.database_id = attributes[:'databaseId']
  end

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

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

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

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

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

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

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

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

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

  if attributes[:'peerDataGuardAssociationId']
    self.peer_data_guard_association_id = attributes[:'peerDataGuardAssociationId']
  end

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

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

  if attributes[:'peerDatabaseId']
    self.peer_database_id = attributes[:'peerDatabaseId']
  end

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

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

  if attributes[:'peerDbHomeId']
    self.peer_db_home_id = attributes[:'peerDbHomeId']
  end

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

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

  if attributes[:'peerDbSystemId']
    self.peer_db_system_id = attributes[:'peerDbSystemId']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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) 


56
57
58
 
# File 'lib/oci/database/models/data_guard_association.rb', line 56

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) 


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

def apply_rate
  @apply_rate
end

#database_id ⇒ String

[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the reporting database.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/database/models/data_guard_association.rb', line 67

def database_id
  @database_id
end

#id ⇒ String

[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the Data Guard association.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/database/models/data_guard_association.rb', line 71

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycleState, if available.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/database/models/data_guard_association.rb', line 76

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Data Guard association.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/database/models/data_guard_association.rb', line 80

def lifecycle_state
  @lifecycle_state
end

#peer_data_guard_association_id ⇒ String

The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the peer database’s Data Guard association.

Returns:

  • (String) 


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

def peer_data_guard_association_id
  @peer_data_guard_association_id
end

#peer_database_id ⇒ String

The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the associated peer database.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/database/models/data_guard_association.rb', line 88

def peer_database_id
  @peer_database_id
end

#peer_db_home_id ⇒ String

The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the database home containing the associated peer database.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/database/models/data_guard_association.rb', line 93

def peer_db_home_id
  @peer_db_home_id
end

#peer_db_system_id ⇒ String

[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the DB System containing the associated peer database.

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/database/models/data_guard_association.rb', line 99

def peer_db_system_id
  @peer_db_system_id
end

#peer_role ⇒ String

[Required] The role of the peer database in this Data Guard association.

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/database/models/data_guard_association.rb', line 103

def peer_role
  @peer_role
end

#protection_mode ⇒ String

[Required] The protection mode of this Data Guard association. For more information, see [Oracle Data Guard Protection Modes](docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation.

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/database/models/data_guard_association.rb', line 110

def protection_mode
  @protection_mode
end

#role ⇒ String

[Required] The role of the reporting database in this Data Guard association.

Returns:

  • (String) 


114
115
116
 
# File 'lib/oci/database/models/data_guard_association.rb', line 114

def role
  @role
end

#time_created ⇒ DateTime

The date and time the Data Guard Association was created.

Returns:

  • (DateTime) 


118
119
120
 
# File 'lib/oci/database/models/data_guard_association.rb', line 118

def time_created
  @time_created
end

#transport_type ⇒ String

The redo transport type used by this Data Guard association. For more information, see [Redo Transport Services](docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation.

Returns:

  • (String) 


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

def transport_type
  @transport_type
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



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

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      apply_lag == other_object.apply_lag &&
      apply_rate == other_object.apply_rate &&
      database_id == other_object.database_id &&
      id == other_object.id &&
      lifecycle_details == other_object.lifecycle_details &&
      lifecycle_state == other_object.lifecycle_state &&
      peer_data_guard_association_id == other_object.peer_data_guard_association_id &&
      peer_database_id == other_object.peer_database_id &&
      peer_db_home_id == other_object.peer_db_home_id &&
      peer_db_system_id == other_object.peer_db_system_id &&
      peer_role == other_object.peer_role &&
      protection_mode == other_object.protection_mode &&
      role == other_object.role &&
      time_created == other_object.time_created &&
      transport_type == other_object.transport_type
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



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/oci/database/models/data_guard_association.rb', line 378

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


365
366
367
 
# File 'lib/oci/database/models/data_guard_association.rb', line 365

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



371
372
373
 
# File 'lib/oci/database/models/data_guard_association.rb', line 371

def hash
  [apply_lag, apply_rate, database_id, id, lifecycle_details, lifecycle_state, peer_data_guard_association_id, peer_database_id, peer_db_home_id, peer_db_system_id, peer_role, protection_mode, role, time_created, transport_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



403
404
405
406
407
408
409
410
411
 
# File 'lib/oci/database/models/data_guard_association.rb', line 403

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



397
398
399
 
# File 'lib/oci/database/models/data_guard_association.rb', line 397

def to_s
  to_hash.to_s
end