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

Constants inherited from VolumeAttachment

VolumeAttachment::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from VolumeAttachment

#attachment_type, #availability_domain, #compartment_id, #display_name, #id, #instance_id, #is_read_only, #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

  • :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

  • :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

  • :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



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

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']
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".)

Example: ‘d6866c0d-298b-48ba-95af-309b4faux45e`

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 16

def chap_secret
  @chap_secret
end

#chap_username ⇒ String

The volume’s system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name.

Example: ‘ocid1.volume.oc1.phx.abyhqljrgvttnlx73nmrwfaux7kcvzfs3s66izvxf2h4lgvyndsdsnoiwr5q`

Returns:

  • (String) 


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

def chap_username
  @chap_username
end

#ipv4 ⇒ String

[Required] The volume’s iSCSI IP address.

Example: ‘169.254.0.2`

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 30

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:456b0391-17b8-4122-bbf1-f85fc0bb97d9`

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 37

def iqn
  @iqn
end

#port ⇒ Integer

[Required] The volume’s iSCSI port.

Example: ‘3260`

Returns:

  • (Integer) 


44
45
46
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 44

def port
  @port
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 47

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'attachment_type': :'attachmentType',
    'availability_domain': :'availabilityDomain',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'id': :'id',
    'instance_id': :'instanceId',
    'is_read_only': :'isReadOnly',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'volume_id': :'volumeId',
    'chap_secret': :'chapSecret',
    'chap_username': :'chapUsername',
    'ipv4': :'ipv4',
    'iqn': :'iqn',
    'port': :'port'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 70

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'attachment_type': :'String',
    'availability_domain': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'id': :'String',
    'instance_id': :'String',
    'is_read_only': :'BOOLEAN',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'volume_id': :'String',
    'chap_secret': :'String',
    'chap_username': :'String',
    'ipv4': :'String',
    'iqn': :'String',
    'port': :'Integer'
    # 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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 148

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 &&
    display_name == other.display_name &&
    id == other.id &&
    instance_id == other.instance_id &&
    is_read_only == other.is_read_only &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    volume_id == other.volume_id &&
    chap_secret == other.chap_secret &&
    chap_username == other.chap_username &&
    ipv4 == other.ipv4 &&
    iqn == other.iqn &&
    port == other.port
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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 191

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


171
172
173
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 171

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



180
181
182
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 180

def hash
  [attachment_type, availability_domain, compartment_id, display_name, id, instance_id, is_read_only, lifecycle_state, time_created, volume_id, chap_secret, chap_username, ipv4, iqn, port].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 223

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



217
218
219
 
# File 'lib/oci/core/models/i_scsi_volume_attachment.rb', line 217

def to_s
  to_hash.to_s
end