Class: OCI::Core::Models::ComputeGpuMemoryCluster

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

Overview

The customer facing object includes GPU Memory Cluster details.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ComputeGpuMemoryCluster

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/oci/core/models/compute_gpu_memory_cluster.rb', line 171

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

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

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

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

  self.instance_configuration_id = attributes[:'instanceConfigurationId'] if attributes[:'instanceConfigurationId']

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

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

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

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

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

  self.gpu_memory_fabric_id = attributes[:'gpuMemoryFabricId'] if attributes[:'gpuMemoryFabricId']

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

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

  self.compute_cluster_id = attributes[:'computeClusterId'] if attributes[:'computeClusterId']

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

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

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

  self.gpu_memory_cluster_scale_config = attributes[:'gpuMemoryClusterScaleConfig'] if attributes[:'gpuMemoryClusterScaleConfig']

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

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

  self.private_ip_ids = attributes[:'privateIpIds'] if attributes[:'privateIpIds']

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

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

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

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

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

#availability_domain ⇒ String

[Required] The availability domain of the GPU Memory Cluster.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/core/models/compute_gpu_memory_cluster.rb', line 25

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the compute GPU memory cluster.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#compute_cluster_id ⇒ String

[Required] The OCID of the compute cluster.

Returns:

  • (String) 


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

def compute_cluster_id
  @compute_cluster_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>>) 


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

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) 


95
96
97
 
# File 'lib/oci/core/models/compute_gpu_memory_cluster.rb', line 95

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


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

def freeform_tags
  @freeform_tags
end

#gpu_memory_cluster_scale_config ⇒ OCI::Core::Models::ComputeGpuMemoryClusterScaleConfig

Returns:



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

def gpu_memory_cluster_scale_config
  @gpu_memory_cluster_scale_config
end

#gpu_memory_fabric_id ⇒ String

The OCID of the GPU memory fabric.

Returns:

  • (String) 


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

def gpu_memory_fabric_id
  @gpu_memory_fabric_id
end

#id ⇒ String

[Required] The OCID for the Customer-unique GPU Memory Cluster

Returns:

  • (String) 


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

def id
  @id
end

#instance_configuration_id ⇒ String

[Required] The OCID of the Instance Configuration used to source launch details for this instance.

Returns:

  • (String) 


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

def instance_configuration_id
  @instance_configuration_id
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of the GPU Memory Cluster

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#private_ip_ids ⇒ Array<String>

Unique list of OCIDs for private IPs (IPv4/IPv6) associated with the GPU Memory Cluster

Returns:

  • (Array<String>) 


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

def private_ip_ids
  @private_ip_ids
end

#size ⇒ Integer

[Required] The size represents the total number of instances in the GPU Memory Cluster, including both running instances and those still in the process of launching.

Returns:

  • (Integer) 


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

def size
  @size
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }

Returns:

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


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the GPU Memory Cluster was created.

Example: 2016-09-15T21:10:29.600Z

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'id': :'id',
    'instance_configuration_id': :'instanceConfigurationId',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'gpu_memory_fabric_id': :'gpuMemoryFabricId',
    'compute_cluster_id': :'computeClusterId',
    'size': :'size',
    'gpu_memory_cluster_scale_config': :'gpuMemoryClusterScaleConfig',
    'private_ip_ids': :'privateIpIds',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags',
    'display_name': :'displayName',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/core/models/compute_gpu_memory_cluster.rb', line 128

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'id': :'String',
    'instance_configuration_id': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'gpu_memory_fabric_id': :'String',
    'compute_cluster_id': :'String',
    'size': :'Integer',
    'gpu_memory_cluster_scale_config': :'OCI::Core::Models::ComputeGpuMemoryClusterScaleConfig',
    'private_ip_ids': :'Array<String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'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



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

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    id == other.id &&
    instance_configuration_id == other.instance_configuration_id &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    gpu_memory_fabric_id == other.gpu_memory_fabric_id &&
    compute_cluster_id == other.compute_cluster_id &&
    size == other.size &&
    gpu_memory_cluster_scale_config == other.gpu_memory_cluster_scale_config &&
    private_ip_ids == other.private_ip_ids &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    system_tags == other.system_tags &&
    display_name == other.display_name &&
    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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/oci/core/models/compute_gpu_memory_cluster.rb', line 324

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


304
305
306
 
# File 'lib/oci/core/models/compute_gpu_memory_cluster.rb', line 304

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [availability_domain, id, instance_configuration_id, compartment_id, lifecycle_state, gpu_memory_fabric_id, compute_cluster_id, size, gpu_memory_cluster_scale_config, private_ip_ids, defined_tags, freeform_tags, system_tags, display_name, 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



357
358
359
360
361
362
363
364
365
366
 
# File 'lib/oci/core/models/compute_gpu_memory_cluster.rb', line 357

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



351
352
353
 
# File 'lib/oci/core/models/compute_gpu_memory_cluster.rb', line 351

def to_s
  to_hash.to_s
end