Class: OCI::DatabaseManagement::Models::ManagedMySqlDatabaseInboundReplicationSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb

Overview

Inbound replication information of a MySQL replica. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagedMySqlDatabaseInboundReplicationSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 164

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_host = attributes[:'sourceHost'] if attributes[:'sourceHost']

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

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

  self.source_port = attributes[:'sourcePort'] if attributes[:'sourcePort']

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

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

  self.fetch_status = attributes[:'fetchStatus'] if attributes[:'fetchStatus']

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

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

  self.apply_status = attributes[:'applyStatus'] if attributes[:'applyStatus']

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

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

  self.desired_delay_seconds = attributes[:'desiredDelaySeconds'] if attributes[:'desiredDelaySeconds']

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

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

  self.remaining_delay_seconds = attributes[:'remainingDelaySeconds'] if attributes[:'remainingDelaySeconds']

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

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

  self.channel_name = attributes[:'channelName'] if attributes[:'channelName']

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

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

  self.source_uuid = attributes[:'sourceUuid'] if attributes[:'sourceUuid']

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

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

  self.source_server_id = attributes[:'sourceServerId'] if attributes[:'sourceServerId']

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

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

  self.gtid_assignment = attributes[:'gtidAssignment'] if attributes[:'gtidAssignment']

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

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

  self.applier_filters = attributes[:'applierFilters'] if attributes[:'applierFilters']

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

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

  self.seconds_behind_source = attributes[:'secondsBehindSource'] if attributes[:'secondsBehindSource']

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

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

  self.retrieved_gtid_set = attributes[:'retrievedGtidSet'] if attributes[:'retrievedGtidSet']

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

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

  self.relay_log_storage_space_used = attributes[:'relayLogStorageSpaceUsed'] if attributes[:'relayLogStorageSpaceUsed']

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

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

  self.transactions_received = attributes[:'transactionsReceived'] if attributes[:'transactionsReceived']

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

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

  self.apply_delay = attributes[:'applyDelay'] if attributes[:'applyDelay']

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

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

  self.busy_workers = attributes[:'busyWorkers'] if attributes[:'busyWorkers']

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

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

  self.fetch_error = attributes[:'fetchError'] if attributes[:'fetchError']

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

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

  self.apply_error = attributes[:'applyError'] if attributes[:'applyError']

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

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

Instance Attribute Details

#applier_filters ⇒ Array<OCI::DatabaseManagement::Models::MySqlReplicationApplierFilter>

A list of MySqlReplicationApplierFilter records.

Returns:



53
54
55
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 53

def applier_filters
  @applier_filters
end

#apply_delay ⇒ Float

The time in seconds that the current transaction took between being committed on the source and being applied on the replica.

Returns:

  • (Float) 


73
74
75
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 73

def apply_delay
  @apply_delay
end

#apply_error ⇒ OCI::DatabaseManagement::Models::MySqlApplyError

Returns:



83
84
85
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 83

def apply_error
  @apply_error
end

#apply_status ⇒ String

The current status of apply operations.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 25

def apply_status
  @apply_status
end

#busy_workers ⇒ Integer

The number of workers currently busy applying transactions from the source server.

Returns:

  • (Integer) 


77
78
79
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 77

def busy_workers
  @busy_workers
end

#channel_name ⇒ String

The name of the replication channel.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 37

def channel_name
  @channel_name
end

#desired_delay_seconds ⇒ Integer

The desired number of seconds that the replica must lag the source.

Returns:

  • (Integer) 


29
30
31
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 29

def desired_delay_seconds
  @desired_delay_seconds
end

#fetch_error ⇒ OCI::DatabaseManagement::Models::MySqlFetchError

Returns:



80
81
82
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 80

def fetch_error
  @fetch_error
end

#fetch_status ⇒ String

The current status of fetch operations.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 21

def fetch_status
  @fetch_status
end

#gtid_assignment ⇒ String

Indicates whether the channel assigns global transaction identifiers (GTIDs) to anonymous replicated transactions. OFF means no GTIDs are assigned. LOCAL means a GTID is assigned that includes this replica's own universally unique identifier (UUID). A UUID as value indicates that a GTID is assigned, which includes that manually set UUID value.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 49

def gtid_assignment
  @gtid_assignment
end

#relay_log_storage_space_used ⇒ Integer

The total size in bytes of all the existing relay log files pertaining to this channel.

Returns:

  • (Integer) 


65
66
67
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 65

def relay_log_storage_space_used
  @relay_log_storage_space_used
end

#remaining_delay_seconds ⇒ Integer

If the replica is waiting for the desired delay seconds to pass since the source applied an event, this field contains the number of delay seconds remaining.

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 33

