Class: OCI::LustreFileStorage::Models::UpdateLustreFileSystemDetails

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

Overview

The data to update a Lustre file system.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateLustreFileSystemDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 107

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

Instance Attribute Details

#capacity_in_gbs ⇒ Integer

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

Returns:

  • (Integer) 


56
57
58
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 56

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


39
40
41
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 39

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) 


17
18
19
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 17

def display_name
  @display_name
end

#file_system_description ⇒ String

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

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 23

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


31
32
33
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 31

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) 


52
53
54
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 52

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


47
48
49
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 47

def nsg_ids
  @nsg_ids
end

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

Returns:



59
60
61
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 59

def root_squash_configuration
  @root_squash_configuration
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'file_system_description': :'fileSystemDescription',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'nsg_ids': :'nsgIds',
    'kms_key_id': :'kmsKeyId',
    'capacity_in_gbs': :'capacityInGBs',
    'root_squash_configuration': :'rootSquashConfiguration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 78

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



169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 169

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

  self.class == other.class &&
    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 &&
    kms_key_id == other.kms_key_id &&
    capacity_in_gbs == other.capacity_in_gbs &&
    root_squash_configuration == other.root_squash_configuration
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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 206

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


186
187
188
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 186

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



195
196
197
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 195

def hash
  [display_name, file_system_description, freeform_tags, defined_tags, nsg_ids, kms_key_id, capacity_in_gbs, root_squash_configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



239
240
241
242
243
244
245
246
247
248
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 239

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



233
234
235
 
# File 'lib/oci/lustre_file_storage/models/update_lustre_file_system_details.rb', line 233

def to_s
  to_hash.to_s
end