class OCI::Core::Models::AttachVolumeDetails

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

Attributes

device[RW]

The device name. @return [String]

display_name[RW]

A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.

@return [String]

instance_id[RW]

[Required] The OCID of the instance. @return [String]

is_read_only[RW]

Whether the attachment was created in read-only mode. @return [BOOLEAN]

is_shareable[RW]

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.

@return [BOOLEAN]

type[RW]

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

@return [String]

volume_id[RW]

[Required] The OCID of the volume. @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/core/models/attach_volume_details.rb, line 46
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) click to toggle source

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

# File lib/oci/core/models/attach_volume_details.rb, line 80
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :device The value to assign to the {#device} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :instance_id The value to assign to the {#instance_id} property @option attributes [BOOLEAN] :is_read_only The value to assign to the {#is_read_only} property @option attributes [BOOLEAN] :is_shareable The value to assign to the {#is_shareable} property @option attributes [String] :type The value to assign to the {#type} property @option attributes [String] :volume_id The value to assign to the {#volume_id} property

# File lib/oci/core/models/attach_volume_details.rb, line 106
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/core/models/attach_volume_details.rb, line 61
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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/core/models/attach_volume_details.rb, line 154
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) click to toggle source

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/attach_volume_details.rb, line 190
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/core/models/attach_volume_details.rb, line 170
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/core/models/attach_volume_details.rb, line 179
def hash
  [device, display_name, instance_id, is_read_only, is_shareable, type, volume_id].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/core/models/attach_volume_details.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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/core/models/attach_volume_details.rb, line 217
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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/attach_volume_details.rb, line 240
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