Class: OCI::FileStorage::Models::FileSystemSummary
- Inherits:
-
Object
- Object
- OCI::FileStorage::Models::FileSystemSummary
- Defined in:
- lib/oci/file_storage/models/file_system_summary.rb
Overview
Summary information for a file system.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ 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.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#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 = {}) ⇒ FileSystemSummary
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 = {}) ⇒ FileSystemSummary
Initializes the object
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 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 127 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'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] 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`
25 26 27 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 25 def availability_domain @availability_domain end |
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the file system.
37 38 39 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 37 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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: ‘{"CostCenter": "42"}`
76 77 78 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 76 def @defined_tags 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`
45 46 47 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 45 def display_name @display_name 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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: ‘"Finance"`
69 70 71 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 69 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the file system.
49 50 51 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 49 def id @id end |
#lifecycle_state ⇒ String
[Required] The current state of the file system.
53 54 55 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 53 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.
33 34 35 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 33 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`
61 62 63 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 61 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 79 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', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 96 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', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 204 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 && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 242 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
222 223 224 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 222 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
231 232 233 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 231 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
275 276 277 278 279 280 281 282 283 284 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 275 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
269 270 271 |
# File 'lib/oci/file_storage/models/file_system_summary.rb', line 269 def to_s to_hash.to_s end |