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.

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

  • :availability_domain (String)

    The value to assign to the #availability_domain property

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :display_name (String)

    The value to assign to the #display_name property

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property

  • :kms_key_id (String)

    The value to assign to the #kms_key_id property

  • :source_snapshot_id (String)

    The value to assign to the #source_snapshot_id property

  • :filesystem_snapshot_policy_id (String)

    The value to assign to the #filesystem_snapshot_policy_id property



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
161
162
163
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 110

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

Instance Attribute Details

#availability_domainString

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

Example: Uocm:PHX-AD-1

Returns:

  • (String)


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

def availability_domain
  @availability_domain
end

#compartment_idString

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

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

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


43
44
45
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 43

def defined_tags
  @defined_tags
end

#display_nameString

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)


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

def display_name
  @display_name
end

#filesystem_snapshot_policy_idString

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)


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

def filesystem_snapshot_policy_id
  @filesystem_snapshot_policy_id
end

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


36
37
38
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 36

def freeform_tags
  @freeform_tags
end

#kms_key_idString

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

Returns:

  • (String)


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

def kms_key_id
  @kms_key_id
end

#source_snapshot_idString

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

Returns:

  • (String)


54
55
56
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 54

def source_snapshot_id
  @source_snapshot_id
end

Class Method Details

.attribute_mapObject

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 65

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

.swagger_typesObject

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 81

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>>',
    'kms_key_id': :'String',
    'source_snapshot_id': :'String',
    'filesystem_snapshot_policy_id': :'String'
    # 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



172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 172

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 &&
    kms_key_id == other.kms_key_id &&
    source_snapshot_id == other.source_snapshot_id &&
    filesystem_snapshot_policy_id == other.filesystem_snapshot_policy_id
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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 209

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


189
190
191
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 189

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



198
199
200
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 198

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



242
243
244
245
246
247
248
249
250
251
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 242

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



236
237
238
# File 'lib/oci/file_storage/models/create_file_system_details.rb', line 236

def to_s
  to_hash.to_s
end