Class: OCI::Core::Models::AttachVolumeDetails
- Inherits:
-
Object
- Object
- OCI::Core::Models::AttachVolumeDetails
- Defined in:
- lib/oci/core/models/attach_volume_details.rb
Overview
AttachVolumeDetails model. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Direct Known Subclasses
AttachIScsiVolumeDetails, AttachParavirtualizedVolumeDetails
Instance Attribute Summary collapse
-
#device ⇒ String
The device name.
-
#display_name ⇒ String
A user-friendly name.
-
#instance_id ⇒ String
[Required] The OCID of the instance.
-
#is_read_only ⇒ BOOLEAN
Whether the attachment was created in read-only mode.
-
#type ⇒ String
[Required] The type of volume.
-
#volume_id ⇒ String
[Required] The OCID of the volume.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
.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 = {}) ⇒ AttachVolumeDetails
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 = {}) ⇒ AttachVolumeDetails
Initializes the object
91 92 93 94 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 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 91 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.device = attributes[:'device'] if attributes[:'device'] 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.instance_id = attributes[:'instanceId'] if attributes[:'instanceId'] raise 'You cannot provide both :instanceId and :instance_id' if attributes.key?(:'instanceId') && attributes.key?(:'instance_id') self.instance_id = attributes[:'instance_id'] if attributes[:'instance_id'] self.is_read_only = attributes[:'isReadOnly'] unless attributes[:'isReadOnly'].nil? raise 'You cannot provide both :isReadOnly and :is_read_only' if attributes.key?(:'isReadOnly') && attributes.key?(:'is_read_only') self.is_read_only = attributes[:'is_read_only'] unless attributes[:'is_read_only'].nil? self.type = attributes[:'type'] if attributes[:'type'] self.volume_id = attributes[:'volumeId'] if attributes[:'volumeId'] raise 'You cannot provide both :volumeId and :volume_id' if attributes.key?(:'volumeId') && attributes.key?(:'volume_id') self.volume_id = attributes[:'volume_id'] if attributes[:'volume_id'] end |
Instance Attribute Details
#device ⇒ String
The device name.
12 13 14 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 12 def device @device end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.
17 18 19 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 17 def display_name @display_name end |
#instance_id ⇒ String
[Required] The OCID of the instance.
21 22 23 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 21 def instance_id @instance_id end |
#is_read_only ⇒ BOOLEAN
Whether the attachment was created in read-only mode.
25 26 27 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 25 def is_read_only @is_read_only end |
#type ⇒ String
[Required] The type of volume. The only supported value are "iscsi" and "paravirtualized".
29 30 31 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 29 def type @type end |
#volume_id ⇒ String
[Required] The OCID of the volume.
33 34 35 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 33 def volume_id @volume_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
36 37 38 39 40 41 42 43 44 45 46 47 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 36 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'device': :'device', 'display_name': :'displayName', 'instance_id': :'instanceId', 'is_read_only': :'isReadOnly', 'type': :'type', 'volume_id': :'volumeId' # rubocop:enable Style/SymbolLiteral } end |
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
68 69 70 71 72 73 74 75 76 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 68 def self.get_subtype(object_hash) type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral return 'OCI::Core::Models::AttachIScsiVolumeDetails' if type == 'iscsi' return 'OCI::Core::Models::AttachParavirtualizedVolumeDetails' if type == 'paravirtualized' # TODO: Log a warning when the subtype is not found. 'OCI::Core::Models::AttachVolumeDetails' end |
.swagger_types ⇒ Object
Attribute type mapping.
50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 50 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'device': :'String', 'display_name': :'String', 'instance_id': :'String', 'is_read_only': :'BOOLEAN', 'type': :'String', 'volume_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 133 def ==(other) return true if equal?(other) self.class == other.class && device == other.device && display_name == other.display_name && instance_id == other.instance_id && is_read_only == other.is_read_only && type == other.type && volume_id == other.volume_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 168 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
148 149 150 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 148 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
157 158 159 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 157 def hash [device, display_name, instance_id, is_read_only, type, volume_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
201 202 203 204 205 206 207 208 209 210 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 201 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
195 196 197 |
# File 'lib/oci/core/models/attach_volume_details.rb', line 195 def to_s to_hash.to_s end |