Class: OCI::Core::Models::InstanceConfiguration

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

Overview

An instance configuration is a template that defines the settings to use when creating Compute instances. An instance configuration is a template that defines the settings to use when creating Compute instances or GPU Memory Clusters. For more information about instance configurations, see Managing Compute Instances.

Constant Summary collapse

SOURCE_ENUM = 
[
  SOURCE_INSTANCE = 'INSTANCE'.freeze,
  SOURCE_GMC = 'GMC'.freeze,
  SOURCE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstanceConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



136
137
138
139
140
141
142
143
144
145
146
147
148
149
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
 
# File 'lib/oci/core/models/instance_configuration.rb', line 136

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

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

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_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.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.id = attributes[:'id'] if attributes[:'id']

  self.instance_details = attributes[:'instanceDetails'] if attributes[:'instanceDetails']

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

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

  self.gmc_configs = attributes[:'gmcConfigs'] if attributes[:'gmcConfigs']

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

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

  self.source = attributes[:'source'] if attributes[:'source']
  self.source = "INSTANCE" if source.nil? && !attributes.key?(:'source') # rubocop:disable Style/StringLiterals

  self.deferred_fields = attributes[:'deferredFields'] if attributes[:'deferredFields']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the instance configuration.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/core/models/instance_configuration.rb', line 27

def compartment_id
  @compartment_id
end

#deferred_fields ⇒ Array<String>

Parameters that were not specified when the instance configuration was created, but that are required to launch an instance from the instance configuration. See the launch_instance_configuration operation.

Returns:

  • (Array<String>) 


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

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


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

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) 


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

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


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

def freeform_tags
  @freeform_tags
end

#gmc_configs ⇒ Array<OCI::Core::Models::InstanceConfigurationGmcConfigDetail>

The GPU Memory Cluster configuration entries for.

Returns:



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

def gmc_configs
  @gmc_configs
end

#id ⇒ String

[Required] The OCID of the instance configuration.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/core/models/instance_configuration.rb', line 53

def id
  @id
end

#instance_details ⇒ OCI::Core::Models::InstanceConfigurationInstanceDetails

Returns:



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

def instance_details
  @instance_details
end

#source ⇒ String

Differentiator for instance configuration. Following values are supported: * INSTANCE : All details related to instance will be passed within instanceDetails. * GMC : All details related to gpu memory cluster will be passed within gmcConfigs.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/core/models/instance_configuration.rb', line 68

def source
  @source
end

#time_created ⇒ DateTime

[Required] The date and time the instance configuration was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


82
83
84
 
# File 'lib/oci/core/models/instance_configuration.rb', line 82

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'instance_details': :'instanceDetails',
    'gmc_configs': :'gmcConfigs',
    'source': :'source',
    'deferred_fields': :'deferredFields',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/core/models/instance_configuration.rb', line 103

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'instance_details': :'OCI::Core::Models::InstanceConfigurationInstanceDetails',
    'gmc_configs': :'Array<OCI::Core::Models::InstanceConfigurationGmcConfigDetail>',
    'source': :'String',
    'deferred_fields': :'Array<String>',
    'time_created': :'DateTime'
    # 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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/core/models/instance_configuration.rb', line 216

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    instance_details == other.instance_details &&
    gmc_configs == other.gmc_configs &&
    source == other.source &&
    deferred_fields == other.deferred_fields &&
    time_created == other.time_created
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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/core/models/instance_configuration.rb', line 255

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


235
236
237
 
# File 'lib/oci/core/models/instance_configuration.rb', line 235

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



244
245
246
 
# File 'lib/oci/core/models/instance_configuration.rb', line 244

def hash
  [compartment_id, defined_tags, display_name, freeform_tags, id, instance_details, gmc_configs, source, deferred_fields, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/core/models/instance_configuration.rb', line 288

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



282
283
284
 
# File 'lib/oci/core/models/instance_configuration.rb', line 282

def to_s
  to_hash.to_s
end