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

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):



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
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
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 153

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']
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) 


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

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) 


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

def gpu_description
  @gpu_description
end

#gpus ⇒ Integer

The number of GPUs available to the instance.

Returns:

  • (Integer) 


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

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) 


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

def local_disk_description
  @local_disk_description
end

#local_disks ⇒ Integer

The number of local disks available to the instance.

Returns:

  • (Integer) 


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

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) 


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

def local_disks_total_size_in_gbs
  @local_disks_total_size_in_gbs
end

#max_vnic_attachments ⇒ Integer

The maximum number of VNIC attachments for the instance.

Returns:

  • (Integer) 


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

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) 


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

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) 


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

def networking_bandwidth_in_gbps
  @networking_bandwidth_in_gbps
end

#ocpus ⇒ Float

The total number of OCPUs available to the instance.

Returns:

  • (Float) 


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

def ocpus
  @ocpus
end

#processor_description ⇒ String

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

Returns:

  • (String) 


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

def processor_description
  @processor_description
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) 


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

def vcpus
  @vcpus
end

Class Method Details

.attribute_map ⇒ Object

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 96

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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'
    # 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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 240

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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 281

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


261
262
263
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 261

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



270
271
272
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 270

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



314
315
316
317
318
319
320
321
322
323
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 314

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



308
309
310
 
# File 'lib/oci/core/models/instance_shape_config.rb', line 308

def to_s
  to_hash.to_s
end