Class: OCI::FileStorage::Models::CreateMountTargetDetails

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

Overview

Details for creating the mount target.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateMountTargetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

  self.ip_address = attributes[:'ipAddress'] if attributes[:'ipAddress']

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

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

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

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

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

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

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

Instance Attribute Details

#availability_domain ⇒ String

[Required] The availability domain in which to create the mount target.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 16

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment in which to create the mount target.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 20

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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) 


28
29
30
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 28

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


103
104
105
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 103

def freeform_tags
  @freeform_tags
end

#hostname_label ⇒ String

The hostname for the mount target's IP address, used for DNS resolution. The value is the hostname portion of the private IP address's fully qualified domain name (FQDN). For example, files-1 in the FQDN files-1.subnet123.vcn1.oraclevcn.com. Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

Note:

If the IP address is IPv4, this attribute value is stored in the PrivateIp resource, not in the mountTarget resource. To update the hostnameLabel, use GetMountTarget to obtain the OCIDs of the mount target's private IPs (privateIpIds). Then, you can use UpdatePrivateIp to update the hostnameLabel value.

If the IP address is IPv6, it is stored in the [Ipv6] (docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Ipv6) resource To update the hostnameLabel, use GetMountTarget to obtain the OCIDs of the mount target's IPv6 address (mountTargetIpv6Ids). Then, you can use UpdateIpv6 to update the hostnameLabel value.

For more information, see DNS in Your Virtual Cloud Network.

Example: files-1

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 63

def hostname_label
  @hostname_label
end

#idmap_type ⇒ String

The method used to map a Unix UID to secondary groups, if any.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 81

def idmap_type
  @idmap_type
end

#ip_address ⇒ String

A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet.

Example: 10.0.3.3

Returns:

  • (String) 


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

def ip_address
  @ip_address
end

#kerberos ⇒ OCI::FileStorage::Models::CreateKerberosDetails

Returns:



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

def kerberos
  @kerberos
end

#ldap_idmap ⇒ OCI::FileStorage::Models::CreateLdapIdmapDetails

Returns:



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

def ldap_idmap
  @ldap_idmap
end

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

Locks associated with this resource.

Returns:



123
124
125
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 123

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


92
93
94
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 92

def nsg_ids
  @nsg_ids
end

#requested_throughput ⇒ Integer

Throughput for mount target in Gbps. Currently only 1 Gbps of requestedThroughput is supported during create MountTarget. Available shapes and corresponding throughput are listed at Mount Target Performance.

Returns:

  • (Integer) 


129
130
131
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 129

def requested_throughput
  @requested_throughput
end

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

Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}

Returns:

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


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

def security_attributes
  @security_attributes
end

#subnet_id ⇒ String

[Required] The OCID of the subnet in which to create the mount target.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 77

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 132

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'hostname_label': :'hostnameLabel',
    'ip_address': :'ipAddress',
    'subnet_id': :'subnetId',
    'idmap_type': :'idmapType',
    'ldap_idmap': :'ldapIdmap',
    'nsg_ids': :'nsgIds',
    'kerberos': :'kerberos',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'security_attributes': :'securityAttributes',
    'locks': :'locks',
    'requested_throughput': :'requestedThroughput'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'hostname_label': :'String',
    'ip_address': :'String',
    'subnet_id': :'String',
    'idmap_type': :'String',
    'ldap_idmap': :'OCI::FileStorage::Models::CreateLdapIdmapDetails',
    'nsg_ids': :'Array<String>',
    'kerberos': :'OCI::FileStorage::Models::CreateKerberosDetails',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'locks': :'Array<OCI::FileStorage::Models::ResourceLock>',
    'requested_throughput': :'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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 294

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 &&
    hostname_label == other.hostname_label &&
    ip_address == other.ip_address &&
    subnet_id == other.subnet_id &&
    idmap_type == other.idmap_type &&
    ldap_idmap == other.ldap_idmap &&
    nsg_ids == other.nsg_ids &&
    kerberos == other.kerberos &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    security_attributes == other.security_attributes &&
    locks == other.locks &&
    requested_throughput == other.requested_throughput
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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 338

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


318
319
320
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 318

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



327
328
329
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 327

def hash
  [availability_domain, compartment_id, display_name, hostname_label, ip_address, subnet_id, idmap_type, ldap_idmap, nsg_ids, kerberos, freeform_tags, defined_tags, security_attributes, locks, requested_throughput].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



371
372
373
374
375
376
377
378
379
380
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 371

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



365
366
367
 
# File 'lib/oci/file_storage/models/create_mount_target_details.rb', line 365

def to_s
  to_hash.to_s
end