Class: OCI::FileStorage::Models::Replication

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/file_storage/models/replication.rb

Overview

Replications are the primary resource that governs the policy of cross-region replication between source and target file systems. Replications are associated with a secondary resource called a ReplicationTarget} located in another availability domain in the same or different region. The replication retrieves the delta of data between two snapshots of a source file system and sends it to the associated ReplicationTarget, which applies it to the target file system. For more information, see {File System Replication.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DELTA_STATUS_ENUM = 
[
  DELTA_STATUS_IDLE = 'IDLE'.freeze,
  DELTA_STATUS_CAPTURING = 'CAPTURING'.freeze,
  DELTA_STATUS_APPLYING = 'APPLYING'.freeze,
  DELTA_STATUS_SERVICE_ERROR = 'SERVICE_ERROR'.freeze,
  DELTA_STATUS_USER_ERROR = 'USER_ERROR'.freeze,
  DELTA_STATUS_FAILED = 'FAILED'.freeze,
  DELTA_STATUS_TRANSFERRING = 'TRANSFERRING'.freeze,
  DELTA_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Replication

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :source_id (String) —

    The value to assign to the #source_id property

  • :target_id (String) —

    The value to assign to the #target_id property

  • :replication_target_id (String) —

    The value to assign to the #replication_target_id property

  • :replication_interval (Integer) —

    The value to assign to the #replication_interval property

  • :last_snapshot_id (String) —

    The value to assign to the #last_snapshot_id property

  • :recovery_point_time (DateTime) —

    The value to assign to the #recovery_point_time property

  • :delta_status (String) —

    The value to assign to the #delta_status property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :delta_progress (Integer) —

    The value to assign to the #delta_progress property

  • :locks (Array<OCI::FileStorage::Models::ResourceLock>) —

    The value to assign to the #locks property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/oci/file_storage/models/replication.rb', line 221

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

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

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

  self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

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

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

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

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

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

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

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

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

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

  self.replication_target_id = attributes[:'replicationTargetId'] if attributes[:'replicationTargetId']

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

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

  self.replication_interval = attributes[:'replicationInterval'] if attributes[:'replicationInterval']

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

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

  self.last_snapshot_id = attributes[:'lastSnapshotId'] if attributes[:'lastSnapshotId']

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

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

  self.recovery_point_time = attributes[:'recoveryPointTime'] if attributes[:'recoveryPointTime']

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

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

  self.delta_status = attributes[:'deltaStatus'] if attributes[:'deltaStatus']

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

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

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

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#availability_domain ⇒ String

The availability domain that contains the replication. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-2

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/file_storage/models/replication.rb', line 46

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the replication.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/file_storage/models/replication.rb', line 40

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


134
135
136
 
# File 'lib/oci/file_storage/models/replication.rb', line 134

def defined_tags
  @defined_tags
end

#delta_progress ⇒ Integer

Percentage progress of the current replication cycle.

Returns:

  • (Integer) 


115
116
117
 
# File 'lib/oci/file_storage/models/replication.rb', line 115

def delta_progress
  @delta_progress
end

#delta_status ⇒ String

The current state of the snapshot during replication operations.

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/file_storage/models/replication.rb', line 106

def delta_status
  @delta_status
end

#display_name ⇒ String

[Required] A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: My replication

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/file_storage/models/replication.rb', line 62

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


127
128
129
 
# File 'lib/oci/file_storage/models/replication.rb', line 127

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the replication.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/file_storage/models/replication.rb', line 50

def id
  @id
end

#last_snapshot_id ⇒ String

The OCID of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/file_storage/models/replication.rb', line 95

def last_snapshot_id
  @last_snapshot_id
end

#lifecycle_details ⇒ String

Additional information about the current 'lifecycleState'.

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/file_storage/models/replication.rb', line 110

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the replication.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/file_storage/models/replication.rb', line 54

def lifecycle_state
  @lifecycle_state
end

#locks ⇒ Array<OCI::FileStorage::Models::ResourceLock>

Locks associated with this resource.

Returns:



119
120
121
 
# File 'lib/oci/file_storage/models/replication.rb', line 119

def locks
  @locks
end

#recovery_point_time ⇒ DateTime

The #snapshot_time snapshot_time} of the most recent recoverable replication snapshot in {RFC 3339 timestamp format. Example: 2021-04-04T20:01:29.100Z

Returns:

  • (DateTime) 


102
103
104
 
# File 'lib/oci/file_storage/models/replication.rb', line 102

def recovery_point_time
  @recovery_point_time
end

#replication_interval ⇒ Integer

Duration in minutes between replication snapshots.

Returns:

  • (Integer) 


89
90
91
 
# File 'lib/oci/file_storage/models/replication.rb', line 89

def replication_interval
  @replication_interval
end

#replication_target_id ⇒ String

[Required] The OCID of the OCI::FileStorage::Models::ReplicationTarget.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/file_storage/models/replication.rb', line 85

def replication_target_id
  @replication_target_id
end

#source_id ⇒ String

[Required] The OCID of the source file system.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/file_storage/models/replication.rb', line 75

def source_id
  @source_id
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. System tags are applied to resources by internal OCI services.

Returns:

  • (Hash<String, Hash<String, Object>>) 


140
141
142
 
# File 'lib/oci/file_storage/models/replication.rb', line 140

def system_tags
  @system_tags
end

#target_id ⇒ String

[Required] The OCID of the target file system.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/file_storage/models/replication.rb', line 80

def target_id
  @target_id
end

#time_created ⇒ DateTime

[Required] The date and time the replication was created in RFC 3339 timestamp format.

Example: 2021-01-04T20:01:29.100Z

Returns:

  • (DateTime) 


70
71
72
 
# File 'lib/oci/file_storage/models/replication.rb', line 70

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/file_storage/models/replication.rb', line 143

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'availability_domain': :'availabilityDomain',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'source_id': :'sourceId',
    'target_id': :'targetId',
    'replication_target_id': :'replicationTargetId',
    'replication_interval': :'replicationInterval',
    'last_snapshot_id': :'lastSnapshotId',
    'recovery_point_time': :'recoveryPointTime',
    'delta_status': :'deltaStatus',
    'lifecycle_details': :'lifecycleDetails',
    'delta_progress': :'deltaProgress',
    'locks': :'locks',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/file_storage/models/replication.rb', line 170

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'availability_domain': :'String',
    'id': :'String',
    'lifecycle_state': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'source_id': :'String',
    'target_id': :'String',
    'replication_target_id': :'String',
    'replication_interval': :'Integer',
    'last_snapshot_id': :'String',
    'recovery_point_time': :'DateTime',
    'delta_status': :'String',
    'lifecycle_details': :'String',
    'delta_progress': :'Integer',
    'locks': :'Array<OCI::FileStorage::Models::ResourceLock>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/oci/file_storage/models/replication.rb', line 367

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    availability_domain == other.availability_domain &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    source_id == other.source_id &&
    target_id == other.target_id &&
    replication_target_id == other.replication_target_id &&
    replication_interval == other.replication_interval &&
    last_snapshot_id == other.last_snapshot_id &&
    recovery_point_time == other.recovery_point_time &&
    delta_status == other.delta_status &&
    lifecycle_details == other.lifecycle_details &&
    delta_progress == other.delta_progress &&
    locks == other.locks &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/oci/file_storage/models/replication.rb', line 415

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


395
396
397
 
# File 'lib/oci/file_storage/models/replication.rb', line 395

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



404
405
406
 
# File 'lib/oci/file_storage/models/replication.rb', line 404

def hash
  [compartment_id, availability_domain, id, lifecycle_state, display_name, time_created, source_id, target_id, replication_target_id, replication_interval, last_snapshot_id, recovery_point_time, delta_status, lifecycle_details, delta_progress, locks, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



448
449
450
451
452
453
454
455
456
457
 
# File 'lib/oci/file_storage/models/replication.rb', line 448

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



442
443
444
 
# File 'lib/oci/file_storage/models/replication.rb', line 442

def to_s
  to_hash.to_s
end