Class: OCI::Core::Models::IScsiVolumeAttachment

Inherits:
VolumeAttachment show all
Defined in:
lib/oci/core/models/i_scsi_volume_attachment.rb

Overview

An ISCSI volume attachment.

Constant Summary collapse

ENCRYPTION_IN_TRANSIT_TYPE_ENUM = 
[
  ENCRYPTION_IN_TRANSIT_TYPE_NONE = 'NONE'.freeze,
  ENCRYPTION_IN_TRANSIT_TYPE_BM_ENCRYPTION_IN_TRANSIT = 'BM_ENCRYPTION_IN_TRANSIT'.freeze,
  ENCRYPTION_IN_TRANSIT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from VolumeAttachment

VolumeAttachment::ISCSI_LOGIN_STATE_ENUM, VolumeAttachment::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from VolumeAttachment

#attachment_type, #availability_domain, #compartment_id, #device, #display_name, #id, #instance_id, #is_multipath, #is_pv_encryption_in_transit_enabled, #is_read_only, #is_shareable, #iscsi_login_state, #lifecycle_state, #time_created, #volume_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from VolumeAttachment

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ IScsiVolumeAttachment

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 proprety

  • :compartment_id (String) —

    The value to assign to the #compartment_id proprety

  • :device (String) —

    The value to assign to the #device proprety

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :id (String) —

    The value to assign to the #id proprety

  • :instance_id (String) —

    The value to assign to the #instance_id proprety

  • :is_read_only (BOOLEAN) —

    The value to assign to the #is_read_only proprety

  • :is_shareable (BOOLEAN) —

    The value to assign to the #is_shareable proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :volume_id (String) —

    The value to assign to the #volume_id proprety

  • :is_pv_encryption_in_transit_enabled (BOOLEAN) —

    The value to assign to the #is_pv_encryption_in_transit_enabled proprety

  • :is_multipath (BOOLEAN) —

    The value to assign to the #is_multipath proprety

  • :iscsi_login_state (String) —

    The value to assign to the #iscsi_login_state proprety

  • :chap_secret (String) —

    The value to assign to the #chap_secret property

  • :chap_username (String) —

    The value to assign to the #chap_username property

  • :ipv4 (String) —

    The value to assign to the #ipv4 property

  • :iqn (String) —

    The value to assign to the #iqn property

  • :port (Integer) —

    The value to assign to the #port property

  • :multipath_devices (Array<OCI::Core::Models::MultipathDevice>) —

    The value to assign to the #multipath_devices property

  • :encryption_in_transit_type (String) —

    The value to assign to the #encryption_in_transit_type property

  • :is_agent_auto_iscsi_login_enabled (BOOLEAN) —

    The value to assign to the #is_agent_auto_iscsi_login_enabled property



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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 161

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

  self. = attributes[:'isAgentAutoIscsiLoginEnabled'] unless attributes[:'isAgentAutoIscsiLoginEnabled'].nil?

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

  self. = attributes[:'is_agent_auto_iscsi_login_enabled'] unless attributes[:'is_agent_auto_iscsi_login_enabled'].nil?
end

Instance Attribute Details

#chap_secret ⇒ String

The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 24

def chap_secret
  @chap_secret
end

#chap_username ⇒ String

The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP.

Example: ocid1.volume.oc1.phx.<unique_ID>

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 32

def chap_username
  @chap_username
end

#encryption_in_transit_type ⇒ String

Refer the top-level definition of encryptionInTransitType. The default value is NONE.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 64

def encryption_in_transit_type
  @encryption_in_transit_type
end

#ipv4 ⇒ String

[Required] The volume's iSCSI IP address.

Example: 169.254.0.2

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 39

def ipv4
  @ipv4
end

#iqn ⇒ String

[Required] The target volume's iSCSI Qualified Name in the format defined by RFC 3720.

Example: iqn.2015-12.us.oracle.com:<CHAP_username>

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 47

def iqn
  @iqn
end

#is_agent_auto_iscsi_login_enabled ⇒ BOOLEAN

Whether Oracle Cloud Agent is enabled perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.

Returns:

  • (BOOLEAN) 


69
70
71
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 69

def 
  @is_agent_auto_iscsi_login_enabled
end

#multipath_devices ⇒ Array<OCI::Core::Models::MultipathDevice>

A list of secondary multipath devices

Returns:



58
59
60
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 58

def multipath_devices
  @multipath_devices
end

#port ⇒ Integer

[Required] The volume's iSCSI port, usually port 860 or 3260.

Example: 3260

Returns:

  • (Integer) 


54
55
56
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 54

def port
  @port
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 72

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',
    'is_agent_auto_iscsi_login_enabled': :'isAgentAutoIscsiLoginEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 103

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',
    'is_agent_auto_iscsi_login_enabled': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 230

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 &&
     == other. &&
    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 &&
     == other.
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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 282

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


262
263
264
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 262

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



271
272
273
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 271

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, , chap_secret, chap_username, ipv4, iqn, port, multipath_devices, encryption_in_transit_type, ].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 315

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



309
310
311
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 309

def to_s
  to_hash.to_s
end