HostedApplicationStorage¶

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

Bases: object

defines a physical storage (database or cache) managed by service. Each application can choose one or two storages for certain purpose such as agent memory.

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 HostedApplicationStorage.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a HostedApplicationStorage.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a HostedApplicationStorage.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a HostedApplicationStorage.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a HostedApplicationStorage.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a HostedApplicationStorage.
`STORAGE_TYPE_ADB`	A constant which can be used with the storage_type property of a HostedApplicationStorage.
`STORAGE_TYPE_CACHE`	A constant which can be used with the storage_type property of a HostedApplicationStorage.
`STORAGE_TYPE_POSTGRESQL`	A constant which can be used with the storage_type property of a HostedApplicationStorage.
`application_ids`	[Required] Gets the application_ids of this HostedApplicationStorage.
`compartment_id`	[Required] Gets the compartment_id of this HostedApplicationStorage.
`defined_tags`	Gets the defined_tags of this HostedApplicationStorage.
`description`	Gets the description of this HostedApplicationStorage.
`display_name`	[Required] Gets the display_name of this HostedApplicationStorage.
`freeform_tags`	Gets the freeform_tags of this HostedApplicationStorage.
`id`	[Required] Gets the id of this HostedApplicationStorage.
`lifecycle_details`	Gets the lifecycle_details of this HostedApplicationStorage.
`lifecycle_state`	[Required] Gets the lifecycle_state of this HostedApplicationStorage.
`storage_type`	[Required] Gets the storage_type of this HostedApplicationStorage.
`system_tags`	Gets the system_tags of this HostedApplicationStorage.
`time_created`	Gets the time_created of this HostedApplicationStorage.
`time_updated`	Gets the time_updated of this HostedApplicationStorage.

Methods

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

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

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

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

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

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

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

STORAGE_TYPE_ADB = 'ADB'¶: A constant which can be used with the storage_type property of a HostedApplicationStorage. This constant has a value of “ADB”

STORAGE_TYPE_CACHE = 'CACHE'¶: A constant which can be used with the storage_type property of a HostedApplicationStorage. This constant has a value of “CACHE”

STORAGE_TYPE_POSTGRESQL = 'POSTGRESQL'¶: A constant which can be used with the storage_type property of a HostedApplicationStorage. This constant has a value of “POSTGRESQL”

__init__(**kwargs)¶

Initializes a new HostedApplicationStorage 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 HostedApplicationStorage.
display_name (str) – The value to assign to the display_name property of this HostedApplicationStorage.
description (str) – The value to assign to the description property of this HostedApplicationStorage.
compartment_id (str) – The value to assign to the compartment_id property of this HostedApplicationStorage.
storage_type (str) – The value to assign to the storage_type property of this HostedApplicationStorage. Allowed values for this property are: “CACHE”, “POSTGRESQL”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this HostedApplicationStorage.
time_updated (datetime) – The value to assign to the time_updated property of this HostedApplicationStorage.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this HostedApplicationStorage. 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 HostedApplicationStorage.
application_ids (list[str]) – The value to assign to the application_ids property of this HostedApplicationStorage.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this HostedApplicationStorage.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this HostedApplicationStorage.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this HostedApplicationStorage.

application_ids¶

[Required] Gets the application_ids of this HostedApplicationStorage. A list of application OCID.

Returns:	The application_ids of this HostedApplicationStorage.
Return type:	list[str]

compartment_id¶

[Required] Gets the compartment_id of this HostedApplicationStorage. The compartment OCID to create the hosted application in.

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

defined_tags¶

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

description¶

Gets the description of this HostedApplicationStorage. An optional description of the hosted application storage.

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

display_name¶

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

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

freeform_tags¶

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

id¶

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

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

lifecycle_details¶

Gets the lifecycle_details of this HostedApplicationStorage. A message describing the current state of the hosted application storage in more detail that can provide actionable information.

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

lifecycle_state¶

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

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 HostedApplicationStorage.
Return type:	str

storage_type¶

[Required] Gets the storage_type of this HostedApplicationStorage. type like Cache, Postgresql and ADB.

Allowed values for this property are: “CACHE”, “POSTGRESQL”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The storage_type of this HostedApplicationStorage.
Return type:	str

system_tags¶

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

time_created¶

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

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

time_updated¶

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

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