Class: OCI::Core::Models::AttachVolumeDetails

Inherits:
Object
  • Object
show all
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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AttachVolumeDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :device (String) —

    The value to assign to the #device property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :instance_id (String) —

    The value to assign to the #instance_id property

  • :is_read_only (BOOLEAN) —

    The value to assign to the #is_read_only property

  • :is_shareable (BOOLEAN) —

    The value to assign to the #is_shareable property

  • :type (String) —

    The value to assign to the #type property

  • :volume_id (String) —

    The value to assign to the #volume_id property



111
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
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 111

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.is_shareable = attributes[:'isShareable'] unless attributes[:'isShareable'].nil?

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

  self.is_shareable = attributes[:'is_shareable'] unless attributes[:'is_shareable'].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. To retrieve a list of devices for a given instance, see list_instance_devices.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 14

def device
  @device
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 20

def display_name
  @display_name
end

#instance_id ⇒ String

[Required] The OCID of the instance. For AttachVolume operation, this is a required field for the request, see attach_volume.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 26

def instance_id
  @instance_id
end

#is_read_only ⇒ BOOLEAN

Whether the attachment was created in read-only mode.

Returns:

  • (BOOLEAN) 


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

def is_read_only
  @is_read_only
end

#is_shareable ⇒ BOOLEAN

Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.

Returns:

  • (BOOLEAN) 


38
39
40
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 38

def is_shareable
  @is_shareable
end

#type ⇒ String

[Required] The type of volume. The only supported values are "iscsi" and "paravirtualized".

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 43

def type
  @type
end

#volume_id ⇒ String

[Required] The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 48

def volume_id
  @volume_id
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'device': :'device',
    'display_name': :'displayName',
    'instance_id': :'instanceId',
    'is_read_only': :'isReadOnly',
    'is_shareable': :'isShareable',
    '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.



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 85

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Core::Models::AttachServiceDeterminedVolumeDetails' if type == 'service_determined'
  return 'OCI::Core::Models::AttachEmulatedVolumeDetails' if type == 'emulated'
  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.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 66

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'device': :'String',
    'display_name': :'String',
    'instance_id': :'String',
    'is_read_only': :'BOOLEAN',
    'is_shareable': :'BOOLEAN',
    'type': :'String',
    'volume_id': :'String'
    # 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



159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 159

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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 195

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


175
176
177
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 175

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



184
185
186
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 184

def hash
  [device, display_name, instance_id, is_read_only, is_shareable, type, volume_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 228

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



222
223
224
 
# File 'lib/oci/core/models/attach_volume_details.rb', line 222

def to_s
  to_hash.to_s
end