def remaining_delay_seconds
  @remaining_delay_seconds
end

#retrieved_gtid_set ⇒ String

The set of global transaction IDs corresponding to all transactions received by this replica from the source server. Empty if GTIDs are not in use.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 61

def retrieved_gtid_set
  @retrieved_gtid_set
end

#seconds_behind_source ⇒ Integer

The number of seconds the replica is behind the source server.

Returns:

  • (Integer) 


57
58
59
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 57

def seconds_behind_source
  @seconds_behind_source
end

#source_host ⇒ String

[Required] The host name or IP address of the source this replica is connected to.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 13

def source_host
  @source_host
end

#source_port ⇒ Integer

[Required] The port used to connect to the source.

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 17

def source_port
  @source_port
end

#source_server_id ⇒ Integer

The server ID value from the source server.

Returns:

  • (Integer) 


45
46
47
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 45

def source_server_id
  @source_server_id
end

#source_uuid ⇒ String

[Required] The Universally Unique Identifier (UUID) value from the source server.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 41

def source_uuid
  @source_uuid
end

#transactions_received ⇒ Integer

The number of transactions received by this replica from the source server.

Returns:

  • (Integer) 


69
70
71
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 69

def transactions_received
  @transactions_received
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 86

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'source_host': :'sourceHost',
    'source_port': :'sourcePort',
    'fetch_status': :'fetchStatus',
    'apply_status': :'applyStatus',
    'desired_delay_seconds': :'desiredDelaySeconds',
    'remaining_delay_seconds': :'remainingDelaySeconds',
    'channel_name': :'channelName',
    'source_uuid': :'sourceUuid',
    'source_server_id': :'sourceServerId',
    'gtid_assignment': :'gtidAssignment',
    'applier_filters': :'applierFilters',
    'seconds_behind_source': :'secondsBehindSource',
    'retrieved_gtid_set': :'retrievedGtidSet',
    'relay_log_storage_space_used': :'relayLogStorageSpaceUsed',
    'transactions_received': :'transactionsReceived',
    'apply_delay': :'applyDelay',
    'busy_workers': :'busyWorkers',
    'fetch_error': :'fetchError',
    'apply_error': :'applyError'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 113

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'source_host': :'String',
    'source_port': :'Integer',
    'fetch_status': :'String',
    'apply_status': :'String',
    'desired_delay_seconds': :'Integer',
    'remaining_delay_seconds': :'Integer',
    'channel_name': :'String',
    'source_uuid': :'String',
    'source_server_id': :'Integer',
    'gtid_assignment': :'String',
    'applier_filters': :'Array<OCI::DatabaseManagement::Models::MySqlReplicationApplierFilter>',
    'seconds_behind_source': :'Integer',
    'retrieved_gtid_set': :'String',
    'relay_log_storage_space_used': :'Integer',
    'transactions_received': :'Integer',
    'apply_delay': :'Float',
    'busy_workers': :'Integer',
    'fetch_error': :'OCI::DatabaseManagement::Models::MySqlFetchError',
    'apply_error': :'OCI::DatabaseManagement::Models::MySqlApplyError'
    # 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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 292

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

  self.class == other.class &&
    source_host == other.source_host &&
    source_port == other.source_port &&
    fetch_status == other.fetch_status &&
    apply_status == other.apply_status &&
    desired_delay_seconds == other.desired_delay_seconds &&
    remaining_delay_seconds == other.remaining_delay_seconds &&
    channel_name == other.channel_name &&
    source_uuid == other.source_uuid &&
    source_server_id == other.source_server_id &&
    gtid_assignment == other.gtid_assignment &&
    applier_filters == other.applier_filters &&
    seconds_behind_source == other.seconds_behind_source &&
    retrieved_gtid_set == other.retrieved_gtid_set &&
    relay_log_storage_space_used == other.relay_log_storage_space_used &&
    transactions_received == other.transactions_received &&
    apply_delay == other.apply_delay &&
    busy_workers == other.busy_workers &&
    fetch_error == other.fetch_error &&
    apply_error == other.apply_error
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



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

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


320
321
322
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 320

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



329
330
331
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 329

def hash
  [source_host, source_port, fetch_status, apply_status, desired_delay_seconds, remaining_delay_seconds, channel_name, source_uuid, source_server_id, gtid_assignment, applier_filters, seconds_behind_source, retrieved_gtid_set, relay_log_storage_space_used, transactions_received, apply_delay, busy_workers, fetch_error, apply_error].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



373
374
375
376
377
378
379
380
381
382
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 373

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



367
368
369
 
# File 'lib/oci/database_management/models/managed_my_sql_database_inbound_replication_summary.rb', line 367

def to_s
  to_hash.to_s
end