CreateSandboxWarmPoolDetails¶

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

Bases: object

Create Sandbox Warm Pool Details.

Attributes

`SHAPE_LARGE`	A constant which can be used with the shape property of a CreateSandboxWarmPoolDetails.
`SHAPE_MEDIUM`	A constant which can be used with the shape property of a CreateSandboxWarmPoolDetails.
`SHAPE_SMALL`	A constant which can be used with the shape property of a CreateSandboxWarmPoolDetails.
`TYPE_CUSTOM`	A constant which can be used with the type property of a CreateSandboxWarmPoolDetails.
`TYPE_MANAGED`	A constant which can be used with the type property of a CreateSandboxWarmPoolDetails.
`container_image`	Gets the container_image of this CreateSandboxWarmPoolDetails.
`desired_capacity`	[Required] Gets the desired_capacity of this CreateSandboxWarmPoolDetails.
`name`	[Required] Gets the name of this CreateSandboxWarmPoolDetails.
`shape`	[Required] Gets the shape of this CreateSandboxWarmPoolDetails.
`type`	[Required] Gets the type of this CreateSandboxWarmPoolDetails.

Methods

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

SHAPE_LARGE = 'LARGE'¶: A constant which can be used with the shape property of a CreateSandboxWarmPoolDetails. This constant has a value of “LARGE”

SHAPE_MEDIUM = 'MEDIUM'¶: A constant which can be used with the shape property of a CreateSandboxWarmPoolDetails. This constant has a value of “MEDIUM”

SHAPE_SMALL = 'SMALL'¶: A constant which can be used with the shape property of a CreateSandboxWarmPoolDetails. This constant has a value of “SMALL”

TYPE_CUSTOM = 'CUSTOM'¶: A constant which can be used with the type property of a CreateSandboxWarmPoolDetails. This constant has a value of “CUSTOM”

TYPE_MANAGED = 'MANAGED'¶: A constant which can be used with the type property of a CreateSandboxWarmPoolDetails. This constant has a value of “MANAGED”

__init__(**kwargs)¶

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

Parameters:

name (str) – The value to assign to the name property of this CreateSandboxWarmPoolDetails.
type (str) – The value to assign to the type property of this CreateSandboxWarmPoolDetails. Allowed values for this property are: “MANAGED”, “CUSTOM”
container_image (str) – The value to assign to the container_image property of this CreateSandboxWarmPoolDetails.
shape (str) – The value to assign to the shape property of this CreateSandboxWarmPoolDetails. Allowed values for this property are: “SMALL”, “MEDIUM”, “LARGE”
desired_capacity (int) – The value to assign to the desired_capacity property of this CreateSandboxWarmPoolDetails.

container_image¶

Gets the container_image of this CreateSandboxWarmPoolDetails. Required for CUSTOM and must be omitted for MANAGED. A CUSTOM image must be a digest-pinned same-region OCIR reference, using sha256 with exactly 64 lowercase hexadecimal characters. The CP workflow prepares the template through the data plane, reusing current BYOC image and Project identity validation. Successful configuration does not guarantee image pull or runtime readiness.

Returns:	The container_image of this CreateSandboxWarmPoolDetails.
Return type:	str

desired_capacity¶

[Required] Gets the desired_capacity of this CreateSandboxWarmPoolDetails. Desired number of idle members. Zero pauses idle prewarming. Once the pool is ACTIVE, named-pool Sandbox creation can still cold-start from its available applied template when no eligible warm member is available. Existing customer Sandboxes continue. A positive target does not guarantee ready capacity. Existing service capacity validation still applies.

Returns:	The desired_capacity of this CreateSandboxWarmPoolDetails.
Return type:	int

name¶

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

Returns:	The name of this CreateSandboxWarmPoolDetails.
Return type:	str

shape¶

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

Allowed values for this property are: “SMALL”, “MEDIUM”, “LARGE”

Returns:	The shape of this CreateSandboxWarmPoolDetails.
Return type:	str

type¶

[Required] Gets the type of this CreateSandboxWarmPoolDetails. MANAGED uses the service-provided python-3.11 runtime. CUSTOM uses a customer-provided containerImage. Both types support named pool creation.

Allowed values for this property are: “MANAGED”, “CUSTOM”

Returns:	The type of this CreateSandboxWarmPoolDetails.
Return type:	str