Class: OCI::Core::Models::Shape

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

Overview

A compute instance shape that can be used in launch_instance. For more information, see [Overview of the Compute Service](docs.cloud.oracle.com/Content/Compute/Concepts/computeoverview.htm).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Shape

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



150
151
152
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/core/models/shape.rb', line 150

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

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

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

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

  self.memory_options = attributes[:'memoryOptions'] if attributes[:'memoryOptions']

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

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

  self.networking_bandwidth_options = attributes[:'networkingBandwidthOptions'] if attributes[:'networkingBandwidthOptions']

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

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

  self.max_vnic_attachment_options = attributes[:'maxVnicAttachmentOptions'] if attributes[:'maxVnicAttachmentOptions']

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

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

Instance Attribute Details

#gpu_description ⇒ String

A short description of the GPUs available to instances of this shape. This field is ‘null` if `gpus` is `0`.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/core/models/shape.rb', line 52

def gpu_description
  @gpu_description
end

#gpus ⇒ Integer

The number of GPUs available to an instance of this shape.

Returns:

  • (Integer) 


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

def gpus
  @gpus
end

#local_disk_description ⇒ String

A short description of the local disks available to instances of this shape. This field is ‘null` if `localDisks` is equal to `0`.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/core/models/shape.rb', line 69

def local_disk_description
  @local_disk_description
end

#local_disks ⇒ Integer

The number of local disks available to the instance.

Returns:

  • (Integer) 


57
58
59
 
# File 'lib/oci/core/models/shape.rb', line 57

def local_disks
  @local_disks
end

#local_disks_total_size_in_gbs ⇒ Float

The size of the local disks, aggregated, in gigabytes. This field is ‘null` if `localDisks` is equal to `0`.

Returns:

  • (Float) 


63
64
65
 
# File 'lib/oci/core/models/shape.rb', line 63

def local_disks_total_size_in_gbs
  @local_disks_total_size_in_gbs
end

#max_vnic_attachment_options ⇒ OCI::Core::Models::ShapeMaxVnicAttachmentOptions

Returns:



81
82
83
 
# File 'lib/oci/core/models/shape.rb', line 81

def max_vnic_attachment_options
  @max_vnic_attachment_options
end

#max_vnic_attachments ⇒ Integer

The maximum number of VNIC attachments available to an instance of this shape.

Returns:

  • (Integer) 


41
42
43
 
# File 'lib/oci/core/models/shape.rb', line 41

def max_vnic_attachments
  @max_vnic_attachments
end

#memory_in_gbs ⇒ Float

The default amount of memory, in gigabytes, available to an instance of this shape.

Returns:

  • (Float) 


31
32
33
 
# File 'lib/oci/core/models/shape.rb', line 31

def memory_in_gbs
  @memory_in_gbs
end

#memory_options ⇒ OCI::Core::Models::ShapeMemoryOptions

Returns:



75
76
77
 
# File 'lib/oci/core/models/shape.rb', line 75

def memory_options
  @memory_options
end

#networking_bandwidth_in_gbps ⇒ Float

The networking bandwidth, in gigabits per second, available to an instance of this shape.

Returns:

  • (Float) 


36
37
38
 
# File 'lib/oci/core/models/shape.rb', line 36

def networking_bandwidth_in_gbps
  @networking_bandwidth_in_gbps
end

#networking_bandwidth_options ⇒ OCI::Core::Models::ShapeNetworkingBandwidthOptions

Returns:



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

def networking_bandwidth_options
  @networking_bandwidth_options
end

#ocpu_options ⇒ OCI::Core::Models::ShapeOcpuOptions

Returns:



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

def ocpu_options
  @ocpu_options
end

#ocpus ⇒ Float

The default number of OCPUs available to an instance of this shape.

Returns:

  • (Float) 


26
27
28
 
# File 'lib/oci/core/models/shape.rb', line 26

def ocpus
  @ocpus
end

#processor_description ⇒ String

A short description of the processors available to an instance of this shape.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/core/models/shape.rb', line 21

def processor_description
  @processor_description
end

#shape ⇒ String

[Required] The name of the shape. You can enumerate all available shapes by calling list_shapes.

Returns:

  • (String) 


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

def shape
  @shape
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/core/models/shape.rb', line 84

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'shape': :'shape',
    'processor_description': :'processorDescription',
    'ocpus': :'ocpus',
    'memory_in_gbs': :'memoryInGBs',
    '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',
    'ocpu_options': :'ocpuOptions',
    'memory_options': :'memoryOptions',
    'networking_bandwidth_options': :'networkingBandwidthOptions',
    'max_vnic_attachment_options': :'maxVnicAttachmentOptions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/core/models/shape.rb', line 107

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'shape': :'String',
    'processor_description': :'String',
    'ocpus': :'Float',
    'memory_in_gbs': :'Float',
    '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',
    'ocpu_options': :'OCI::Core::Models::ShapeOcpuOptions',
    'memory_options': :'OCI::Core::Models::ShapeMemoryOptions',
    'networking_bandwidth_options': :'OCI::Core::Models::ShapeNetworkingBandwidthOptions',
    'max_vnic_attachment_options': :'OCI::Core::Models::ShapeMaxVnicAttachmentOptions'
    # 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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/core/models/shape.rb', line 242

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

  self.class == other.class &&
    shape == other.shape &&
    processor_description == other.processor_description &&
    ocpus == other.ocpus &&
    memory_in_gbs == other.memory_in_gbs &&
    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 &&
    ocpu_options == other.ocpu_options &&
    memory_options == other.memory_options &&
    networking_bandwidth_options == other.networking_bandwidth_options &&
    max_vnic_attachment_options == other.max_vnic_attachment_options
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



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

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


266
267
268
 
# File 'lib/oci/core/models/shape.rb', line 266

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



275
276
277
 
# File 'lib/oci/core/models/shape.rb', line 275

def hash
  [shape, processor_description, ocpus, memory_in_gbs, networking_bandwidth_in_gbps, max_vnic_attachments, gpus, gpu_description, local_disks, local_disks_total_size_in_gbs, local_disk_description, ocpu_options, memory_options, networking_bandwidth_options, max_vnic_attachment_options].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



319
320
321
322
323
324
325
326
327
328
 
# File 'lib/oci/core/models/shape.rb', line 319

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



313
314
315
 
# File 'lib/oci/core/models/shape.rb', line 313

def to_s
  to_hash.to_s
end