SandboxWarmPool

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

Bases: object

CP-owned configuration and management lifecycle of a Project-owned Sandbox warm pool. Get can include best-effort runtime observations independently of lifecycle.

Attributes:

LIFECYCLE_STATE_ACTIVE	A constant which can be used with the lifecycle_state property of a SandboxWarmPool.
LIFECYCLE_STATE_CREATING	A constant which can be used with the lifecycle_state property of a SandboxWarmPool.
LIFECYCLE_STATE_DELETED	A constant which can be used with the lifecycle_state property of a SandboxWarmPool.
LIFECYCLE_STATE_DELETING	A constant which can be used with the lifecycle_state property of a SandboxWarmPool.
LIFECYCLE_STATE_FAILED	A constant which can be used with the lifecycle_state property of a SandboxWarmPool.
LIFECYCLE_STATE_UPDATING	A constant which can be used with the lifecycle_state property of a SandboxWarmPool.
SHAPE_LARGE	A constant which can be used with the shape property of a SandboxWarmPool.
SHAPE_MEDIUM	A constant which can be used with the shape property of a SandboxWarmPool.
SHAPE_SMALL	A constant which can be used with the shape property of a SandboxWarmPool.
TYPE_CUSTOM	A constant which can be used with the type property of a SandboxWarmPool.
TYPE_MANAGED	A constant which can be used with the type property of a SandboxWarmPool.
container_image	Gets the container_image of this SandboxWarmPool.
desired_capacity	[Required] Gets the desired_capacity of this SandboxWarmPool.
lifecycle_details	Gets the lifecycle_details of this SandboxWarmPool.
lifecycle_state	[Required] Gets the lifecycle_state of this SandboxWarmPool.
name	[Required] Gets the name of this SandboxWarmPool.
project_id	[Required] Gets the project_id of this SandboxWarmPool.
runtime_status	Gets the runtime_status of this SandboxWarmPool.
shape	[Required] Gets the shape of this SandboxWarmPool.
time_created	[Required] Gets the time_created of this SandboxWarmPool.
time_updated	[Required] Gets the time_updated of this SandboxWarmPool.
type	[Required] Gets the type of this SandboxWarmPool.

Methods:

__init__(**kwargs)

Initializes a new SandboxWarmPool object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

SHAPE_LARGE = 'LARGE'

A constant which can be used with the shape property of a SandboxWarmPool. This constant has a value of “LARGE”

SHAPE_MEDIUM = 'MEDIUM'

A constant which can be used with the shape property of a SandboxWarmPool. This constant has a value of “MEDIUM”

SHAPE_SMALL = 'SMALL'

A constant which can be used with the shape property of a SandboxWarmPool. This constant has a value of “SMALL”

TYPE_CUSTOM = 'CUSTOM'

A constant which can be used with the type property of a SandboxWarmPool. This constant has a value of “CUSTOM”

TYPE_MANAGED = 'MANAGED'

A constant which can be used with the type property of a SandboxWarmPool. This constant has a value of “MANAGED”

__init__(**kwargs)

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

Parameters

• project_id (str) – The value to assign to the project_id property of this SandboxWarmPool.

• name (str) – The value to assign to the name property of this SandboxWarmPool.

• type (str) – The value to assign to the type property of this SandboxWarmPool. Allowed values for this property are: “MANAGED”, “CUSTOM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• container_image (str) – The value to assign to the container_image property of this SandboxWarmPool.

• shape (str) – The value to assign to the shape property of this SandboxWarmPool. Allowed values for this property are: “SMALL”, “MEDIUM”, “LARGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• desired_capacity (int) – The value to assign to the desired_capacity property of this SandboxWarmPool.

• lifecycle_state (str) – The value to assign to the lifecycle_state property of this SandboxWarmPool. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “FAILED”, “DELETING”, “DELETED”, ‘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 SandboxWarmPool.

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

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

• runtime_status (oci.generative_ai.models.SandboxWarmPoolRuntimeStatus) – The value to assign to the runtime_status property of this SandboxWarmPool.

property container_image

Gets the container_image of this SandboxWarmPool. Digest-pinned customer image for CUSTOM; omitted for MANAGED.

Returns

The container_image of this SandboxWarmPool.

Return type

str

property desired_capacity

[Required] Gets the desired_capacity of this SandboxWarmPool. Requested idle target, not observed capacity.

Returns

The desired_capacity of this SandboxWarmPool.

Return type

int

property lifecycle_details

Gets the lifecycle_details of this SandboxWarmPool. Additional information about the current CP management operation or failure.

Returns

The lifecycle_details of this SandboxWarmPool.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this SandboxWarmPool. CP management lifecycle. ACTIVE means the template and requested pool configuration were applied and verified, independently of ready capacity. Scheduling, image-pull and runtime capacity failures do not by themselves change ACTIVE to FAILED.

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

Returns

The lifecycle_state of this SandboxWarmPool.

Return type

str

property name

[Required] Gets the name of this SandboxWarmPool. Unique immutable name within the Project.

Returns

The name of this SandboxWarmPool.

Return type

str

property project_id

[Required] Gets the project_id of this SandboxWarmPool. Owning Project OCID.

Returns

The project_id of this SandboxWarmPool.

Return type

str

property runtime_status

Gets the runtime_status of this SandboxWarmPool.

Returns

The runtime_status of this SandboxWarmPool.

Return type

oci.generative_ai.models.SandboxWarmPoolRuntimeStatus

property shape

[Required] Gets the shape of this SandboxWarmPool. Compute shape for each idle Sandbox member.

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

Returns

The shape of this SandboxWarmPool.

Return type

str

property time_created

[Required] Gets the time_created of this SandboxWarmPool. Time the desired configuration was created.

Returns

The time_created of this SandboxWarmPool.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this SandboxWarmPool. Time the configuration or management lifecycle last changed; not runtime readiness.

Returns

The time_updated of this SandboxWarmPool.

Return type

datetime

property type

[Required] Gets the type of this SandboxWarmPool. MANAGED uses the service runtime; CUSTOM uses a customer image.

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

Returns

The type of this SandboxWarmPool.

Return type

str