Class: OCI::FileStorage::Models::MountTarget

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

Overview

Provides access to a collection of file systems through one or more VNICs on a specified subnet. The set of file systems is controlled through the referenced export set.

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_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
IDMAP_TYPE_ENUM = 
[
  IDMAP_TYPE_LDAP = 'LDAP'.freeze,
  IDMAP_TYPE_NONE = 'NONE'.freeze,
  IDMAP_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 = {}) ⇒ MountTarget

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 242

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

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

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

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

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

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  self.idmap_type = attributes[:'idmapType'] if attributes[:'idmapType']

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

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

  self.ldap_idmap = attributes[:'ldapIdmap'] if attributes[:'ldapIdmap']

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

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

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

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

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

  self.time_billing_cycle_end = attributes[:'timeBillingCycleEnd'] if attributes[:'timeBillingCycleEnd']

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

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

  self.observed_throughput = attributes[:'observedThroughput'] if attributes[:'observedThroughput']

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

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

  self.requested_throughput = attributes[:'requestedThroughput'] if attributes[:'requestedThroughput']

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

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

  self.reserved_storage_capacity = attributes[:'reservedStorageCapacity'] if attributes[:'reservedStorageCapacity']

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

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

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

Instance Attribute Details

#availability_domain ⇒ String

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

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 37

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the mount target.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 41

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


146
147
148
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 146

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 mount target

Returns:

  • (String) 


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

def display_name
  @display_name
end

#export_set_id ⇒ String

The OCID of the associated export set. Controls what file systems will be exported through Network File System (NFS) protocol on this mount target.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 56

def export_set_id
  @export_set_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>) 


139
140
141
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 139

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the mount target.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 60

def id
  @id
end

#idmap_type ⇒ String

The method used to map a Unix UID to secondary groups. If NONE, the mount target will not use the Unix UID for ID mapping.

Returns:

  • (String) 


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

def idmap_type
  @idmap_type
end

#kerberos ⇒ OCI::FileStorage::Models::Kerberos

Returns:



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

def kerberos
  @kerberos
end

#ldap_idmap ⇒ OCI::FileStorage::Models::LdapIdmap

Returns:



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

def ldap_idmap
  @ldap_idmap
end

#lifecycle_details ⇒ String

[Required] Additional information about the current 'lifecycleState'.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 64

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the mount target.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 68

def lifecycle_state
  @lifecycle_state
end

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

Locks associated with this resource.

Returns:



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

def locks
  @locks
end

#nsg_ids ⇒ Array<String>

A list of Network Security Group OCIDs associated with this mount target. A maximum of 5 is allowed. Setting this to an empty array after the list is created removes the mount target from all NSGs. For more information about NSGs, see Security Rules.

Returns:

  • (Array<String>) 


91
92
93
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 91

def nsg_ids
  @nsg_ids
end

#observed_throughput ⇒ Integer

Current billed throughput for mount target in Gbps. This corresponds to shape of mount target. Available shapes and corresponding throughput are listed at Mount Target Performance.

Returns:

  • (Integer) 


108
109
110
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 108

def observed_throughput
  @observed_throughput
end

#private_ip_ids ⇒ Array<String>

[Required] The OCIDs of the private IP addresses associated with this mount target.

Returns:

  • (Array<String>) 


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

def private_ip_ids
  @private_ip_ids
end

#requested_throughput ⇒ Integer

  • New throughput for mount target at the end of billing cycle in Gbps.

Returns:

  • (Integer) 


113
114
115
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 113

def requested_throughput
  @requested_throughput
end

#reserved_storage_capacity ⇒ Integer

  • Reserved capacity (GB) associated with this mount target. Reserved capacity depends on observedThroughput value of mount target. Value is listed at Mount Target Performance.

Returns:

  • (Integer) 


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

def reserved_storage_capacity
  @reserved_storage_capacity
end

#subnet_id ⇒ String

[Required] The OCID of the subnet the mount target is in.

Returns:

  • (String) 


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

def subnet_id
  @subnet_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>>) 


152
153
154
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 152

def system_tags
  @system_tags
end

#time_billing_cycle_end ⇒ DateTime

The date and time the mount target current billing cycle will end and next one starts, expressed in RFC 3339 timestamp format.

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

Returns:

  • (DateTime) 


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

def time_billing_cycle_end
  @time_billing_cycle_end
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 155

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'export_set_id': :'exportSetId',
    'id': :'id',
    'lifecycle_details': :'lifecycleDetails',
    'lifecycle_state': :'lifecycleState',
    'private_ip_ids': :'privateIpIds',
    'subnet_id': :'subnetId',
    'idmap_type': :'idmapType',
    'ldap_idmap': :'ldapIdmap',
    'nsg_ids': :'nsgIds',
    'kerberos': :'kerberos',
    'time_billing_cycle_end': :'timeBillingCycleEnd',
    'observed_throughput': :'observedThroughput',
    'requested_throughput': :'requestedThroughput',
    'reserved_storage_capacity': :'reservedStorageCapacity',
    'time_created': :'timeCreated',
    'locks': :'locks',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'export_set_id': :'String',
    'id': :'String',
    'lifecycle_details': :'String',
    'lifecycle_state': :'String',
    'private_ip_ids': :'Array<String>',
    'subnet_id': :'String',
    'idmap_type': :'String',
    'ldap_idmap': :'OCI::FileStorage::Models::LdapIdmap',
    'nsg_ids': :'Array<String>',
    'kerberos': :'OCI::FileStorage::Models::Kerberos',
    'time_billing_cycle_end': :'DateTime',
    'observed_throughput': :'Integer',
    'requested_throughput': :'Integer',
    'reserved_storage_capacity': :'Integer',
    '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>>'
    # 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



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 402

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    export_set_id == other.export_set_id &&
    id == other.id &&
    lifecycle_details == other.lifecycle_details &&
    lifecycle_state == other.lifecycle_state &&
    private_ip_ids == other.private_ip_ids &&
    subnet_id == other.subnet_id &&
    idmap_type == other.idmap_type &&
    ldap_idmap == other.ldap_idmap &&
    nsg_ids == other.nsg_ids &&
    kerberos == other.kerberos &&
    time_billing_cycle_end == other.time_billing_cycle_end &&
    observed_throughput == other.observed_throughput &&
    requested_throughput == other.requested_throughput &&
    reserved_storage_capacity == other.reserved_storage_capacity &&
    time_created == other.time_created &&
    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



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 453

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


433
434
435
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 433

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [availability_domain, compartment_id, display_name, export_set_id, id, lifecycle_details, lifecycle_state, private_ip_ids, subnet_id, idmap_type, ldap_idmap, nsg_ids, kerberos, time_billing_cycle_end, observed_throughput, requested_throughput, reserved_storage_capacity, time_created, 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



486
487
488
489
490
491
492
493
494
495
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 486

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



480
481
482
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 480

def to_s
  to_hash.to_s
end