Class: OCI::GenerativeAi::Models::CreateDedicatedAiClusterDetails

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

Overview

The data to create a dedicated AI cluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDedicatedAiClusterDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :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

  • :unit_count (Integer) —

    The value to assign to the #unit_count property

  • :unit_shape (String) —

    The value to assign to the #unit_shape 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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/generative_ai/models/create_dedicated_ai_cluster_details.rb', line 109

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

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


61
62
63
 
# File 'lib/oci/generative_ai/models/create_dedicated_ai_cluster_details.rb', line 61

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the dedicated AI cluster.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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


53
54
55
 
# File 'lib/oci/generative_ai/models/create_dedicated_ai_cluster_details.rb', line 53

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


26
27
28
 
# File 'lib/oci/generative_ai/models/create_dedicated_ai_cluster_details.rb', line 26

def type
  @type
end

#unit_count ⇒ Integer

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

Returns:

  • (Integer) 


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

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.

Allowed values are: - LARGE_COHERE - SMALL_COHERE - EMBED_COHERE - LLAMA2_70

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/generative_ai/models/create_dedicated_ai_cluster_details.rb', line 45

def unit_shape
  @unit_shape
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/generative_ai/models/create_dedicated_ai_cluster_details.rb', line 64

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'type': :'type',
    'compartment_id': :'compartmentId',
    'unit_count': :'unitCount',
    'unit_shape': :'unitShape',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/generative_ai/models/create_dedicated_ai_cluster_details.rb', line 80

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'type': :'String',
    'compartment_id': :'String',
    'unit_count': :'Integer',
    'unit_shape': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/generative_ai/models/create_dedicated_ai_cluster_details.rb', line 163

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    type == other.type &&
    compartment_id == other.compartment_id &&
    unit_count == other.unit_count &&
    unit_shape == other.unit_shape &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/generative_ai/models/create_dedicated_ai_cluster_details.rb', line 200

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


180
181
182
 
# File 'lib/oci/generative_ai/models/create_dedicated_ai_cluster_details.rb', line 180

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/oci/generative_ai/models/create_dedicated_ai_cluster_details.rb', line 189

def hash
  [display_name, description, type, compartment_id, unit_count, unit_shape, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



233
234
235
236
237
238
239
240
241
242
 
# File 'lib/oci/generative_ai/models/create_dedicated_ai_cluster_details.rb', line 233

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



227
228
229
 
# File 'lib/oci/generative_ai/models/create_dedicated_ai_cluster_details.rb', line 227

def to_s
  to_hash.to_s
end