Class: OCI::AiLanguage::Models::Endpoint

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

Overview

Description of the endpoint.

Constant Summary collapse

COMPUTE_TYPE_ENUM = 
[
  COMPUTE_TYPE_CPU = 'CPU'.freeze,
  COMPUTE_TYPE_GPU = 'GPU'.freeze,
  COMPUTE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.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 = {}) ⇒ Endpoint

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

  • :_alias (String) —

    The value to assign to the #_alias property

  • :compute_type (String) —

    The value to assign to the #compute_type property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :project_id (String) —

    The value to assign to the #project_id property

  • :description (String) —

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

  • :inference_units (Integer) —

    The value to assign to the #inference_units property

  • :model_id (String) —

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



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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 168

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._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.compute_type = attributes[:'computeType'] if attributes[:'computeType']
  self.compute_type = "CPU" if compute_type.nil? && !attributes.key?(:'computeType') # rubocop:disable Style/StringLiterals

  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.compute_type = "CPU" if compute_type.nil? && !attributes.key?(:'computeType') && !attributes.key?(:'compute_type') # rubocop:disable Style/StringLiterals

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

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

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

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

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

#_alias ⇒ String

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

Returns:

  • (String) 


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

def _alias
  @_alias
end

#compartment_id ⇒ String

[Required] The OCID for the endpoint compartment.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 46

def compartment_id
  @compartment_id
end

#compute_type ⇒ String

Compute infra type for endpoint.

Returns:

  • (String) 


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

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


90
91
92
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 90

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the endpoint.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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


84
85
86
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 84

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier endpoint OCID of an endpoint that is immutable on creation.

Returns:

  • (String) 


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

def id
  @id
end

#inference_units ⇒ Integer

Number of replicas required for this endpoint.

Returns:

  • (Integer) 


74
75
76
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 74

def inference_units
  @inference_units
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 70

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The state of the endpoint.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 66

def lifecycle_state
  @lifecycle_state
end

#model_id ⇒ String

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

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 78

def model_id
  @model_id
end

#project_id ⇒ String

[Required] The OCID of the project to associate with the Endpoint.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 50

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


96
97
98
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 96

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the the endpoint was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 58

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the endpoint was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 62

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 99

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    '_alias': :'alias',
    'compute_type': :'computeType',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'project_id': :'projectId',
    'description': :'description',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'inference_units': :'inferenceUnits',
    'model_id': :'modelId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 123

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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 298

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

  self.class == other.class &&
    id == other.id &&
    _alias == other._alias &&
    compute_type == other.compute_type &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    project_id == other.project_id &&
    description == other.description &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    inference_units == other.inference_units &&
    model_id == other.model_id &&
    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



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 343

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


323
324
325
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 323

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



332
333
334
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 332

def hash
  [id, _alias, compute_type, display_name, compartment_id, project_id, description, time_created, time_updated, lifecycle_state, lifecycle_details, inference_units, model_id, 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



376
377
378
379
380
381
382
383
384
385
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 376

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



370
371
372
 
# File 'lib/oci/ai_language/models/endpoint.rb', line 370

def to_s
  to_hash.to_s
end