Class: OCI::Core::Models::AttachBootVolumeDetails

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

Overview

AttachBootVolumeDetails model.

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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AttachBootVolumeDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :boot_volume_id (String) —

    The value to assign to the #boot_volume_id 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

  • :encryption_in_transit_type (String) —

    The value to assign to the #encryption_in_transit_type property

[View source]

70
71
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
101
 
# File 'lib/oci/core/models/attach_boot_volume_details.rb', line 70

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

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

  self.boot_volume_id = attributes[:'boot_volume_id'] if attributes[:'boot_volume_id']

  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.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
end

Instance Attribute Details

#boot_volume_id ⇒ String

[Required] The OCID of the boot volume.

Returns:

  • (String) 

18
19
20
 
# File 'lib/oci/core/models/attach_boot_volume_details.rb', line 18

def boot_volume_id
  @boot_volume_id
end

#display_name ⇒ String

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

Returns:

  • (String) 

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

def display_name
  @display_name
end

#encryption_in_transit_type ⇒ String

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

Returns:

  • (String) 

34
35
36
 
# File 'lib/oci/core/models/attach_boot_volume_details.rb', line 34

def encryption_in_transit_type
  @encryption_in_transit_type
end

#instance_id ⇒ String

[Required] The OCID of the instance.

Returns:

  • (String) 

28
29
30
 
# File 'lib/oci/core/models/attach_boot_volume_details.rb', line 28

def instance_id
  @instance_id
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'boot_volume_id': :'bootVolumeId',
    'display_name': :'displayName',
    'instance_id': :'instanceId',
    'encryption_in_transit_type': :'encryptionInTransitType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/core/models/attach_boot_volume_details.rb', line 49

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

[View source]

118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/core/models/attach_boot_volume_details.rb', line 118

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

  self.class == other.class &&
    boot_volume_id == other.boot_volume_id &&
    display_name == other.display_name &&
    instance_id == other.instance_id &&
    encryption_in_transit_type == other.encryption_in_transit_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

[View source]

151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/core/models/attach_boot_volume_details.rb', line 151

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
[View source]

131
132
133
 
# File 'lib/oci/core/models/attach_boot_volume_details.rb', line 131

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

140
141
142
 
# File 'lib/oci/core/models/attach_boot_volume_details.rb', line 140

def hash
  [boot_volume_id, display_name, instance_id, 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

[View source]

184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/core/models/attach_boot_volume_details.rb', line 184

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

[View source]

178
179
180
 
# File 'lib/oci/core/models/attach_boot_volume_details.rb', line 178

def to_s
  to_hash.to_s
end