class OCI::Core::Models::IScsiVolumeAttachment
An ISCSI volume attachment.
Constants
- ENCRYPTION_IN_TRANSIT_TYPE_ENUM
Attributes
The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)
@return [String]
The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See [RFC 1994](tools.ietf.org/html/rfc1994) for more on CHAP.
Example: `ocid1.volume.oc1.phx.<unique_ID>`
@return [String]
Refer the top-level definition of encryptionInTransitType. The default value is NONE.
@return [String]
[Required] The volume's iSCSI IP address.
Example: `169.254.0.2`
@return [String]
[Required] The target volume's iSCSI Qualified Name in the format defined by [RFC 3720](tools.ietf.org/html/rfc3720#page-32).
Example: `iqn.2015-12.us.oracle.com:<CHAP_username>`
@return [String]
A list of secondary multipath devices @return [Array<OCI::Core::Models::MultipathDevice>]
[Required] The volume's iSCSI port, usually port 860 or 3260.
Example: `3260`
@return [Integer]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/core/models/i_scsi_volume_attachment.rb, line 66 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'attachment_type': :'attachmentType', 'availability_domain': :'availabilityDomain', 'compartment_id': :'compartmentId', 'device': :'device', 'display_name': :'displayName', 'id': :'id', 'instance_id': :'instanceId', 'is_read_only': :'isReadOnly', 'is_shareable': :'isShareable', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'volume_id': :'volumeId', 'is_pv_encryption_in_transit_enabled': :'isPvEncryptionInTransitEnabled', 'is_multipath': :'isMultipath', 'iscsi_login_state': :'iscsiLoginState', 'chap_secret': :'chapSecret', 'chap_username': :'chapUsername', 'ipv4': :'ipv4', 'iqn': :'iqn', 'port': :'port', 'multipath_devices': :'multipathDevices', 'encryption_in_transit_type': :'encryptionInTransitType' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :availability_domain The value to assign to the {OCI::Core::Models::VolumeAttachment#availability_domain availability_domain
} proprety @option attributes [String] :compartment_id The value to assign to the {OCI::Core::Models::VolumeAttachment#compartment_id compartment_id
} proprety @option attributes [String] :device The value to assign to the {OCI::Core::Models::VolumeAttachment#device device
} proprety @option attributes [String] :display_name The value to assign to the {OCI::Core::Models::VolumeAttachment#display_name display_name
} proprety @option attributes [String] :id The value to assign to the {OCI::Core::Models::VolumeAttachment#id id
} proprety @option attributes [String] :instance_id The value to assign to the {OCI::Core::Models::VolumeAttachment#instance_id instance_id
} proprety @option attributes [BOOLEAN] :is_read_only The value to assign to the {OCI::Core::Models::VolumeAttachment#is_read_only is_read_only
} proprety @option attributes [BOOLEAN] :is_shareable The value to assign to the {OCI::Core::Models::VolumeAttachment#is_shareable is_shareable
} proprety @option attributes [String] :lifecycle_state The value to assign to the {OCI::Core::Models::VolumeAttachment#lifecycle_state lifecycle_state
} proprety @option attributes [DateTime] :time_created The value to assign to the {OCI::Core::Models::VolumeAttachment#time_created time_created
} proprety @option attributes [String] :volume_id The value to assign to the {OCI::Core::Models::VolumeAttachment#volume_id volume_id
} proprety @option attributes [BOOLEAN] :is_pv_encryption_in_transit_enabled The value to assign to the {OCI::Core::Models::VolumeAttachment#is_pv_encryption_in_transit_enabled is_pv_encryption_in_transit_enabled
} proprety @option attributes [BOOLEAN] :is_multipath The value to assign to the {OCI::Core::Models::VolumeAttachment#is_multipath is_multipath
} proprety @option attributes [String] :iscsi_login_state The value to assign to the {OCI::Core::Models::VolumeAttachment#iscsi_login_state iscsi_login_state
} proprety @option attributes [String] :chap_secret The value to assign to the {#chap_secret} property @option attributes [String] :chap_username The value to assign to the {#chap_username} property @option attributes [String] :ipv4 The value to assign to the {#ipv4} property @option attributes [String] :iqn The value to assign to the {#iqn} property @option attributes [Integer] :port The value to assign to the {#port} property @option attributes [Array<OCI::Core::Models::MultipathDevice>] :multipath_devices The value to assign to the {#multipath_devices} property @option attributes [String] :encryption_in_transit_type The value to assign to the {#encryption_in_transit_type} property
OCI::Core::Models::VolumeAttachment::new
# File lib/oci/core/models/i_scsi_volume_attachment.rb, line 152 def initialize(attributes = {}) return unless attributes.is_a?(Hash) attributes['attachmentType'] = 'iscsi' super(attributes) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.chap_secret = attributes[:'chapSecret'] if attributes[:'chapSecret'] raise 'You cannot provide both :chapSecret and :chap_secret' if attributes.key?(:'chapSecret') && attributes.key?(:'chap_secret') self.chap_secret = attributes[:'chap_secret'] if attributes[:'chap_secret'] self.chap_username = attributes[:'chapUsername'] if attributes[:'chapUsername'] raise 'You cannot provide both :chapUsername and :chap_username' if attributes.key?(:'chapUsername') && attributes.key?(:'chap_username') self.chap_username = attributes[:'chap_username'] if attributes[:'chap_username'] self.ipv4 = attributes[:'ipv4'] if attributes[:'ipv4'] self.iqn = attributes[:'iqn'] if attributes[:'iqn'] self.port = attributes[:'port'] if attributes[:'port'] self.multipath_devices = attributes[:'multipathDevices'] if attributes[:'multipathDevices'] raise 'You cannot provide both :multipathDevices and :multipath_devices' if attributes.key?(:'multipathDevices') && attributes.key?(:'multipath_devices') self.multipath_devices = attributes[:'multipath_devices'] if attributes[:'multipath_devices'] self.encryption_in_transit_type = attributes[:'encryptionInTransitType'] if attributes[:'encryptionInTransitType'] self.encryption_in_transit_type = "NONE" if encryption_in_transit_type.nil? && !attributes.key?(:'encryptionInTransitType') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :encryptionInTransitType and :encryption_in_transit_type' if attributes.key?(:'encryptionInTransitType') && attributes.key?(:'encryption_in_transit_type') self.encryption_in_transit_type = attributes[:'encryption_in_transit_type'] if attributes[:'encryption_in_transit_type'] self.encryption_in_transit_type = "NONE" if encryption_in_transit_type.nil? && !attributes.key?(:'encryptionInTransitType') && !attributes.key?(:'encryption_in_transit_type') # rubocop:disable Style/StringLiterals end
Attribute type mapping.
# File lib/oci/core/models/i_scsi_volume_attachment.rb, line 96 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'attachment_type': :'String', 'availability_domain': :'String', 'compartment_id': :'String', 'device': :'String', 'display_name': :'String', 'id': :'String', 'instance_id': :'String', 'is_read_only': :'BOOLEAN', 'is_shareable': :'BOOLEAN', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'volume_id': :'String', 'is_pv_encryption_in_transit_enabled': :'BOOLEAN', 'is_multipath': :'BOOLEAN', 'iscsi_login_state': :'String', 'chap_secret': :'String', 'chap_username': :'String', 'ipv4': :'String', 'iqn': :'String', 'port': :'Integer', 'multipath_devices': :'Array<OCI::Core::Models::MultipathDevice>', 'encryption_in_transit_type': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/core/models/i_scsi_volume_attachment.rb, line 215 def ==(other) return true if equal?(other) self.class == other.class && attachment_type == other.attachment_type && availability_domain == other.availability_domain && compartment_id == other.compartment_id && device == other.device && display_name == other.display_name && id == other.id && instance_id == other.instance_id && is_read_only == other.is_read_only && is_shareable == other.is_shareable && lifecycle_state == other.lifecycle_state && time_created == other.time_created && volume_id == other.volume_id && is_pv_encryption_in_transit_enabled == other.is_pv_encryption_in_transit_enabled && is_multipath == other.is_multipath && iscsi_login_state == other.iscsi_login_state && chap_secret == other.chap_secret && chap_username == other.chap_username && ipv4 == other.ipv4 && iqn == other.iqn && port == other.port && multipath_devices == other.multipath_devices && encryption_in_transit_type == other.encryption_in_transit_type end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/core/models/i_scsi_volume_attachment.rb, line 266 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
Custom attribute writer method checking allowed values (enum). @param [Object] encryption_in_transit_type
Object
to be assigned
# File lib/oci/core/models/i_scsi_volume_attachment.rb, line 199 def encryption_in_transit_type=(encryption_in_transit_type) # rubocop:disable Style/ConditionalAssignment if encryption_in_transit_type && !ENCRYPTION_IN_TRANSIT_TYPE_ENUM.include?(encryption_in_transit_type) OCI.logger.debug("Unknown value for 'encryption_in_transit_type' [" + encryption_in_transit_type + "]. Mapping to 'ENCRYPTION_IN_TRANSIT_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @encryption_in_transit_type = ENCRYPTION_IN_TRANSIT_TYPE_UNKNOWN_ENUM_VALUE else @encryption_in_transit_type = encryption_in_transit_type end # rubocop:enable Style/ConditionalAssignment end
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/core/models/i_scsi_volume_attachment.rb, line 246 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/core/models/i_scsi_volume_attachment.rb, line 255 def hash [attachment_type, availability_domain, compartment_id, device, display_name, id, instance_id, is_read_only, is_shareable, lifecycle_state, time_created, volume_id, is_pv_encryption_in_transit_enabled, is_multipath, iscsi_login_state, chap_secret, chap_username, ipv4, iqn, port, multipath_devices, encryption_in_transit_type].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/core/models/i_scsi_volume_attachment.rb, line 299 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/core/models/i_scsi_volume_attachment.rb, line 293 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/core/models/i_scsi_volume_attachment.rb, line 316 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end