Class: OCI::GenerativeAi::Models::HostedApplication

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

Overview

Hosted Application, defines shared configurations that apply across multiple deployments of the Agent or MCP application.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies and Getting Access to Generative AI Resources.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ HostedApplication

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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/generative_ai/models/hosted_application.rb', line 170

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

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

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

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

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

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

  self.storage_configs = attributes[:'storageConfigs'] if attributes[:'storageConfigs']

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

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

  self.networking_config = attributes[:'networkingConfig'] if attributes[:'networkingConfig']

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

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

  self.environment_variables = attributes[:'environmentVariables'] if attributes[:'environmentVariables']

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

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

  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

#compartment_id ⇒ String

The compartment OCID to create the hosted application in.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 43

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


91
92
93
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 91

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the hosted application.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 39

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 35

def display_name
  @display_name
end

#environment_variables ⇒ Array<OCI::GenerativeAi::Models::EnvironmentVariable>

The list of environment variables for the Hosted Application. Defines a list of environment variables injected at runtime.

Returns:



75
76
77
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 75

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


83
84
85
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 83

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the hosted application.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 31

def id
  @id
end

#inbound_auth_config ⇒ OCI::GenerativeAi::Models::InboundAuthConfig

Returns:



27
28
29
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 27

def inbound_auth_config
  @inbound_auth_config
end

#lifecycle_details ⇒ String

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

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 59

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the hosted application.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 55

def lifecycle_state
  @lifecycle_state
end

#networking_config ⇒ OCI::GenerativeAi::Models::NetworkingConfig

Returns:



69
70
71
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 69

def networking_config
  @networking_config
end

#scaling_config ⇒ OCI::GenerativeAi::Models::ScalingConfig

Returns:



62
63
64
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 62

def scaling_config
  @scaling_config
end

#storage_configs ⇒ Array<OCI::GenerativeAi::Models::StorageConfig>

A list of storageConfigs managed by the OCI GenAI Platform and attached to the application.

Returns:



66
67
68
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 66

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


98
99
100
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 98

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The date and time the hosted application was created, in the format defined by RFC 3339

Returns:

  • (DateTime) 


47
48
49
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 47

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the hosted application was updated, in the format defined by RFC 3339

Returns:

  • (DateTime) 


51
52
53
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 51

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 101

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'inbound_auth_config': :'inboundAuthConfig',
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'scaling_config': :'scalingConfig',
    'storage_configs': :'storageConfigs',
    'networking_config': :'networkingConfig',
    'environment_variables': :'environmentVariables',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 125

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'inbound_auth_config': :'OCI::GenerativeAi::Models::InboundAuthConfig',
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'scaling_config': :'OCI::GenerativeAi::Models::ScalingConfig',
    'storage_configs': :'Array<OCI::GenerativeAi::Models::StorageConfig>',
    'networking_config': :'OCI::GenerativeAi::Models::NetworkingConfig',
    'environment_variables': :'Array<OCI::GenerativeAi::Models::EnvironmentVariable>',
    '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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 285

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

  self.class == other.class &&
    inbound_auth_config == other.inbound_auth_config &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    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 &&
    scaling_config == other.scaling_config &&
    storage_configs == other.storage_configs &&
    networking_config == other.networking_config &&
    environment_variables == other.environment_variables &&
    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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 330

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


310
311
312
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 310

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



319
320
321
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 319

def hash
  [inbound_auth_config, id, display_name, description, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, scaling_config, storage_configs, networking_config, environment_variables, 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



363
364
365
366
367
368
369
370
371
372
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 363

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



357
358
359
 
# File 'lib/oci/generative_ai/models/hosted_application.rb', line 357

def to_s
  to_hash.to_s
end