Class: OCI::FileStorage::Models::FileSystem
- Inherits:
-
Object
- Object
- OCI::FileStorage::Models::FileSystem
- Defined in:
- lib/oci/file_storage/models/file_system.rb
Overview
An NFS file system. To allow access to a file system, add it to an export set and associate the export set with a mount target. The same file system can be in multiple export sets and associated with multiple mount targets.
To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
rubocop:disable Metrics/LineLength
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#availability_domain ⇒ String
The availability domain the file system is in.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the file system.
-
#display_name ⇒ String
[Required] A user-friendly name.
-
#id ⇒ String
[Required] The OCID of the file system.
-
#lifecycle_state ⇒ String
[Required] The current state of the file system.
-
#metered_bytes ⇒ Integer
[Required] The number of bytes consumed by the file system, including any snapshots.
-
#time_created ⇒ DateTime
[Required] The date and time the file system was created, expressed in [RFC 3339](tools.ietf.org/rfc/rfc3339) timestamp format.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ FileSystem
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ FileSystem
Initializes the object
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 |
# File 'lib/oci/file_storage/models/file_system.rb', line 115 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.metered_bytes = attributes[:'meteredBytes'] if attributes[:'meteredBytes'] raise 'You cannot provide both :meteredBytes and :metered_bytes' if attributes.key?(:'meteredBytes') && attributes.key?(:'metered_bytes') self.metered_bytes = attributes[:'metered_bytes'] if attributes[:'metered_bytes'] 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.id = attributes[:'id'] if attributes[:'id'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] end |
Instance Attribute Details
#availability_domain ⇒ String
The availability domain the file system is in. May be unset as a blank or NULL value.
Example: ‘Uocm:PHX-AD-1`
34 35 36 |
# File 'lib/oci/file_storage/models/file_system.rb', line 34 def availability_domain @availability_domain end |
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the file system.
46 47 48 |
# File 'lib/oci/file_storage/models/file_system.rb', line 46 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 file system`
54 55 56 |
# File 'lib/oci/file_storage/models/file_system.rb', line 54 def display_name @display_name end |
#id ⇒ String
[Required] The OCID of the file system.
58 59 60 |
# File 'lib/oci/file_storage/models/file_system.rb', line 58 def id @id end |
#lifecycle_state ⇒ String
[Required] The current state of the file system.
62 63 64 |
# File 'lib/oci/file_storage/models/file_system.rb', line 62 def lifecycle_state @lifecycle_state end |
#metered_bytes ⇒ Integer
[Required] The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system.
42 43 44 |
# File 'lib/oci/file_storage/models/file_system.rb', line 42 def metered_bytes @metered_bytes end |
#time_created ⇒ DateTime
[Required] The date and time the file system was created, expressed in [RFC 3339](tools.ietf.org/rfc/rfc3339) timestamp format.
Example: ‘2016-08-25T21:10:29.600Z`
70 71 72 |
# File 'lib/oci/file_storage/models/file_system.rb', line 70 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/oci/file_storage/models/file_system.rb', line 73 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'availability_domain': :'availabilityDomain', 'metered_bytes': :'meteredBytes', 'compartment_id': :'compartmentId', 'display_name': :'displayName', 'id': :'id', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/oci/file_storage/models/file_system.rb', line 88 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'availability_domain': :'String', 'metered_bytes': :'Integer', 'compartment_id': :'String', 'display_name': :'String', 'id': :'String', 'lifecycle_state': :'String', 'time_created': :'DateTime' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/oci/file_storage/models/file_system.rb', line 182 def ==(other) return true if equal?(other) self.class == other.class && availability_domain == other.availability_domain && metered_bytes == other.metered_bytes && compartment_id == other.compartment_id && display_name == other.display_name && id == other.id && lifecycle_state == other.lifecycle_state && time_created == other.time_created end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/oci/file_storage/models/file_system.rb', line 217 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
197 198 199 |
# File 'lib/oci/file_storage/models/file_system.rb', line 197 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
206 207 208 |
# File 'lib/oci/file_storage/models/file_system.rb', line 206 def hash [availability_domain, metered_bytes, compartment_id, display_name, id, lifecycle_state, time_created].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
249 250 251 252 253 254 255 256 257 |
# File 'lib/oci/file_storage/models/file_system.rb', line 249 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
243 244 245 |
# File 'lib/oci/file_storage/models/file_system.rb', line 243 def to_s to_hash.to_s end |