Class: OCI::FileStorage::Models::Snapshot

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

Overview

A point-in-time snapshot of a specified file system.

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_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SNAPSHOT_TYPE_ENUM = 
[
  SNAPSHOT_TYPE_USER = 'USER'.freeze,
  SNAPSHOT_TYPE_POLICY_BASED = 'POLICY_BASED'.freeze,
  SNAPSHOT_TYPE_REPLICATION = 'REPLICATION'.freeze,
  SNAPSHOT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Snapshot

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

  self.file_system_id = attributes[:'file_system_id'] if attributes[:'file_system_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.name = attributes[:'name'] if attributes[:'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.snapshot_type = attributes[:'snapshotType'] if attributes[:'snapshotType']

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

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

  self.snapshot_time = attributes[:'snapshotTime'] if attributes[:'snapshotTime']

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

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

  self.provenance_id = attributes[:'provenanceId'] if attributes[:'provenanceId']

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

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

  self.is_clone_source = attributes[:'isCloneSource'] unless attributes[:'isCloneSource'].nil?

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

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

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

  self.lock_duration_details = attributes[:'lockDurationDetails'] if attributes[:'lockDurationDetails']

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

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

  self.time_locked = attributes[:'timeLocked'] if attributes[:'timeLocked']

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

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

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

  self.expiration_time = attributes[:'expirationTime'] if attributes[:'expirationTime']

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

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

  self.filesystem_snapshot_policy_id = attributes[:'filesystemSnapshotPolicyId'] if attributes[:'filesystemSnapshotPolicyId']

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

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

  self.exclusive_bytes = attributes[:'exclusiveBytes'] if attributes[:'exclusiveBytes']

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

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

Instance Attribute Details

#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/snapshot.rb', line 121

def defined_tags
  @defined_tags
end

#exclusive_bytes ⇒ Integer

Bytes referenced only by this snapshot; deducted from compartment usage immediately upon deletion.

Returns:

  • (Integer) 


141
142
143
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 141

def exclusive_bytes
  @exclusive_bytes
end

#expiration_time ⇒ DateTime

The time when this snapshot will be deleted.

Returns:

  • (DateTime) 


131
132
133
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 131

def expiration_time
  @expiration_time
end

#file_system_id ⇒ String

[Required] The OCID of the file system from which the snapshot was created.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 32

def file_system_id
  @file_system_id
end

#filesystem_snapshot_policy_id ⇒ String

The OCID of the file system snapshot policy that created this snapshot.

Returns:

  • (String) 


136
137
138
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 136

def filesystem_snapshot_policy_id
  @filesystem_snapshot_policy_id
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/snapshot.rb', line 114

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the snapshot.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 36

def id
  @id
end

#is_clone_source ⇒ BOOLEAN

Specifies whether the snapshot has been cloned. See Cloning a File System.

Returns:

  • (BOOLEAN) 


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

def is_clone_source
  @is_clone_source
end

#lifecycle_details ⇒ String

Additional information about the current lifecycleState.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 93

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the snapshot.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#lock_duration_details ⇒ OCI::FileStorage::Models::LockDurationDetails

Returns:



100
101
102
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 100

def lock_duration_details
  @lock_duration_details
end

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

Locks associated with this resource.

Returns:



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

def locks
  @locks
end

#name ⇒ String

[Required] Name of the snapshot. This value is immutable.

Avoid entering confidential information.

Example: Sunday

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 49

def name
  @name
end

#provenance_id ⇒ String

An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the provenanceId is the same as the snapshot id value. If this snapshot was cloned, then the provenanceId value is the parent's provenanceId. See Cloning a File System.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 83

def provenance_id
  @provenance_id
end

#snapshot_time ⇒ DateTime

The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from timeCreated depending on the following factors: - If the snapshot is created in the original file system directory. - If the snapshot is cloned from a file system. - If the snapshot is replicated from a file system.

Example: 2020-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


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

def snapshot_time
  @snapshot_time
end

#snapshot_type ⇒ String

Specifies generation type of the snapshot.

Returns:

  • (String) 


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

def snapshot_type
  @snapshot_type
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>>) 


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


57
58
59
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 57

def time_created
  @time_created
end

#time_locked ⇒ DateTime

The date and time as per RFC 3339 when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service.

Returns:

  • (DateTime) 


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

def time_locked
  @time_locked
end

Class Method Details

.attribute_map ⇒ Object

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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 144

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'file_system_id': :'fileSystemId',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'name': :'name',
    'time_created': :'timeCreated',
    'snapshot_type': :'snapshotType',
    'snapshot_time': :'snapshotTime',
    'provenance_id': :'provenanceId',
    'is_clone_source': :'isCloneSource',
    'lifecycle_details': :'lifecycleDetails',
    'locks': :'locks',
    'lock_duration_details': :'lockDurationDetails',
    'time_locked': :'timeLocked',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'expiration_time': :'expirationTime',
    'filesystem_snapshot_policy_id': :'filesystemSnapshotPolicyId',
    'exclusive_bytes': :'exclusiveBytes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'file_system_id': :'String',
    'id': :'String',
    'lifecycle_state': :'String',
    'name': :'String',
    'time_created': :'DateTime',
    'snapshot_type': :'String',
    'snapshot_time': :'DateTime',
    'provenance_id': :'String',
    'is_clone_source': :'BOOLEAN',
    'lifecycle_details': :'String',
    'locks': :'Array<OCI::FileStorage::Models::ResourceLock>',
    'lock_duration_details': :'OCI::FileStorage::Models::LockDurationDetails',
    'time_locked': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'expiration_time': :'DateTime',
    'filesystem_snapshot_policy_id': :'String',
    'exclusive_bytes': :'Integer'
    # 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



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

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

  self.class == other.class &&
    file_system_id == other.file_system_id &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    name == other.name &&
    time_created == other.time_created &&
    snapshot_type == other.snapshot_type &&
    snapshot_time == other.snapshot_time &&
    provenance_id == other.provenance_id &&
    is_clone_source == other.is_clone_source &&
    lifecycle_details == other.lifecycle_details &&
    locks == other.locks &&
    lock_duration_details == other.lock_duration_details &&
    time_locked == other.time_locked &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    expiration_time == other.expiration_time &&
    filesystem_snapshot_policy_id == other.filesystem_snapshot_policy_id &&
    exclusive_bytes == other.exclusive_bytes
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



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

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


392
393
394
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 392

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [file_system_id, id, lifecycle_state, name, time_created, snapshot_type, snapshot_time, provenance_id, is_clone_source, lifecycle_details, locks, lock_duration_details, time_locked, freeform_tags, defined_tags, system_tags, expiration_time, filesystem_snapshot_policy_id, exclusive_bytes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



445
446
447
448
449
450
451
452
453
454
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 445

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



439
440
441
 
# File 'lib/oci/file_storage/models/snapshot.rb', line 439

def to_s
  to_hash.to_s
end