Class: OCI::GenerativeAi::Models::EndpointSummary
- Inherits:
-
Object
- Object
- OCI::GenerativeAi::Models::EndpointSummary
- Defined in:
- lib/oci/generative_ai/models/endpoint_summary.rb
Overview
Summary information for an endpoint resource.
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The compartment OCID to create the endpoint in.
- #content_moderation_config ⇒ OCI::GenerativeAi::Models::ContentModerationConfig
-
#dedicated_ai_cluster_id ⇒ String
[Required] The OCID of the dedicated AI cluster on which a model will be deployed to.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
An optional description of the endpoint.
-
#display_name ⇒ String
A user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] An OCID that uniquely identifies this endpoint resource.
-
#lifecycle_details ⇒ String
A message describing the current state with detail that can provide actionable information.
-
#lifecycle_state ⇒ String
[Required] The current state of the endpoint.
-
#model_id ⇒ String
[Required] The OCID of the model that's used to create this endpoint.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource.
-
#time_created ⇒ DateTime
[Required] The date and time that the endpoint was created in the format of an RFC3339 datetime string.
-
#time_updated ⇒ DateTime
The date and time the endpoint was updated in the format of n RFC3339 datetime string.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ EndpointSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ EndpointSummary
Initializes the object
151 152 153 154 155 156 157 158 159 160 161 162 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 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 151 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.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.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.dedicated_ai_cluster_id = attributes[:'dedicatedAiClusterId'] if attributes[:'dedicatedAiClusterId'] raise 'You cannot provide both :dedicatedAiClusterId and :dedicated_ai_cluster_id' if attributes.key?(:'dedicatedAiClusterId') && attributes.key?(:'dedicated_ai_cluster_id') self.dedicated_ai_cluster_id = attributes[:'dedicated_ai_cluster_id'] if attributes[:'dedicated_ai_cluster_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.content_moderation_config = attributes[:'contentModerationConfig'] if attributes[:'contentModerationConfig'] raise 'You cannot provide both :contentModerationConfig and :content_moderation_config' if attributes.key?(:'contentModerationConfig') && attributes.key?(:'content_moderation_config') self.content_moderation_config = attributes[:'content_moderation_config'] if attributes[:'content_moderation_config'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The compartment OCID to create the endpoint in.
30 31 32 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 30 def compartment_id @compartment_id end |
#content_moderation_config ⇒ OCI::GenerativeAi::Models::ContentModerationConfig
62 63 64 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 62 def content_moderation_config @content_moderation_config end |
#dedicated_ai_cluster_id ⇒ String
[Required] The OCID of the dedicated AI cluster on which a model will be deployed to.
34 35 36 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 34 def dedicated_ai_cluster_id @dedicated_ai_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\"}}
78 79 80 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 78 def @defined_tags end |
#description ⇒ String
An optional description of the endpoint.
22 23 24 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 22 def description @description end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique, and it's changeable.
18 19 20 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 18 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\"}
70 71 72 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 70 def @freeform_tags end |
#id ⇒ String
[Required] An OCID that uniquely identifies this endpoint resource.
14 15 16 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 14 def id @id end |
#lifecycle_details ⇒ String
A message describing the current state with detail that can provide actionable information.
59 60 61 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 59 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The current state of the endpoint.
Allowed values are: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED
55 56 57 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 55 def lifecycle_state @lifecycle_state end |
#model_id ⇒ String
[Required] The OCID of the model that's used to create this endpoint.
26 27 28 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 26 def model_id @model_id 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\"}}
85 86 87 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 85 def @system_tags end |
#time_created ⇒ DateTime
[Required] The date and time that the endpoint was created in the format of an RFC3339 datetime string.
38 39 40 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 38 def time_created @time_created end |
#time_updated ⇒ DateTime
The date and time the endpoint was updated in the format of n RFC3339 datetime string.
42 43 44 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 42 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 88 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'description': :'description', 'model_id': :'modelId', 'compartment_id': :'compartmentId', 'dedicated_ai_cluster_id': :'dedicatedAiClusterId', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'content_moderation_config': :'contentModerationConfig', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 110 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'description': :'String', 'model_id': :'String', 'compartment_id': :'String', 'dedicated_ai_cluster_id': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'content_moderation_config': :'OCI::GenerativeAi::Models::ContentModerationConfig', '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.
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 241 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && description == other.description && model_id == other.model_id && compartment_id == other.compartment_id && dedicated_ai_cluster_id == other.dedicated_ai_cluster_id && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && content_moderation_config == other.content_moderation_config && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 284 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
264 265 266 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 264 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
273 274 275 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 273 def hash [id, display_name, description, model_id, compartment_id, dedicated_ai_cluster_id, time_created, time_updated, lifecycle_state, lifecycle_details, content_moderation_config, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
317 318 319 320 321 322 323 324 325 326 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 317 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
311 312 313 |
# File 'lib/oci/generative_ai/models/endpoint_summary.rb', line 311 def to_s to_hash.to_s end |