HostedApplicationBase

class oci.generative_ai.models.HostedApplicationBase(**kwargs)

Bases: object

Common properties shared by HostedApplication and HostedApplicationIam.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a HostedApplicationBase.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a HostedApplicationBase.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a HostedApplicationBase.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a HostedApplicationBase.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a HostedApplicationBase.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a HostedApplicationBase.

compartment_id

Gets the compartment_id of this HostedApplicationBase.

defined_tags

Gets the defined_tags of this HostedApplicationBase.

description

Gets the description of this HostedApplicationBase.

display_name

[Required] Gets the display_name of this HostedApplicationBase.

environment_variables

Gets the environment_variables of this HostedApplicationBase.

freeform_tags

Gets the freeform_tags of this HostedApplicationBase.

id

[Required] Gets the id of this HostedApplicationBase.

lifecycle_details

Gets the lifecycle_details of this HostedApplicationBase.

lifecycle_state

[Required] Gets the lifecycle_state of this HostedApplicationBase.

networking_config

Gets the networking_config of this HostedApplicationBase.

scaling_config

Gets the scaling_config of this HostedApplicationBase.

storage_configs

Gets the storage_configs of this HostedApplicationBase.

system_tags

Gets the system_tags of this HostedApplicationBase.

time_created

Gets the time_created of this HostedApplicationBase.

time_updated

Gets the time_updated of this HostedApplicationBase.

Methods:

__init__(**kwargs)

Initializes a new HostedApplicationBase object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a HostedApplicationBase. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a HostedApplicationBase. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a HostedApplicationBase. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a HostedApplicationBase. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a HostedApplicationBase. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a HostedApplicationBase. This constant has a value of “UPDATING”

__init__(**kwargs)

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

Parameters
  • id (str) – The value to assign to the id property of this HostedApplicationBase.

  • display_name (str) – The value to assign to the display_name property of this HostedApplicationBase.

  • description (str) – The value to assign to the description property of this HostedApplicationBase.

  • compartment_id (str) – The value to assign to the compartment_id property of this HostedApplicationBase.

  • time_created (datetime) – The value to assign to the time_created property of this HostedApplicationBase.

  • time_updated (datetime) – The value to assign to the time_updated property of this HostedApplicationBase.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this HostedApplicationBase. 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 HostedApplicationBase.

  • scaling_config (oci.generative_ai.models.ScalingConfig) – The value to assign to the scaling_config property of this HostedApplicationBase.

  • storage_configs (list[oci.generative_ai.models.StorageConfig]) – The value to assign to the storage_configs property of this HostedApplicationBase.

  • networking_config (oci.generative_ai.models.NetworkingConfig) – The value to assign to the networking_config property of this HostedApplicationBase.

  • environment_variables (list[oci.generative_ai.models.EnvironmentVariable]) – The value to assign to the environment_variables property of this HostedApplicationBase.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this HostedApplicationBase.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this HostedApplicationBase.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this HostedApplicationBase.

property compartment_id

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

Returns

The compartment_id of this HostedApplicationBase.

Return type

str

property defined_tags

Gets the defined_tags of this HostedApplicationBase. 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 HostedApplicationBase.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this HostedApplicationBase.

Return type

str

property display_name

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

Returns

The display_name of this HostedApplicationBase.

Return type

str

property environment_variables

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

Returns

The environment_variables of this HostedApplicationBase.

Return type

list[oci.generative_ai.models.EnvironmentVariable]

property freeform_tags

Gets the freeform_tags of this HostedApplicationBase. 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 HostedApplicationBase.

Return type

dict(str, str)

property id

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

Returns

The id of this HostedApplicationBase.

Return type

str

property lifecycle_details

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

Returns

The lifecycle_details of this HostedApplicationBase.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this HostedApplicationBase. 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 HostedApplicationBase.

Return type

str

property networking_config

Gets the networking_config of this HostedApplicationBase.

Returns

The networking_config of this HostedApplicationBase.

Return type

oci.generative_ai.models.NetworkingConfig

property scaling_config

Gets the scaling_config of this HostedApplicationBase.

Returns

The scaling_config of this HostedApplicationBase.

Return type

oci.generative_ai.models.ScalingConfig

property storage_configs

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

Returns

The storage_configs of this HostedApplicationBase.

Return type

list[oci.generative_ai.models.StorageConfig]

property system_tags

Gets the system_tags of this HostedApplicationBase. 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 HostedApplicationBase.

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this HostedApplicationBase.

Return type

datetime

property time_updated

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

Returns

The time_updated of this HostedApplicationBase.

Return type

datetime