Class: OCI::Core::Models::UpdateInstanceShapeConfigDetails

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

Overview

The shape configuration requested for the instance. If provided, the instance will be updated with the resources specified. In the case where some properties are missing, the missing values will be set to the default for the provided shape.

Each shape only supports certain configurable values. If the shape is provided and the configuration values are invalid for that new shape, an error will be returned. If no shape is provided and the configuration values are invalid for the instance's existing shape, an error will be returned.

Constant Summary collapse

BASELINE_OCPU_UTILIZATION_ENUM = 
[
  BASELINE_OCPU_UTILIZATION_BASELINE_1_8 = 'BASELINE_1_8'.freeze,
  BASELINE_OCPU_UTILIZATION_BASELINE_1_2 = 'BASELINE_1_2'.freeze,
  BASELINE_OCPU_UTILIZATION_BASELINE_1_1 = 'BASELINE_1_1'.freeze
].freeze
RESOURCE_MANAGEMENT_ENUM = 
[
  RESOURCE_MANAGEMENT_DYNAMIC = 'DYNAMIC'.freeze,
  RESOURCE_MANAGEMENT_STATIC = 'STATIC'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateInstanceShapeConfigDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :ocpus (Float) —

    The value to assign to the #ocpus property

  • :vcpus (Integer) —

    The value to assign to the #vcpus property

  • :memory_in_gbs (Float) —

    The value to assign to the #memory_in_gbs property

  • :baseline_ocpu_utilization (String) —

    The value to assign to the #baseline_ocpu_utilization property

  • :nvmes (Integer) —

    The value to assign to the #nvmes property

  • :resource_management (String) —

    The value to assign to the #resource_management property

  • :local_volume_size_in_gbs (Integer) —

    The value to assign to the #local_volume_size_in_gbs property



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
151
152
153
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 118

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

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

  self.memory_in_gbs = attributes[:'memoryInGBs'] if attributes[:'memoryInGBs']

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

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

  self.baseline_ocpu_utilization = attributes[:'baselineOcpuUtilization'] if attributes[:'baselineOcpuUtilization']

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

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

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

  self.resource_management = attributes[:'resourceManagement'] if attributes[:'resourceManagement']

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

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

  self.local_volume_size_in_gbs = attributes[:'localVolumeSizeInGBs'] if attributes[:'localVolumeSizeInGBs']

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

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

Instance Attribute Details

#baseline_ocpu_utilization ⇒ String

The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.

The following values are supported: - BASELINE_1_8 - baseline usage is 1/8 of an OCPU. - BASELINE_1_2 - baseline usage is 1/2 of an OCPU. - BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 56

def baseline_ocpu_utilization
  @baseline_ocpu_utilization
end

#local_volume_size_in_gbs ⇒ Integer

The NVMe-backed local storage capacity, in GB, for flexible dense (DenseLV) VM shapes. If the selected shape is DenseLV, the value must be greater than 0. For all other shapes, the value must be null (if specified); any non-null value for a non-DenseLV shape results in an error.

Returns:

  • (Integer) 


73
74
75
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 73

def local_volume_size_in_gbs
  @local_volume_size_in_gbs
end

#memory_in_gbs ⇒ Float

The total amount of memory available to the instance, in gigabytes.

Returns:

  • (Float) 


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

def memory_in_gbs
  @memory_in_gbs
end

#nvmes ⇒ Integer

The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.

Returns:

  • (Integer) 


61
62
63
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 61

def nvmes
  @nvmes
end

#ocpus ⇒ Float

The total number of OCPUs available to the instance.

Returns:

  • (Float) 


33
34
35
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 33

def ocpus
  @ocpus
end

#resource_management ⇒ String

This field is reserved for internal use.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 66

def resource_management
  @resource_management
end

#vcpus ⇒ Integer

The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.

Returns:

  • (Integer) 


40
41
42
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 40

def vcpus
  @vcpus
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 76

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'ocpus': :'ocpus',
    'vcpus': :'vcpus',
    'memory_in_gbs': :'memoryInGBs',
    'baseline_ocpu_utilization': :'baselineOcpuUtilization',
    'nvmes': :'nvmes',
    'resource_management': :'resourceManagement',
    'local_volume_size_in_gbs': :'localVolumeSizeInGBs'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 91

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'ocpus': :'Float',
    'vcpus': :'Integer',
    'memory_in_gbs': :'Float',
    'baseline_ocpu_utilization': :'String',
    'nvmes': :'Integer',
    'resource_management': :'String',
    'local_volume_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



178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 178

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

  self.class == other.class &&
    ocpus == other.ocpus &&
    vcpus == other.vcpus &&
    memory_in_gbs == other.memory_in_gbs &&
    baseline_ocpu_utilization == other.baseline_ocpu_utilization &&
    nvmes == other.nvmes &&
    resource_management == other.resource_management &&
    local_volume_size_in_gbs == other.local_volume_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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 214

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


194
195
196
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 194

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



203
204
205
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 203

def hash
  [ocpus, vcpus, memory_in_gbs, baseline_ocpu_utilization, nvmes, resource_management, local_volume_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



247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 247

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



241
242
243
 
# File 'lib/oci/core/models/update_instance_shape_config_details.rb', line 241

def to_s
  to_hash.to_s
end