Sandbox

class oci.generative_ai_sandbox.models.Sandbox(**kwargs)

Bases: object

Sandbox resource representation.

Attributes:

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a Sandbox.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Sandbox.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Sandbox.

LIFECYCLE_STATE_RESUMING

A constant which can be used with the lifecycle_state property of a Sandbox.

LIFECYCLE_STATE_RUNNING

A constant which can be used with the lifecycle_state property of a Sandbox.

LIFECYCLE_STATE_STOPPED

A constant which can be used with the lifecycle_state property of a Sandbox.

LIFECYCLE_STATE_STOPPING

A constant which can be used with the lifecycle_state property of a Sandbox.

LIFECYCLE_STATE_SUSPENDED

A constant which can be used with the lifecycle_state property of a Sandbox.

LIFECYCLE_STATE_SUSPENDING

A constant which can be used with the lifecycle_state property of a Sandbox.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a Sandbox.

PUBLISHED_PORT_AUTH_MODE_OCI_IAM

A constant which can be used with the published_port_auth_mode property of a Sandbox.

SHAPE_LARGE

A constant which can be used with the shape property of a Sandbox.

SHAPE_MEDIUM

A constant which can be used with the shape property of a Sandbox.

SHAPE_SMALL

A constant which can be used with the shape property of a Sandbox.

display_name

Gets the display_name of this Sandbox.

environment_variables

Gets the environment_variables of this Sandbox.

expiration_duration

Gets the expiration_duration of this Sandbox.

expires_in_minutes

Gets the expires_in_minutes of this Sandbox.

id

[Required] Gets the id of this Sandbox.

lifecycle_state

[Required] Gets the lifecycle_state of this Sandbox.

project_id

Gets the project_id of this Sandbox.

published_port_auth_mode

Gets the published_port_auth_mode of this Sandbox.

published_ports

Gets the published_ports of this Sandbox.

runtime

[Required] Gets the runtime of this Sandbox.

shape

Gets the shape of this Sandbox.

time_created

Gets the time_created of this Sandbox.

time_expires

Gets the time_expires of this Sandbox.

time_stopped

Gets the time_stopped of this Sandbox.

time_updated

Gets the time_updated of this Sandbox.

warmpool_name

Gets the warmpool_name of this Sandbox.

Methods:

__init__(**kwargs)

Initializes a new Sandbox object with values from keyword arguments.

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_RESUMING = 'RESUMING'

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

LIFECYCLE_STATE_RUNNING = 'RUNNING'

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

LIFECYCLE_STATE_STOPPED = 'STOPPED'

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

LIFECYCLE_STATE_STOPPING = 'STOPPING'

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

LIFECYCLE_STATE_SUSPENDED = 'SUSPENDED'

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

LIFECYCLE_STATE_SUSPENDING = 'SUSPENDING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

PUBLISHED_PORT_AUTH_MODE_OCI_IAM = 'OCI_IAM'

A constant which can be used with the published_port_auth_mode property of a Sandbox. This constant has a value of “OCI_IAM”

SHAPE_LARGE = 'LARGE'

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

SHAPE_MEDIUM = 'MEDIUM'

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

SHAPE_SMALL = 'SMALL'

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

__init__(**kwargs)

Initializes a new Sandbox 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 Sandbox.

  • display_name (str) – The value to assign to the display_name property of this Sandbox.

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Sandbox. Allowed values for this property are: “RUNNING”, “CREATING”, “UPDATING”, “DELETED”, “FAILED”, “SUSPENDING”, “SUSPENDED”, “RESUMING”, “STOPPING”, “STOPPED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • warmpool_name (str) – The value to assign to the warmpool_name property of this Sandbox.

  • runtime (str) – The value to assign to the runtime property of this Sandbox.

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

  • published_ports (list[oci.generative_ai_sandbox.models.PublishedPort]) – The value to assign to the published_ports property of this Sandbox.

  • environment_variables (list[oci.generative_ai_sandbox.models.EnvironmentVariable]) – The value to assign to the environment_variables property of this Sandbox.

  • expires_in_minutes (int) – The value to assign to the expires_in_minutes property of this Sandbox.

  • expiration_duration (str) – The value to assign to the expiration_duration property of this Sandbox.

  • shape (str) – The value to assign to the shape property of this Sandbox. 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’.

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

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

  • time_expires (datetime) – The value to assign to the time_expires property of this Sandbox.

  • time_stopped (datetime) – The value to assign to the time_stopped property of this Sandbox.

property display_name

Gets the display_name of this Sandbox. Display name for sandbox

Returns

The display_name of this Sandbox.

Return type

str

property environment_variables

Gets the environment_variables of this Sandbox. list of environments for sandbox

Returns

The environment_variables of this Sandbox.

Return type

list[oci.generative_ai_sandbox.models.EnvironmentVariable]

property expiration_duration

Gets the expiration_duration of this Sandbox. Deprecated. Use expiresInMinutes instead. Existing clients may pass -1 to disable automatic expiration.

Returns

The expiration_duration of this Sandbox.

Return type

str

property expires_in_minutes

Gets the expires_in_minutes of this Sandbox. Number of minutes from creation until automatic sandbox expiration. Use -1 to disable automatic expiration.

Returns

The expires_in_minutes of this Sandbox.

Return type

int

property id

[Required] Gets the id of this Sandbox. Sandbox identifier.

Returns

The id of this Sandbox.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this Sandbox. The current state of the Sandbox.

Allowed values for this property are: “RUNNING”, “CREATING”, “UPDATING”, “DELETED”, “FAILED”, “SUSPENDING”, “SUSPENDED”, “RESUMING”, “STOPPING”, “STOPPED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this Sandbox.

Return type

str

property project_id

Gets the project_id of this Sandbox. GenerativeAiProject ID that sandbox belongs to

Returns

The project_id of this Sandbox.

Return type

str

property published_port_auth_mode

Gets the published_port_auth_mode of this Sandbox. Persisted published-port authorization mode. Absent for legacy sandboxes. Immutable after creation.

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

Returns

The published_port_auth_mode of this Sandbox.

Return type

str

property published_ports

Gets the published_ports of this Sandbox. Published ports for the sandbox proxy endpoint.

Returns

The published_ports of this Sandbox.

Return type

list[oci.generative_ai_sandbox.models.PublishedPort]

property runtime

[Required] Gets the runtime of this Sandbox. The sandbox runtime type. For customer-provided containers, use a same-region Oracle Cloud Infrastructure Registry image reference.

Returns

The runtime of this Sandbox.

Return type

str

property shape

Gets the shape of this Sandbox. shape for sandbox

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 Sandbox.

Return type

str

property time_created

Gets the time_created of this Sandbox. The date and time the sandbox was created, in RFC 3339 format.

Returns

The time_created of this Sandbox.

Return type

datetime

property time_expires

Gets the time_expires of this Sandbox. The date and time the sandbox expires, in RFC 3339 format.

Returns

The time_expires of this Sandbox.

Return type

datetime

property time_stopped

Gets the time_stopped of this Sandbox. The date and time the sandbox was stopped or expired, in RFC 3339 format.

Returns

The time_stopped of this Sandbox.

Return type

datetime

property time_updated

Gets the time_updated of this Sandbox. The date and time the sandbox was updated, in RFC 3339 format.

Returns

The time_updated of this Sandbox.

Return type

datetime

property warmpool_name

Gets the warmpool_name of this Sandbox. Name of the source warm pool, when selected explicitly or automatically at creation. The persisted association is retained on retries.

Returns

The warmpool_name of this Sandbox.

Return type

str