HostedApplication¶

class oci.generative_ai.models.HostedApplication(**kwargs)¶

Bases: object

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.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a HostedApplication.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a HostedApplication.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a HostedApplication.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a HostedApplication.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a HostedApplication.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a HostedApplication.
`application_endpoint`	Gets the application_endpoint of this HostedApplication.
`compartment_id`	Gets the compartment_id of this HostedApplication.
`defined_tags`	Gets the defined_tags of this HostedApplication.
`description`	Gets the description of this HostedApplication.
`display_name`	[Required] Gets the display_name of this HostedApplication.
`environment_variables`	Gets the environment_variables of this HostedApplication.
`freeform_tags`	Gets the freeform_tags of this HostedApplication.
`id`	[Required] Gets the id of this HostedApplication.
`inbound_auth_config`	Gets the inbound_auth_config of this HostedApplication.
`lifecycle_details`	Gets the lifecycle_details of this HostedApplication.
`lifecycle_state`	[Required] Gets the lifecycle_state of this HostedApplication.
`networking_config`	Gets the networking_config of this HostedApplication.
`public_access_path_patterns`	Gets the public_access_path_patterns of this HostedApplication.
`scaling_config`	Gets the scaling_config of this HostedApplication.
`storage_configs`	Gets the storage_configs of this HostedApplication.
`system_tags`	Gets the system_tags of this HostedApplication.
`time_created`	Gets the time_created of this HostedApplication.
`time_updated`	Gets the time_updated of this HostedApplication.

Methods:

__init__(**kwargs)

Initializes a new HostedApplication object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a HostedApplication. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a HostedApplication. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a HostedApplication. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a HostedApplication. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a HostedApplication. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a HostedApplication. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new HostedApplication object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

inbound_auth_config (oci.generative_ai.models.InboundAuthConfig) – The value to assign to the inbound_auth_config property of this HostedApplication.
application_endpoint (str) – The value to assign to the application_endpoint property of this HostedApplication.
public_access_path_patterns (list[str]) – The value to assign to the public_access_path_patterns property of this HostedApplication.
id (str) – The value to assign to the id property of this HostedApplication.
display_name (str) – The value to assign to the display_name property of this HostedApplication.
description (str) – The value to assign to the description property of this HostedApplication.
compartment_id (str) – The value to assign to the compartment_id property of this HostedApplication.
time_created (datetime) – The value to assign to the time_created property of this HostedApplication.
time_updated (datetime) – The value to assign to the time_updated property of this HostedApplication.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this HostedApplication. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this HostedApplication.
scaling_config (oci.generative_ai.models.ScalingConfig) – The value to assign to the scaling_config property of this HostedApplication.
storage_configs (list[oci.generative_ai.models.StorageConfig]) – The value to assign to the storage_configs property of this HostedApplication.
networking_config (oci.generative_ai.models.NetworkingConfig) – The value to assign to the networking_config property of this HostedApplication.
environment_variables (list[oci.generative_ai.models.EnvironmentVariable]) – The value to assign to the environment_variables property of this HostedApplication.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this HostedApplication.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this HostedApplication.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this HostedApplication.

property application_endpoint¶

Gets the application_endpoint of this HostedApplication. Fully qualified domain name for invoking the hosted application over the dual-stack endpoint. This value is output-only and is present only after the service has generated an application DNS label.

Returns: The application_endpoint of this HostedApplication.
Return type: str

property compartment_id¶

Gets the compartment_id of this HostedApplication. The compartment OCID to create the hosted application in.

Returns: The compartment_id of this HostedApplication.
Return type: str

property defined_tags¶

Gets the defined_tags of this HostedApplication. 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: The defined_tags of this HostedApplication.
Return type: dict(str, dict(str, object))

property description¶

Gets the description of this HostedApplication. An optional description of the hosted application.

Returns: The description of this HostedApplication.
Return type: str

property display_name¶

[Required] Gets the display_name of this HostedApplication. A user-friendly name. Does not have to be unique, and it’s changeable.

Returns: The display_name of this HostedApplication.
Return type: str

property environment_variables¶

Gets the environment_variables of this HostedApplication. The list of environment variables for the Hosted Application. Defines a list of environment variables injected at runtime.

Returns: The environment_variables of this HostedApplication.
Return type: list[oci.generative_ai.models.EnvironmentVariable]

property freeform_tags¶

Gets the freeform_tags of this HostedApplication. 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: The freeform_tags of this HostedApplication.
Return type: dict(str, str)

property id¶

[Required] Gets the id of this HostedApplication. The OCID of the hosted application.

Returns: The id of this HostedApplication.
Return type: str

property inbound_auth_config¶

Gets the inbound_auth_config of this HostedApplication.

Returns: The inbound_auth_config of this HostedApplication.
Return type: oci.generative_ai.models.InboundAuthConfig

property lifecycle_details¶

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

Returns: The lifecycle_details of this HostedApplication.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this HostedApplication. The current state of the hosted application.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The lifecycle_state of this HostedApplication.
Return type: str

property networking_config¶

Gets the networking_config of this HostedApplication.

Returns: The networking_config of this HostedApplication.
Return type: oci.generative_ai.models.NetworkingConfig

property public_access_path_patterns¶

Gets the public_access_path_patterns of this HostedApplication. A list of hosted application path patterns that can be accessed without inbound authentication. Values can be exact paths such as /health or /callback, or wildcard paths such as /assets/* or /public/*.

Returns: The public_access_path_patterns of this HostedApplication.
Return type: list[str]

property scaling_config¶

Gets the scaling_config of this HostedApplication.

Returns: The scaling_config of this HostedApplication.
Return type: oci.generative_ai.models.ScalingConfig

property storage_configs¶

Gets the storage_configs of this HostedApplication. A list of managed storage configurations for the application.

Returns: The storage_configs of this HostedApplication.
Return type: list[oci.generative_ai.models.StorageConfig]

property system_tags¶

Gets the system_tags of this HostedApplication. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns: The system_tags of this HostedApplication.
Return type: dict(str, dict(str, object))

property time_created¶

Gets the time_created of this HostedApplication. The date and time the hosted application was created, in the format defined by RFC 3339

Returns: The time_created of this HostedApplication.
Return type: datetime

property time_updated¶

Gets the time_updated of this HostedApplication. The date and time the hosted application was updated, in the format defined by RFC 3339

Returns: The time_updated of this HostedApplication.
Return type: datetime