Class: OCI::Core::Models::InstanceConfigurationAttachVolumeDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/instance_configuration_attach_volume_details.rb

Overview

Volume attachmentDetails. Please see AttachVolumeDetails

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 = {}) ⇒ InstanceConfigurationAttachVolumeDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String)

    The value to assign to the #display_name property

  • :is_read_only (BOOLEAN)

    The value to assign to the #is_read_only property

  • :type (String)

    The value to assign to the #type property



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

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.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.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.type = attributes[:'type'] if attributes[:'type']
end

Instance Attribute Details

#display_nameString

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

Returns:

  • (String)


15
16
17
# File 'lib/oci/core/models/instance_configuration_attach_volume_details.rb', line 15

def display_name
  @display_name
end

#is_read_onlyBOOLEAN

Whether the attachment should be created in read-only mode.

Returns:

  • (BOOLEAN)


19
20
21
# File 'lib/oci/core/models/instance_configuration_attach_volume_details.rb', line 19

def is_read_only
  @is_read_only
end

#typeString

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

Returns:

  • (String)


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

def type
  @type
end

Class Method Details

.attribute_mapObject

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



26
27
28
29
30
31
32
33
34
# File 'lib/oci/core/models/instance_configuration_attach_volume_details.rb', line 26

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



52
53
54
55
56
57
58
59
60
# File 'lib/oci/core/models/instance_configuration_attach_volume_details.rb', line 52

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

  return 'OCI::Core::Models::InstanceConfigurationIscsiAttachVolumeDetails' if type == 'iscsi'
  return 'OCI::Core::Models::InstanceConfigurationParavirtualizedAttachVolumeDetails' if type == 'paravirtualized'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Core::Models::InstanceConfigurationAttachVolumeDetails'
end

.swagger_typesObject

Attribute type mapping.



37
38
39
40
41
42
43
44
45
# File 'lib/oci/core/models/instance_configuration_attach_volume_details.rb', line 37

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



100
101
102
103
104
105
106
107
# File 'lib/oci/core/models/instance_configuration_attach_volume_details.rb', line 100

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    display_name == other.display_name &&
    is_read_only == other.is_read_only &&
    type == other.type
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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/oci/core/models/instance_configuration_attach_volume_details.rb', line 132

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


112
113
114
# File 'lib/oci/core/models/instance_configuration_attach_volume_details.rb', line 112

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



121
122
123
# File 'lib/oci/core/models/instance_configuration_attach_volume_details.rb', line 121

def hash
  [display_name, is_read_only, type].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



165
166
167
168
169
170
171
172
173
174
# File 'lib/oci/core/models/instance_configuration_attach_volume_details.rb', line 165

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



159
160
161
# File 'lib/oci/core/models/instance_configuration_attach_volume_details.rb', line 159

def to_s
  to_hash.to_s
end