Class: OCI::FileStorage::Models::ReplicationTarget

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

Overview

Replication targets are associated with a primary resource called a Replication} 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. All operations (except DELETE) must be done using the associated replication resource. Deleting a ReplicationTarget allows the target file system to be exported. Deleting a ReplicationTarget does not delete the associated Replication resource, but places it in a FAILED state. 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 = {}) ⇒ ReplicationTarget

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :compartment_id (String) —

    The value to assign to the #compartment_id 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_id (String) —

    The value to assign to the #replication_id 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

  • :delta_progress (Integer) —

    The value to assign to the #delta_progress 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

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property



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
290
291
292
293
294
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 197

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

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

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

  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.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.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.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']
end

Instance Attribute Details

#availability_domain ⇒ String

The availability domain the replication resource is in. May be unset as a blank or NULL value.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 47

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 51

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>>) 


121
122
123
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 121

def defined_tags
  @defined_tags
end

#delta_progress ⇒ Integer

Percentage progress of the current replication cycle.

Returns:

  • (Integer) 


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

def delta_progress
  @delta_progress
end

#delta_status ⇒ String

The current state of the snapshot during replication operations.

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 101

def delta_status
  @delta_status
end

#display_name ⇒ String

[Required] A user-friendly name. This name is same as the replication display name for the associated resource. Example: My Replication

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 65

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>) 


114
115
116
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 114

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the replication.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 55

def id
  @id
end

#last_snapshot_id ⇒ String

The OCID of the last snapshot snapshot which was completely applied to the target file system. Empty while the initial snapshot is being applied.

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 90

def last_snapshot_id
  @last_snapshot_id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycleState.

Returns:

  • (String) 


125
126
127
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 125

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of this replication.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 59

def lifecycle_state
  @lifecycle_state
end

#recovery_point_time ⇒ DateTime

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

Returns:

  • (DateTime) 


97
98
99
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 97

def recovery_point_time
  @recovery_point_time
end

#replication_id ⇒ String

[Required] The OCID of replication.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 84

def replication_id
  @replication_id
end

#source_id ⇒ String

[Required] The OCID of source filesystem.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 76

def source_id
  @source_id
end

#target_id ⇒ String

[Required] The OCID of target filesystem.

Returns:

  • (String) 


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

def target_id
  @target_id
end

#time_created ⇒ DateTime

[Required] The date and time the replication target was created in target region. in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z

Returns:

  • (DateTime) 


72
73
74
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 72

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 128

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

.swagger_types ⇒ Object

Attribute type mapping.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 152

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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 329

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    compartment_id == other.compartment_id &&
    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_id == other.replication_id &&
    last_snapshot_id == other.last_snapshot_id &&
    recovery_point_time == other.recovery_point_time &&
    delta_status == other.delta_status &&
    delta_progress == other.delta_progress &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    lifecycle_details == other.lifecycle_details
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



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 374

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


354
355
356
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 354

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



363
364
365
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 363

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



407
408
409
410
411
412
413
414
415
416
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 407

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



401
402
403
 
# File 'lib/oci/file_storage/models/replication_target.rb', line 401

def to_s
  to_hash.to_s
end