Class: OCI::Core::Models::UpdateInstanceDetails

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

Overview

UpdateInstanceDetails model.

Constant Summary collapse

UPDATE_OPERATION_CONSTRAINT_ENUM = 
[
  UPDATE_OPERATION_CONSTRAINT_ALLOW_DOWNTIME = 'ALLOW_DOWNTIME'.freeze,
  UPDATE_OPERATION_CONSTRAINT_AVOID_DOWNTIME = 'AVOID_DOWNTIME'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateInstanceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/oci/core/models/update_instance_details.rb', line 240

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.is_ai_enterprise_enabled = attributes[:'isAIEnterpriseEnabled'] unless attributes[:'isAIEnterpriseEnabled'].nil?
  self.is_ai_enterprise_enabled = false if is_ai_enterprise_enabled.nil? && !attributes.key?(:'isAIEnterpriseEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_ai_enterprise_enabled = attributes[:'is_ai_enterprise_enabled'] unless attributes[:'is_ai_enterprise_enabled'].nil?
  self.is_ai_enterprise_enabled = false if is_ai_enterprise_enabled.nil? && !attributes.key?(:'isAIEnterpriseEnabled') && !attributes.key?(:'is_ai_enterprise_enabled') # rubocop:disable Style/StringLiterals

  self.capacity_reservation_id = attributes[:'capacityReservationId'] if attributes[:'capacityReservationId']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

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

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

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

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

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

  self.agent_config = attributes[:'agentConfig'] if attributes[:'agentConfig']

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

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

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

  self.shape_config = attributes[:'shapeConfig'] if attributes[:'shapeConfig']

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

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

  self.source_details = attributes[:'sourceDetails'] if attributes[:'sourceDetails']

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

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

  self.update_operation_constraint = attributes[:'updateOperationConstraint'] if attributes[:'updateOperationConstraint']

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

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

  self.instance_options = attributes[:'instanceOptions'] if attributes[:'instanceOptions']

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

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

  self.fault_domain = attributes[:'faultDomain'] if attributes[:'faultDomain']

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

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

  self.launch_options = attributes[:'launchOptions'] if attributes[:'launchOptions']

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

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

  self.availability_config = attributes[:'availabilityConfig'] if attributes[:'availabilityConfig']

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

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

  self.time_maintenance_reboot_due = attributes[:'timeMaintenanceRebootDue'] if attributes[:'timeMaintenanceRebootDue']

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

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

  self.dedicated_vm_host_id = attributes[:'dedicatedVmHostId'] if attributes[:'dedicatedVmHostId']

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

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

  self.platform_config = attributes[:'platformConfig'] if attributes[:'platformConfig']

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

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

  self.licensing_configs = attributes[:'licensingConfigs'] if attributes[:'licensingConfigs']

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

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

Instance Attribute Details

#agent_config ⇒ OCI::Core::Models::UpdateInstanceAgentConfigDetails

Returns:



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

def agent_config
  @agent_config
end

#availability_config ⇒ OCI::Core::Models::UpdateInstanceAvailabilityConfigDetails

Returns:



123
124
125
 
# File 'lib/oci/core/models/update_instance_details.rb', line 123

def availability_config
  @availability_config
end

#capacity_reservation_id ⇒ String

The OCID of the compute capacity reservation this instance is launched under. You can remove the instance from a reservation by specifying an empty string as input for this field. For more information, see Capacity Reservations.

Returns:

  • (String) 


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

def capacity_reservation_id
  @capacity_reservation_id
end

#dedicated_vm_host_id ⇒ String

The OCID of the dedicated virtual machine host to place the instance on. Supported only if this VM instance was already placed on a dedicated virtual machine host - that is, you can't move an instance from on-demand capacity to dedicated capacity, nor can you move an instance from dedicated capacity to on-demand capacity.

Returns:

  • (String) 


152
153
154
 
# File 'lib/oci/core/models/update_instance_details.rb', line 152

def dedicated_vm_host_id
  @dedicated_vm_host_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


34
35
36
 
# File 'lib/oci/core/models/update_instance_details.rb', line 34

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#fault_domain ⇒ String

A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.

To get a list of fault domains, use the list_fault_domains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

Returns:

  • (String) 


117
118
119
 
# File 'lib/oci/core/models/update_instance_details.rb', line 117

def fault_domain
  @fault_domain
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#instance_options ⇒ OCI::Core::Models::InstanceOptions

Returns:



102
103
104
 
# File 'lib/oci/core/models/update_instance_details.rb', line 102

def instance_options
  @instance_options
end

#is_ai_enterprise_enabled ⇒ BOOLEAN

Whether to enable AI enterprise on the instance.

Returns:

  • (BOOLEAN) 


19
20
21
 
# File 'lib/oci/core/models/update_instance_details.rb', line 19

def is_ai_enterprise_enabled
  @is_ai_enterprise_enabled
end

#launch_options ⇒ OCI::Core::Models::UpdateLaunchOptions

Returns:



120
121
122
 
# File 'lib/oci/core/models/update_instance_details.rb', line 120

def launch_options
  @launch_options
end

#licensing_configs ⇒ Array<OCI::Core::Models::UpdateInstanceLicensingConfig>

The list of liscensing configurations with target update values.

Returns:



159
160
161
 
# File 'lib/oci/core/models/update_instance_details.rb', line 159

def licensing_configs
  @licensing_configs
end

#platform_config ⇒ OCI::Core::Models::UpdateInstancePlatformConfig

Returns:



155
156
157
 
# File 'lib/oci/core/models/update_instance_details.rb', line 155

def platform_config
  @platform_config
end

#security_attributes ⇒ Hash<String, Hash<String, Object>>

Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.

Example: {\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


43
44
45
 
# File 'lib/oci/core/models/update_instance_details.rb', line 43

def security_attributes
  @security_attributes
end

#shape ⇒ String

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. For more information about how to change shapes, and a list of shapes that are supported, see Editing an Instance.

For details about the CPUs, memory, and other properties of each shape, see Compute Shapes.

The new shape must be compatible with the image that was used to launch the instance. You can enumerate all available shapes and determine image compatibility by calling list_shapes.

To determine whether capacity is available for a specific shape before you change the shape of an instance, use the create_compute_capacity_report operation.

If the instance is running when you change the shape, the instance is rebooted.

Example: VM.Standard2.1

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/core/models/update_instance_details.rb', line 83

def shape
  @shape
end

#shape_config ⇒ OCI::Core::Models::UpdateInstanceShapeConfigDetails

Returns:



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

def shape_config
  @shape_config
end

#source_details ⇒ OCI::Core::Models::UpdateInstanceSourceDetails

Returns:



89
90
91
 
# File 'lib/oci/core/models/update_instance_details.rb', line 89

def source_details
  @source_details
end

#time_maintenance_reboot_due ⇒ DateTime

For a VM instance, resets the scheduled time that the instance will be reboot migrated for infrastructure maintenance, in the format defined by RFC3339. If the instance hasn't been rebooted after this date, Oracle reboots the instance within 24 hours of the time and date that maintenance is due.

To get the maximum possible date that a maintenance reboot can be extended, use get_instance_maintenance_reboot.

Regardless of how the instance is stopped, this flag is reset to empty as soon as the instance reaches the Stopped state.

To reboot migrate a bare metal instance, use the instance_action operation.

For more information, see Infrastructure Maintenance.

Example: 2018-05-25T21:10:29.600Z

Returns:

  • (DateTime) 


144
145
146
 
# File 'lib/oci/core/models/update_instance_details.rb', line 144

def time_maintenance_reboot_due
  @time_maintenance_reboot_due
end

#update_operation_constraint ⇒ String

The parameter acts as a fail-safe to prevent unwanted downtime when updating a running instance. The default is ALLOW_DOWNTIME. * ALLOW_DOWNTIME - Compute might reboot the instance while updating the instance if a reboot is required. * AVOID_DOWNTIME - If the instance is in running state, Compute tries to update the instance without rebooting it. If the instance requires a reboot to be updated, an error is returned and the instance is not updated. If the instance is stopped, it is updated and remains in the stopped state.

Returns:

  • (String) 


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

def update_operation_constraint
  @update_operation_constraint
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/core/models/update_instance_details.rb', line 162

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_ai_enterprise_enabled': :'isAIEnterpriseEnabled',
    'capacity_reservation_id': :'capacityReservationId',
    'defined_tags': :'definedTags',
    'security_attributes': :'securityAttributes',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'agent_config': :'agentConfig',
    'shape': :'shape',
    'shape_config': :'shapeConfig',
    'source_details': :'sourceDetails',
    'update_operation_constraint': :'updateOperationConstraint',
    'instance_options': :'instanceOptions',
    'fault_domain': :'faultDomain',
    'launch_options': :'launchOptions',
    'availability_config': :'availabilityConfig',
    'time_maintenance_reboot_due': :'timeMaintenanceRebootDue',
    'dedicated_vm_host_id': :'dedicatedVmHostId',
    'platform_config': :'platformConfig',
    'licensing_configs': :'licensingConfigs'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/core/models/update_instance_details.rb', line 189

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_ai_enterprise_enabled': :'BOOLEAN',
    'capacity_reservation_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'agent_config': :'OCI::Core::Models::UpdateInstanceAgentConfigDetails',
    'shape': :'String',
    'shape_config': :'OCI::Core::Models::UpdateInstanceShapeConfigDetails',
    'source_details': :'OCI::Core::Models::UpdateInstanceSourceDetails',
    'update_operation_constraint': :'String',
    'instance_options': :'OCI::Core::Models::InstanceOptions',
    'fault_domain': :'String',
    'launch_options': :'OCI::Core::Models::UpdateLaunchOptions',
    'availability_config': :'OCI::Core::Models::UpdateInstanceAvailabilityConfigDetails',
    'time_maintenance_reboot_due': :'DateTime',
    'dedicated_vm_host_id': :'String',
    'platform_config': :'OCI::Core::Models::UpdateInstancePlatformConfig',
    'licensing_configs': :'Array<OCI::Core::Models::UpdateInstanceLicensingConfig>'
    # 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



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/oci/core/models/update_instance_details.rb', line 374

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

  self.class == other.class &&
    is_ai_enterprise_enabled == other.is_ai_enterprise_enabled &&
    capacity_reservation_id == other.capacity_reservation_id &&
    defined_tags == other.defined_tags &&
    security_attributes == other.security_attributes &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    agent_config == other.agent_config &&
    shape == other.shape &&
    shape_config == other.shape_config &&
    source_details == other.source_details &&
    update_operation_constraint == other.update_operation_constraint &&
    instance_options == other.instance_options &&
    fault_domain == other.fault_domain &&
    launch_options == other.launch_options &&
    availability_config == other.availability_config &&
    time_maintenance_reboot_due == other.time_maintenance_reboot_due &&
    dedicated_vm_host_id == other.dedicated_vm_host_id &&
    platform_config == other.platform_config &&
    licensing_configs == other.licensing_configs
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



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/oci/core/models/update_instance_details.rb', line 422

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


402
403
404
 
# File 'lib/oci/core/models/update_instance_details.rb', line 402

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



411
412
413
 
# File 'lib/oci/core/models/update_instance_details.rb', line 411

def hash
  [is_ai_enterprise_enabled, capacity_reservation_id, defined_tags, security_attributes, display_name, freeform_tags, agent_config, shape, shape_config, source_details, update_operation_constraint, instance_options, fault_domain, launch_options, availability_config, time_maintenance_reboot_due, dedicated_vm_host_id, platform_config, licensing_configs].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



455
456
457
458
459
460
461
462
463
464
 
# File 'lib/oci/core/models/update_instance_details.rb', line 455

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



449
450
451
 
# File 'lib/oci/core/models/update_instance_details.rb', line 449

def to_s
  to_hash.to_s
end