Class: OCI::FileStorage::Models::ExportSet

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

Overview

A set of file systems to export through one or more mount targets. Composed of zero or more export resources.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_CREATING = 'CREATING',
LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
LIFECYCLE_STATE_DELETING = 'DELETING',
LIFECYCLE_STATE_DELETED = 'DELETED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExportSet

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

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :max_fs_stat_bytes (Integer) —

    The value to assign to the #max_fs_stat_bytes property

  • :max_fs_stat_files (Integer) —

    The value to assign to the #max_fs_stat_files property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :vcn_id (String) —

    The value to assign to the #vcn_id property



95
96
97
98
99
100
101
102
103
104
105
106
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
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
 
# File 'lib/oci/file_storage/models/export_set.rb', line 95

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}

  if attributes[:'availabilityDomain']
    self.availability_domain = attributes[:'availabilityDomain']
  end

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

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

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

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

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

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

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

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

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

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

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

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

  if attributes[:'maxFsStatBytes']
    self.max_fs_stat_bytes = attributes[:'maxFsStatBytes']
  end

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

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

  if attributes[:'maxFsStatFiles']
    self.max_fs_stat_files = attributes[:'maxFsStatFiles']
  end

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

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

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

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

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

  if attributes[:'vcnId']
    self.vcn_id = attributes[:'vcnId']
  end

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

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

end

Instance Attribute Details

#availability_domain ⇒ String

The availability domain the export set is in. May be unset as a blank or NULL value.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/file_storage/models/export_set.rb', line 23

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the export set.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/file_storage/models/export_set.rb', line 27

def compartment_id
  @compartment_id
end

#display_name ⇒ String

[Required] A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: ‘My export set`

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/file_storage/models/export_set.rb', line 35

def display_name
  @display_name
end

#id ⇒ String

[Required] The OCID of the export set.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/file_storage/models/export_set.rb', line 39

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the export set.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#max_fs_stat_bytes ⇒ Integer

Controls the maximum ‘tbytes`, `fbytes`, and `abytes`, values reported by `NFS FSSTAT` calls through any associated mount targets. This is an advanced feature. For most applications, use the default value. The `tbytes` value reported by `FSSTAT` will be `maxFsStatBytes`. The value of `fbytes` and `abytes` will be `maxFsStatBytes` minus the metered size of the file system. If the metered size is larger than `maxFsStatBytes`, then `fbytes` and `abytes` will both be ’0’.

Returns:

  • (Integer) 


56
57
58
 
# File 'lib/oci/file_storage/models/export_set.rb', line 56

def max_fs_stat_bytes
  @max_fs_stat_bytes
end

#max_fs_stat_files ⇒ Integer

Controls the maximum ‘ffiles`, `ffiles`, and `afiles` values reported by `NFS FSSTAT` calls through any associated mount targets. This is an advanced feature. For most applications, use the default value. The `tfiles` value reported by `FSSTAT` will be `maxFsStatFiles`. The value of `ffiles` and `afiles` will be `maxFsStatFiles` minus the metered size of the file system. If the metered size is larger than `maxFsStatFiles`, then `ffiles` and `afiles` will both be ’0’.

Returns:

  • (Integer) 


69
70
71
 
# File 'lib/oci/file_storage/models/export_set.rb', line 69

def max_fs_stat_files
  @max_fs_stat_files
end

#time_created ⇒ DateTime

[Required] The date and time the export set was created, expressed in [RFC 3339](tools.ietf.org/rfc/rfc3339) timestamp format.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#vcn_id ⇒ String

[Required] The OCID of the virtual cloud network (VCN) the export set is in.

Returns:

  • (String) 


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

def vcn_id
  @vcn_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/file_storage/models/export_set.rb', line 199

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      availability_domain == other_object.availability_domain &&
      compartment_id == other_object.compartment_id &&
      display_name == other_object.display_name &&
      id == other_object.id &&
      lifecycle_state == other_object.lifecycle_state &&
      max_fs_stat_bytes == other_object.max_fs_stat_bytes &&
      max_fs_stat_files == other_object.max_fs_stat_files &&
      time_created == other_object.time_created &&
      vcn_id == other_object.vcn_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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/file_storage/models/export_set.rb', line 228

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


215
216
217
 
# File 'lib/oci/file_storage/models/export_set.rb', line 215

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



221
222
223
 
# File 'lib/oci/file_storage/models/export_set.rb', line 221

def hash
  [availability_domain, compartment_id, display_name, id, lifecycle_state, max_fs_stat_bytes, max_fs_stat_files, time_created, vcn_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/file_storage/models/export_set.rb', line 253

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



247
248
249
 
# File 'lib/oci/file_storage/models/export_set.rb', line 247

def to_s
  to_hash.to_s
end