Class: OCI::Core::Models::LaunchCreateVolumeFromAttributes

Inherits:
LaunchCreateVolumeDetails show all
Defined in:
lib/oci/core/models/launch_create_volume_from_attributes.rb

Overview

The details of the volume to create for CreateVolume operation.

Constant Summary

Constants inherited from LaunchCreateVolumeDetails

OCI::Core::Models::LaunchCreateVolumeDetails::VOLUME_CREATION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from LaunchCreateVolumeDetails

#volume_creation_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from LaunchCreateVolumeDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ LaunchCreateVolumeFromAttributes

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :kms_key_id (String) —

    The value to assign to the #kms_key_id property

  • :vpus_per_gb (Integer) —

    The value to assign to the #vpus_per_gb property

  • :size_in_gbs (Integer) —

    The value to assign to the #size_in_gbs property



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/core/models/launch_create_volume_from_attributes.rb', line 90

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['volumeCreationType'] = 'ATTRIBUTES'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_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.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId']

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

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

  self.vpus_per_gb = attributes[:'vpusPerGB'] if attributes[:'vpusPerGB']

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

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

  self.size_in_gbs = attributes[:'sizeInGBs'] if attributes[:'sizeInGBs']

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

  self.size_in_gbs = attributes[:'size_in_gbs'] if attributes[:'size_in_gbs']
end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment that contains the volume. If not provided, it will be inherited from the instance.

Returns:

  • (String) 


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

def compartment_id
  @compartment_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) 


22
23
24
 
# File 'lib/oci/core/models/launch_create_volume_from_attributes.rb', line 22

def display_name
  @display_name
end

#kms_key_id ⇒ String

The OCID of the Vault service key to assign as the master encryption key for the volume.

Returns:

  • (String) 


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

def kms_key_id
  @kms_key_id
end

#size_in_gbs ⇒ Integer

[Required] The size of the volume in GBs.

Returns:

  • (Integer) 


49
50
51
 
# File 'lib/oci/core/models/launch_create_volume_from_attributes.rb', line 49

def size_in_gbs
  @size_in_gbs
end

#vpus_per_gb ⇒ Integer

The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

Allowed values:

  • 0: Represents Lower Cost option.

  • 10: Represents Balanced option.

  • 20: Represents Higher Performance option.

  • 30-120: Represents the Ultra High Performance option.

Returns:

  • (Integer) 


45
46
47
 
# File 'lib/oci/core/models/launch_create_volume_from_attributes.rb', line 45

def vpus_per_gb
  @vpus_per_gb
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'volume_creation_type': :'volumeCreationType',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'kms_key_id': :'kmsKeyId',
    'vpus_per_gb': :'vpusPerGB',
    'size_in_gbs': :'sizeInGBs'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'volume_creation_type': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'kms_key_id': :'String',
    'vpus_per_gb': :'Integer',
    'size_in_gbs': :'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



138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/core/models/launch_create_volume_from_attributes.rb', line 138

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

  self.class == other.class &&
    volume_creation_type == other.volume_creation_type &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    kms_key_id == other.kms_key_id &&
    vpus_per_gb == other.vpus_per_gb &&
    size_in_gbs == other.size_in_gbs
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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/core/models/launch_create_volume_from_attributes.rb', line 173

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


153
154
155
 
# File 'lib/oci/core/models/launch_create_volume_from_attributes.rb', line 153

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



162
163
164
 
# File 'lib/oci/core/models/launch_create_volume_from_attributes.rb', line 162

def hash
  [volume_creation_type, compartment_id, display_name, kms_key_id, vpus_per_gb, size_in_gbs].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/core/models/launch_create_volume_from_attributes.rb', line 206

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



200
201
202
 
# File 'lib/oci/core/models/launch_create_volume_from_attributes.rb', line 200

def to_s
  to_hash.to_s
end