HostedDeployment¶

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

Bases: object

Hosted deployment is designed to support the full spectrum of agent use cases from lightweight, employee-facing assistants and internal workflow automation, to enterprise-grade, large-scale customer-facing workloads.

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 HostedDeployment.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a HostedDeployment.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a HostedDeployment.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a HostedDeployment.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a HostedDeployment.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a HostedDeployment.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a HostedDeployment.
`active_artifact`	[Required] Gets the active_artifact of this HostedDeployment.
`artifacts`	[Required] Gets the artifacts of this HostedDeployment.
`compartment_id`	Gets the compartment_id of this HostedDeployment.
`defined_tags`	Gets the defined_tags of this HostedDeployment.
`display_name`	Gets the display_name of this HostedDeployment.
`freeform_tags`	Gets the freeform_tags of this HostedDeployment.
`hosted_application_id`	[Required] Gets the hosted_application_id of this HostedDeployment.
`id`	[Required] Gets the id of this HostedDeployment.
`lifecycle_state`	[Required] Gets the lifecycle_state of this HostedDeployment.
`system_tags`	Gets the system_tags of this HostedDeployment.
`time_created`	Gets the time_created of this HostedDeployment.
`time_updated`	Gets the time_updated of this HostedDeployment.

Methods

__init__(**kwargs) Initializes a new HostedDeployment object with values from keyword arguments.

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

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

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

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

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a HostedDeployment. This constant has a value of “INACTIVE”

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

__init__(**kwargs)¶

Initializes a new HostedDeployment 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 HostedDeployment.
display_name (str) – The value to assign to the display_name property of this HostedDeployment.
compartment_id (str) – The value to assign to the compartment_id property of this HostedDeployment.
time_created (datetime) – The value to assign to the time_created property of this HostedDeployment.
time_updated (datetime) – The value to assign to the time_updated property of this HostedDeployment.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this HostedDeployment. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
hosted_application_id (str) – The value to assign to the hosted_application_id property of this HostedDeployment.
active_artifact (oci.generative_ai.models.Artifact) – The value to assign to the active_artifact property of this HostedDeployment.
artifacts (list[oci.generative_ai.models.Artifact]) – The value to assign to the artifacts property of this HostedDeployment.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this HostedDeployment.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this HostedDeployment.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this HostedDeployment.

active_artifact¶

[Required] Gets the active_artifact of this HostedDeployment.

Returns:	The active_artifact of this HostedDeployment.
Return type:	oci.generative_ai.models.Artifact

artifacts¶

[Required] Gets the artifacts of this HostedDeployment. array of Artifacts.

Returns:	The artifacts of this HostedDeployment.
Return type:	list[oci.generative_ai.models.Artifact]

compartment_id¶

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

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

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

hosted_application_id¶

[Required] Gets the hosted_application_id of this HostedDeployment. The OCID of the application.

Returns:	The hosted_application_id of this HostedDeployment.
Return type:	str

id¶

[Required] Gets the id of this HostedDeployment. The OCID of the hosted deployment.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this HostedDeployment. The current state of the hosted deployment.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “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 HostedDeployment.
Return type:	str

system_tags¶

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

time_created¶

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

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

time_updated¶

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

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