Class: OCI::AiLanguage::Models::CreateEndpointDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_language/models/create_endpoint_details.rb

Overview

The information needed to create a new endpoint and expose to end users.

Constant Summary collapse

COMPUTE_TYPE_ENUM = 
[
  COMPUTE_TYPE_CPU = 'CPU'.freeze,
  COMPUTE_TYPE_GPU = 'GPU'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateEndpointDetails

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

  • :compute_type (String) —

    The value to assign to the #compute_type property

  • :_alias (String) —

    The value to assign to the #_alias property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :model_id (String) —

    The value to assign to the #model_id property

  • :inference_units (Integer) —

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



105
106
107
108
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
155
156
157
158
159
160
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 105

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

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

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

  self._alias = attributes[:'alias'] if attributes[:'alias']

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

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

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

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

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

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

  self.inference_units = attributes[:'inferenceUnits'] if attributes[:'inferenceUnits']

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

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

  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

#_alias ⇒ String

Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 26

def _alias
  @_alias
end

#compartment_id ⇒ String

[Required] The OCID compartment identifier for the endpoint

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 34

def compartment_id
  @compartment_id
end

#compute_type ⇒ String

Compute infra type for endpoint.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 22

def compute_type
  @compute_type
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


54
55
56
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 54

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the an endpoint.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 30

def description
  @description
end

#display_name ⇒ String

A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 18

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


48
49
50
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 48

def freeform_tags
  @freeform_tags
end

#inference_units ⇒ Integer

Number of replicas required for this endpoint. This will be optional parameter. Default will be 1.

Returns:

  • (Integer) 


42
43
44
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 42

def inference_units
  @inference_units
end

#model_id ⇒ String

[Required] The OCID of the model to associate with the endpoint.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 38

def model_id
  @model_id
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 57

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compute_type': :'computeType',
    '_alias': :'alias',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'model_id': :'modelId',
    'inference_units': :'inferenceUnits',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 74

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compute_type': :'String',
    '_alias': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'model_id': :'String',
    'inference_units': :'Integer',
    '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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 177

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

  self.class == other.class &&
    display_name == other.display_name &&
    compute_type == other.compute_type &&
    _alias == other._alias &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    model_id == other.model_id &&
    inference_units == other.inference_units &&
    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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 215

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


195
196
197
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 195

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



204
205
206
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 204

def hash
  [display_name, compute_type, _alias, description, compartment_id, model_id, inference_units, 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



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 248

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



242
243
244
 
# File 'lib/oci/ai_language/models/create_endpoint_details.rb', line 242

def to_s
  to_hash.to_s
end