Class: OCI::GenerativeAi::Models::DedicatedAiClusterSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb

Overview

Summary information about a dedicated AI cluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DedicatedAiClusterSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :type (String) —

    The value to assign to the #type property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :unit_count (Integer) —

    The value to assign to the #unit_count property

  • :unit_shape (String) —

    The value to assign to the #unit_shape property

  • :capacity (OCI::GenerativeAi::Models::DedicatedAiClusterCapacity) —

    The value to assign to the #capacity property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
234
235
236
237
238
239
240
241
242
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 163

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

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

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

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

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

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

  self.unit_count = attributes[:'unitCount'] if attributes[:'unitCount']

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

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

  self.unit_shape = attributes[:'unitShape'] if attributes[:'unitShape']

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

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

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

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

Instance Attribute Details

#capacity ⇒ OCI::GenerativeAi::Models::DedicatedAiClusterCapacity

Returns:



71
72
73
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 71

def capacity
  @capacity
end

#compartment_id ⇒ String

[Required] The compartment OCID to create the dedicated AI cluster in.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 34

def compartment_id
  @compartment_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>>) 


87
88
89
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 87

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the dedicated AI cluster.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 21

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 17

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


79
80
81
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 79

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the dedicated AI cluster.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 13

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state of the dedicated AI cluster in more detail that can provide actionable information.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 60

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the dedicated AI cluster.

Allowed values are: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 56

def lifecycle_state
  @lifecycle_state
end

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

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


94
95
96
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 94

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the dedicated AI cluster was created, in the format defined by RFC 3339.

Returns:

  • (DateTime) 


38
39
40
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 38

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339.

Returns:

  • (DateTime) 


42
43
44
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 42

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.

Allowed values are: - HOSTING - FINE_TUNING

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 30

def type
  @type
end

#unit_count ⇒ Integer

[Required] The number of dedicated units in this AI cluster.

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 64

def unit_count
  @unit_count
end

#unit_shape ⇒ String

[Required] The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 68

def unit_shape
  @unit_shape
end

Class Method Details

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 97

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'type': :'type',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'unit_count': :'unitCount',
    'unit_shape': :'unitShape',
    'capacity': :'capacity',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 120

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'type': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'unit_count': :'Integer',
    'unit_shape': :'String',
    'capacity': :'OCI::GenerativeAi::Models::DedicatedAiClusterCapacity',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 251

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    type == other.type &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    unit_count == other.unit_count &&
    unit_shape == other.unit_shape &&
    capacity == other.capacity &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 295

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


275
276
277
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 275

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



284
285
286
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 284

def hash
  [id, display_name, description, type, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, unit_count, unit_shape, capacity, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 328

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



322
323
324
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster_summary.rb', line 322

def to_s
  to_hash.to_s
end