Class: OCI::FileStorage::Models::FileSystemSummary

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

Overview

Summary information for a file system.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.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
CLONE_ATTACH_STATUS_ENUM = 
[
  CLONE_ATTACH_STATUS_ATTACHED = 'ATTACHED'.freeze,
  CLONE_ATTACH_STATUS_DETACHING = 'DETACHING'.freeze,
  CLONE_ATTACH_STATUS_DETACHED = 'DETACHED'.freeze,
  CLONE_ATTACH_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
QUOTA_ENFORCEMENT_STATE_ENUM = 
[
  QUOTA_ENFORCEMENT_STATE_ENABLING = 'ENABLING'.freeze,
  QUOTA_ENFORCEMENT_STATE_ENABLED = 'ENABLED'.freeze,
  QUOTA_ENFORCEMENT_STATE_DISABLING = 'DISABLING'.freeze,
  QUOTA_ENFORCEMENT_STATE_DISABLED = 'DISABLED'.freeze,
  QUOTA_ENFORCEMENT_STATE_SYNCING = 'SYNCING'.freeze,
  QUOTA_ENFORCEMENT_STATE_FAILED = 'FAILED'.freeze,
  QUOTA_ENFORCEMENT_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FileSystemSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
333
334
335
336
337
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 226

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

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

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

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

  self.replication_source_count = attributes[:'replicationSourceCount'] if attributes[:'replicationSourceCount']

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

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

  self.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId']

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

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

  self.source_details = attributes[:'sourceDetails'] if attributes[:'sourceDetails']

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

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

  self.is_clone_parent = attributes[:'isCloneParent'] unless attributes[:'isCloneParent'].nil?

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

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

  self.is_hydrated = attributes[:'isHydrated'] unless attributes[:'isHydrated'].nil?

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

  self.is_hydrated = attributes[:'is_hydrated'] unless attributes[:'is_hydrated'].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.clone_attach_status = attributes[:'cloneAttachStatus'] if attributes[:'cloneAttachStatus']

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

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

  self.quota_enforcement_state = attributes[:'quotaEnforcementState'] if attributes[:'quotaEnforcementState']

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

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

Instance Attribute Details

#availability_domain ⇒ String

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

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


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

def availability_domain
  @availability_domain
end

#clone_attach_status ⇒ String

Specifies whether the file system is attached to its parent file system.

Returns:

  • (String) 


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

def clone_attach_status
  @clone_attach_status
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the file system.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 58

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


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

def defined_tags
  @defined_tags
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 file system

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 66

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


94
95
96
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 94

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the file system.

Returns:

  • (String) 


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

def id
  @id
end

#is_clone_parent ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


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

def is_clone_parent
  @is_clone_parent
end

#is_hydrated ⇒ BOOLEAN

Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.

Returns:

  • (BOOLEAN) 


133
134
135
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 133

def is_hydrated
  @is_hydrated
end

#kms_key_id ⇒ String

The OCID of the KMS key used to encrypt the encryption keys associated with this file system.

Returns:

  • (String) 


116
117
118
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 116

def kms_key_id
  @kms_key_id
end

#lifecycle_details ⇒ String

Additional information about the current 'lifecycleState'.

Returns:

  • (String) 


137
138
139
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 137

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the file system.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 74

def lifecycle_state
  @lifecycle_state
end

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

Locks associated with this resource.

Returns:



86
87
88
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 86

def locks
  @locks
end

#metered_bytes ⇒ Integer

[Required] The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system.

Returns:

  • (Integer) 


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

def metered_bytes
  @metered_bytes
end

#quota_enforcement_state ⇒ String

Displays the state of enforcement of quota rules on the file system.

Returns:

  • (String) 


145
146
147
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 145

def quota_enforcement_state
  @quota_enforcement_state
end

#replication_source_count ⇒ Integer

Specifies the total number of replications for which this file system is a source.

Returns:

  • (Integer) 


111
112
113
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 111

def replication_source_count
  @replication_source_count
end

#source_details ⇒ OCI::FileStorage::Models::SourceDetails

Returns:



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

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


107
108
109
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 107

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


82
83
84
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 82

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'metered_bytes': :'meteredBytes',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'locks': :'locks',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'replication_source_count': :'replicationSourceCount',
    'kms_key_id': :'kmsKeyId',
    'source_details': :'sourceDetails',
    'is_clone_parent': :'isCloneParent',
    'is_hydrated': :'isHydrated',
    'lifecycle_details': :'lifecycleDetails',
    'clone_attach_status': :'cloneAttachStatus',
    'quota_enforcement_state': :'quotaEnforcementState'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'metered_bytes': :'Integer',
    'compartment_id': :'String',
    'display_name': :'String',
    'id': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    '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>>',
    'replication_source_count': :'Integer',
    'kms_key_id': :'String',
    'source_details': :'OCI::FileStorage::Models::SourceDetails',
    'is_clone_parent': :'BOOLEAN',
    'is_hydrated': :'BOOLEAN',
    'lifecycle_details': :'String',
    'clone_attach_status': :'String',
    'quota_enforcement_state': :'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



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 385

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    metered_bytes == other.metered_bytes &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    locks == other.locks &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    replication_source_count == other.replication_source_count &&
    kms_key_id == other.kms_key_id &&
    source_details == other.source_details &&
    is_clone_parent == other.is_clone_parent &&
    is_hydrated == other.is_hydrated &&
    lifecycle_details == other.lifecycle_details &&
    clone_attach_status == other.clone_attach_status &&
    quota_enforcement_state == other.quota_enforcement_state
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



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 433

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


413
414
415
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 413

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



422
423
424
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 422

def hash
  [availability_domain, metered_bytes, compartment_id, display_name, id, lifecycle_state, time_created, locks, freeform_tags, defined_tags, system_tags, replication_source_count, kms_key_id, source_details, is_clone_parent, is_hydrated, lifecycle_details, clone_attach_status, quota_enforcement_state].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



466
467
468
469
470
471
472
473
474
475
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 466

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



460
461
462
 
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 460

def to_s
  to_hash.to_s
end