Class: OCI::FileStorage::Models::CreateFileSystemDetails

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

Overview

Details for creating the file system.

Constant Summary collapse

CLONE_ATTACH_STATUS_ENUM = 
[
  CLONE_ATTACH_STATUS_DETACH = 'DETACH'.freeze,
  CLONE_ATTACH_STATUS_ATTACH = 'ATTACH'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateFileSystemDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



139
140
141
142
143
144
145
146
147
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
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
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 139

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

  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_snapshot_id = attributes[:'sourceSnapshotId'] if attributes[:'sourceSnapshotId']

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

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

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

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

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

  self.are_quota_rules_enabled = attributes[:'areQuotaRulesEnabled'] unless attributes[:'areQuotaRulesEnabled'].nil?
  self.are_quota_rules_enabled = false if are_quota_rules_enabled.nil? && !attributes.key?(:'areQuotaRulesEnabled') # rubocop:disable Style/StringLiterals

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

  self.are_quota_rules_enabled = attributes[:'are_quota_rules_enabled'] unless attributes[:'are_quota_rules_enabled'].nil?
  self.are_quota_rules_enabled = false if are_quota_rules_enabled.nil? && !attributes.key?(:'areQuotaRulesEnabled') && !attributes.key?(:'are_quota_rules_enabled') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#are_quota_rules_enabled ⇒ BOOLEAN

Specifies the enforcement of quota rules on the file system.

Returns:

  • (BOOLEAN) 


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

def are_quota_rules_enabled
  @are_quota_rules_enabled
end

#availability_domain ⇒ String

[Required] The availability domain to create the file system in.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 21

def availability_domain
  @availability_domain
end

#clone_attach_status ⇒ String

Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.

Returns:

  • (String) 


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

def clone_attach_status
  @clone_attach_status
end

#compartment_id ⇒ String

[Required] The OCID of the compartment to create the file system in.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 25

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


48
49
50
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 48

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

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 33

def display_name
  @display_name
end

#filesystem_snapshot_policy_id ⇒ String

The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

May be unset as a blank value.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 78

def filesystem_snapshot_policy_id
  @filesystem_snapshot_policy_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>) 


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

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) 


57
58
59
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 57

def kms_key_id
  @kms_key_id
end

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

Locks associated with this resource.

Returns:



52
53
54
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 52

def locks
  @locks
end

#source_snapshot_id ⇒ String

The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

Returns:

  • (String) 


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

def source_snapshot_id
  @source_snapshot_id
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 85

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'locks': :'locks',
    'kms_key_id': :'kmsKeyId',
    'source_snapshot_id': :'sourceSnapshotId',
    'clone_attach_status': :'cloneAttachStatus',
    'filesystem_snapshot_policy_id': :'filesystemSnapshotPolicyId',
    'are_quota_rules_enabled': :'areQuotaRulesEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 104

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'locks': :'Array<OCI::FileStorage::Models::ResourceLock>',
    'kms_key_id': :'String',
    'source_snapshot_id': :'String',
    'clone_attach_status': :'String',
    'filesystem_snapshot_policy_id': :'String',
    'are_quota_rules_enabled': :'BOOLEAN'
    # 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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 225

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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    locks == other.locks &&
    kms_key_id == other.kms_key_id &&
    source_snapshot_id == other.source_snapshot_id &&
    clone_attach_status == other.clone_attach_status &&
    filesystem_snapshot_policy_id == other.filesystem_snapshot_policy_id &&
    are_quota_rules_enabled == other.are_quota_rules_enabled
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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 265

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


245
246
247
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 245

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



254
255
256
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 254

def hash
  [availability_domain, compartment_id, display_name, freeform_tags, defined_tags, locks, kms_key_id, source_snapshot_id, clone_attach_status, filesystem_snapshot_policy_id, are_quota_rules_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



298
299
300
301
302
303
304
305
306
307
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 298

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



292
293
294
 
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 292

def to_s
  to_hash.to_s
end