Class: OCI::Core::Models::InstanceShapeConfig

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

Overview

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

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,
  BASELINE_OCPU_UTILIZATION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
RESOURCE_MANAGEMENT_ENUM = 
[
  RESOURCE_MANAGEMENT_DYNAMIC = 'DYNAMIC'.freeze,
  RESOURCE_MANAGEMENT_STATIC = 'STATIC'.freeze,
  RESOURCE_MANAGEMENT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstanceShapeConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 176

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

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

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

  self.networking_bandwidth_in_gbps = attributes[:'networkingBandwidthInGbps'] if attributes[:'networkingBandwidthInGbps']

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

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

  self.max_vnic_attachments = attributes[:'maxVnicAttachments'] if attributes[:'maxVnicAttachments']

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

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

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

  self.gpu_description = attributes[:'gpuDescription'] if attributes[:'gpuDescription']

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

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

  self.local_disks = attributes[:'localDisks'] if attributes[:'localDisks']

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

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

  self.local_disks_total_size_in_gbs = attributes[:'localDisksTotalSizeInGBs'] if attributes[:'localDisksTotalSizeInGBs']

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

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

  self.local_disk_description = attributes[:'localDiskDescription'] if attributes[:'localDiskDescription']

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

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

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

  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 the entire OCPU. This represents a non-burstable instance.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 46

def baseline_ocpu_utilization
  @baseline_ocpu_utilization
end

#gpu_description ⇒ String

A short description of the instance's graphics processing unit (GPU).

If the instance does not have any GPUs, this field is null.

Returns:

  • (String) 


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

def gpu_description
  @gpu_description
end

#gpus ⇒ Integer

The number of GPUs available to the instance.

Returns:

  • (Integer) 


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

def gpus
  @gpus
end

#local_disk_description ⇒ String

A short description of the local disks available to this instance.

If the instance does not have any local disks, this field is null.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 92

def local_disk_description
  @local_disk_description
end

#local_disks ⇒ Integer

The number of local disks available to the instance.

Returns:

  • (Integer) 


78
79
80
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 78

def local_disks
  @local_disks
end

#local_disks_total_size_in_gbs ⇒ Float

The aggregate size of all local disks, in gigabytes.

If the instance does not have any local disks, this field is null.

Returns:

  • (Float) 


85
86
87
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 85

def local_disks_total_size_in_gbs
  @local_disks_total_size_in_gbs
end

#local_volume_size_in_gbs ⇒ Integer

The NVMe-backed local storage capacity, in GB, for flexible dense (DenseLV) VM shapes. If the shape is DenseLV, the value will be greater than 0. For all other shapes, the value will be null.

Returns:

  • (Integer) 


110
111
112
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 110

def local_volume_size_in_gbs
  @local_volume_size_in_gbs
end

#max_vnic_attachments ⇒ Integer

The maximum number of VNIC attachments for the instance.

Returns:

  • (Integer) 


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

def max_vnic_attachments
  @max_vnic_attachments
end

#memory_in_gbs ⇒ Float

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

Returns:

  • (Float) 


35
36
37
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 35

def memory_in_gbs
  @memory_in_gbs
end

#networking_bandwidth_in_gbps ⇒ Float

The networking bandwidth available to the instance, in gigabits per second.

Returns:

  • (Float) 


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

def networking_bandwidth_in_gbps
  @networking_bandwidth_in_gbps
end

#ocpus ⇒ Float

The total number of OCPUs available to the instance.

Returns:

  • (Float) 


30
31
32
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 30

def ocpus
  @ocpus
end

#processor_description ⇒ String

A short description of the instance's processor (CPU).

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 51

def processor_description
  @processor_description
end

#resource_management ⇒ String

This field is reserved for internal use.

Returns:

  • (String) 


104
105
106
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 104

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) 


99
100
101
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 99

def vcpus
  @vcpus
end

Class Method Details

.attribute_map ⇒ Object

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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 113

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'ocpus': :'ocpus',
    'memory_in_gbs': :'memoryInGBs',
    'baseline_ocpu_utilization': :'baselineOcpuUtilization',
    'processor_description': :'processorDescription',
    'networking_bandwidth_in_gbps': :'networkingBandwidthInGbps',
    'max_vnic_attachments': :'maxVnicAttachments',
    'gpus': :'gpus',
    'gpu_description': :'gpuDescription',
    'local_disks': :'localDisks',
    'local_disks_total_size_in_gbs': :'localDisksTotalSizeInGBs',
    'local_disk_description': :'localDiskDescription',
    'vcpus': :'vcpus',
    'resource_management': :'resourceManagement',
    'local_volume_size_in_gbs': :'localVolumeSizeInGBs'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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_shape_config.rb', line 135

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'ocpus': :'Float',
    'memory_in_gbs': :'Float',
    'baseline_ocpu_utilization': :'String',
    'processor_description': :'String',
    'networking_bandwidth_in_gbps': :'Float',
    'max_vnic_attachments': :'Integer',
    'gpus': :'Integer',
    'gpu_description': :'String',
    'local_disks': :'Integer',
    'local_disks_total_size_in_gbs': :'Float',
    'local_disk_description': :'String',
    'vcpus': :'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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 288

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

  self.class == other.class &&
    ocpus == other.ocpus &&
    memory_in_gbs == other.memory_in_gbs &&
    baseline_ocpu_utilization == other.baseline_ocpu_utilization &&
    processor_description == other.processor_description &&
    networking_bandwidth_in_gbps == other.networking_bandwidth_in_gbps &&
    max_vnic_attachments == other.max_vnic_attachments &&
    gpus == other.gpus &&
    gpu_description == other.gpu_description &&
    local_disks == other.local_disks &&
    local_disks_total_size_in_gbs == other.local_disks_total_size_in_gbs &&
    local_disk_description == other.local_disk_description &&
    vcpus == other.vcpus &&
    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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 331

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


311
312
313
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 311

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



320
321
322
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 320

def hash
  [ocpus, memory_in_gbs, baseline_ocpu_utilization, processor_description, networking_bandwidth_in_gbps, max_vnic_attachments, gpus, gpu_description, local_disks, local_disks_total_size_in_gbs, local_disk_description, vcpus, 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



364
365
366
367
368
369
370
371
372
373
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 364

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



358
359
360
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 358

def to_s
  to_hash.to_s
end