ProvisionedCapacity¶

class oci.generative_ai_agent.models.ProvisionedCapacity(**kwargs)¶

Bases: object

A provisioned capacity is a resource pool of Genrative AI DACs with properties like AgentRuntimeVersion, unit size, and a tool name to DAC ID mapping.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ProvisionedCapacity.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ProvisionedCapacity.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ProvisionedCapacity.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ProvisionedCapacity.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ProvisionedCapacity.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ProvisionedCapacity.
`compartment_id`	[Required] Gets the compartment_id of this ProvisionedCapacity.
`defined_tags`	Gets the defined_tags of this ProvisionedCapacity.
`description`	Gets the description of this ProvisionedCapacity.
`display_name`	Gets the display_name of this ProvisionedCapacity.
`freeform_tags`	Gets the freeform_tags of this ProvisionedCapacity.
`id`	[Required] Gets the id of this ProvisionedCapacity.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ProvisionedCapacity.
`number_of_units`	[Required] Gets the number_of_units of this ProvisionedCapacity.
`system_tags`	Gets the system_tags of this ProvisionedCapacity.
`time_created`	[Required] Gets the time_created of this ProvisionedCapacity.
`time_updated`	Gets the time_updated of this ProvisionedCapacity.

Methods

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new ProvisionedCapacity 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 ProvisionedCapacity.
display_name (str) – The value to assign to the display_name property of this ProvisionedCapacity.
description (str) – The value to assign to the description property of this ProvisionedCapacity.
compartment_id (str) – The value to assign to the compartment_id property of this ProvisionedCapacity.
number_of_units (int) – The value to assign to the number_of_units property of this ProvisionedCapacity.
time_created (datetime) – The value to assign to the time_created property of this ProvisionedCapacity.
time_updated (datetime) – The value to assign to the time_updated property of this ProvisionedCapacity.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ProvisionedCapacity. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ProvisionedCapacity.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ProvisionedCapacity.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ProvisionedCapacity.

compartment_id¶

[Required] Gets the compartment_id of this ProvisionedCapacity. The OCID of the compartment.

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

defined_tags¶

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

description¶

Gets the description of this ProvisionedCapacity. An optional description of the provisioned capacity.

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

display_name¶

Gets the display_name of this ProvisionedCapacity. The name of the provisioned capacity.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this ProvisionedCapacity. The OCID of the provisioned capacity.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this ProvisionedCapacity. The current state of the provisioned capacity.

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

number_of_units¶

[Required] Gets the number_of_units of this ProvisionedCapacity. Provisioned Capacity Unit corresponds to the amount of characters processed per minute.

Returns:	The number_of_units of this ProvisionedCapacity.
Return type:	int

system_tags¶

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

time_created¶

[Required] Gets the time_created of this ProvisionedCapacity. The date and time the provisioned capacity was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

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

time_updated¶

Gets the time_updated of this ProvisionedCapacity. The date and time the provisioned capacity was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

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