Class: OCI::LustreFileStorage::Models::CreateLustreFileSystemDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb

Overview

The details to create a Lustre file system.

Constant Summary collapse

PERFORMANCE_TIER_ENUM = 
[
  PERFORMANCE_TIER_MBPS_PER_TB_125 = 'MBPS_PER_TB_125'.freeze,
  PERFORMANCE_TIER_MBPS_PER_TB_250 = 'MBPS_PER_TB_250'.freeze,
  PERFORMANCE_TIER_MBPS_PER_TB_500 = 'MBPS_PER_TB_500'.freeze,
  PERFORMANCE_TIER_MBPS_PER_TB_1000 = 'MBPS_PER_TB_1000'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateLustreFileSystemDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



170
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
196
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
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 170

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

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

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

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

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

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

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

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

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

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

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

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

  self.cluster_placement_group_id = attributes[:'clusterPlacementGroupId'] if attributes[:'clusterPlacementGroupId']

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

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

  self.root_squash_configuration = attributes[:'rootSquashConfiguration'] if attributes[:'rootSquashConfiguration']

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

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

  self.maintenance_window = attributes[:'maintenanceWindow'] if attributes[:'maintenanceWindow']

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

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

Instance Attribute Details

#availability_domain ⇒ String

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

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 28

def availability_domain
  @availability_domain
end

#capacity_in_gbs ⇒ Integer

[Required] Capacity of the Lustre file system in GB. You can increase capacity only in multiples of 5 TB.

Returns:

  • (Integer) 


82
83
84
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 82

def capacity_in_gbs
  @capacity_in_gbs
end

#cluster_placement_group_id ⇒ String

The OCID of the cluster placement group in which the Lustre file system exists.

Returns:

  • (String) 


94
95
96
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 94

def cluster_placement_group_id
  @cluster_placement_group_id
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_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>>) 


58
59
60
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 58

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 Lustre file system

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 36

def display_name
  @display_name
end

#file_system_description ⇒ String

Short description of the Lustre file system. Avoid entering confidential information.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 42

def file_system_description
  @file_system_description
end

#file_system_name ⇒ String

[Required] The Lustre file system name. This is used in mount commands and other aspects of the client command line interface. The file system name is limited to 8 characters. Allowed characters are lower and upper case English letters, numbers, and '_'. If you have multiple Lustre file systems mounted on the same clients, this name can help distinguish them.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 73

def file_system_name
  @file_system_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>) 


50
51
52
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 50

def freeform_tags
  @freeform_tags
end

#kms_key_id ⇒ String

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

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 78

def kms_key_id
  @kms_key_id
end

#maintenance_window ⇒ OCI::LustreFileStorage::Models::MaintenanceWindow

Returns:



101
102
103
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 101

def maintenance_window
  @maintenance_window
end

#nsg_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) 


66
67
68
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 66

def nsg_ids
  @nsg_ids
end

#performance_tier ⇒ String

[Required] The Lustre file system performance tier. A value of MBPS_PER_TB_125 represents 125 megabytes per second per terabyte.

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 90

def performance_tier
  @performance_tier
end

#root_squash_configuration ⇒ OCI::LustreFileStorage::Models::RootSquashConfiguration

This attribute is required.

Returns:



98
99
100
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 98

def root_squash_configuration
  @root_squash_configuration
end

#subnet_id ⇒ String

[Required] The OCID of the subnet the Lustre file system is in.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 86

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 104

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'availability_domain': :'availabilityDomain',
    'display_name': :'displayName',
    'file_system_description': :'fileSystemDescription',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'nsg_ids': :'nsgIds',
    'file_system_name': :'fileSystemName',
    'kms_key_id': :'kmsKeyId',
    'capacity_in_gbs': :'capacityInGBs',
    'subnet_id': :'subnetId',
    'performance_tier': :'performanceTier',
    'cluster_placement_group_id': :'clusterPlacementGroupId',
    'root_squash_configuration': :'rootSquashConfiguration',
    'maintenance_window': :'maintenanceWindow'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'availability_domain': :'String',
    'display_name': :'String',
    'file_system_description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'nsg_ids': :'Array<String>',
    'file_system_name': :'String',
    'kms_key_id': :'String',
    'capacity_in_gbs': :'Integer',
    'subnet_id': :'String',
    'performance_tier': :'String',
    'cluster_placement_group_id': :'String',
    'root_squash_configuration': :'OCI::LustreFileStorage::Models::RootSquashConfiguration',
    'maintenance_window': :'OCI::LustreFileStorage::Models::MaintenanceWindow'
    # 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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 282

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    availability_domain == other.availability_domain &&
    display_name == other.display_name &&
    file_system_description == other.file_system_description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    nsg_ids == other.nsg_ids &&
    file_system_name == other.file_system_name &&
    kms_key_id == other.kms_key_id &&
    capacity_in_gbs == other.capacity_in_gbs &&
    subnet_id == other.subnet_id &&
    performance_tier == other.performance_tier &&
    cluster_placement_group_id == other.cluster_placement_group_id &&
    root_squash_configuration == other.root_squash_configuration &&
    maintenance_window == other.maintenance_window
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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 326

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


306
307
308
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 306

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



315
316
317
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 315

def hash
  [compartment_id, availability_domain, display_name, file_system_description, freeform_tags, defined_tags, nsg_ids, file_system_name, kms_key_id, capacity_in_gbs, subnet_id, performance_tier, cluster_placement_group_id, root_squash_configuration, maintenance_window].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



359
360
361
362
363
364
365
366
367
368
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 359

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



353
354
355
 
# File 'lib/oci/lustre_file_storage/models/create_lustre_file_system_details.rb', line 353

def to_s
  to_hash.to_s
end