SandboxSummary

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

Bases: object

Sandbox resource representation.

Attributes:

SHAPE_LARGE

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

SHAPE_MEDIUM

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

SHAPE_SMALL

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

display_name

Gets the display_name of this SandboxSummary.

expiration_duration

Gets the expiration_duration of this SandboxSummary.

expires_in_minutes

Gets the expires_in_minutes of this SandboxSummary.

id

[Required] Gets the id of this SandboxSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this SandboxSummary. The current state of the Sandbox. Allowed values are: - RUNNING - CREATING - UPDATING - DELETED - FAILED - SUSPENDING - SUSPENDED - RESUMING - STOPPING - STOPPED.

project_id

Gets the project_id of this SandboxSummary.

published_port_auth_mode

Gets the published_port_auth_mode of this SandboxSummary.

published_ports

Gets the published_ports of this SandboxSummary.

runtime

[Required] Gets the runtime of this SandboxSummary.

shape

Gets the shape of this SandboxSummary.

time_created

Gets the time_created of this SandboxSummary.

time_expires

Gets the time_expires of this SandboxSummary.

time_stopped

Gets the time_stopped of this SandboxSummary.

time_updated

Gets the time_updated of this SandboxSummary.

warmpool_name

Gets the warmpool_name of this SandboxSummary.

Methods:

__init__(**kwargs)

Initializes a new SandboxSummary object with values from keyword arguments.

SHAPE_LARGE = 'LARGE'

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

SHAPE_MEDIUM = 'MEDIUM'

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

SHAPE_SMALL = 'SMALL'

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

__init__(**kwargs)

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

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SandboxSummary.

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

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

  • published_port_auth_mode (str) – The value to assign to the published_port_auth_mode property of this SandboxSummary.

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

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

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

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

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

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

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

property display_name

Gets the display_name of this SandboxSummary. Display name for sandbox

Returns

The display_name of this SandboxSummary.

Return type

str

property expiration_duration

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

Returns

The expiration_duration of this SandboxSummary.

Return type

str

property expires_in_minutes

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

Returns

The expires_in_minutes of this SandboxSummary.

Return type

int

property id

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

Returns

The id of this SandboxSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this SandboxSummary. The current state of the Sandbox. Allowed values are:

  • RUNNING

  • CREATING

  • UPDATING

  • DELETED

  • FAILED

  • SUSPENDING

  • SUSPENDED

  • RESUMING

  • STOPPING

  • STOPPED

Returns

The lifecycle_state of this SandboxSummary.

Return type

str

property project_id

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

Returns

The project_id of this SandboxSummary.

Return type

str

property published_port_auth_mode

Gets the published_port_auth_mode of this SandboxSummary. Persisted published-port authorization mode. Absent for legacy sandboxes.

Returns

The published_port_auth_mode of this SandboxSummary.

Return type

str

property published_ports

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

Returns

The published_ports of this SandboxSummary.

Return type

list[oci.generative_ai_sandbox.models.PublishedPort]

property runtime

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

Returns

The runtime of this SandboxSummary.

Return type

str

property shape

Gets the shape of this SandboxSummary. 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 SandboxSummary.

Return type

str

property time_created

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

Returns

The time_created of this SandboxSummary.

Return type

datetime

property time_expires

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

Returns

The time_expires of this SandboxSummary.

Return type

datetime

property time_stopped

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

Returns

The time_stopped of this SandboxSummary.

Return type

datetime

property time_updated

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

Returns

The time_updated of this SandboxSummary.

Return type

datetime

property warmpool_name

Gets the warmpool_name of this SandboxSummary. 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 SandboxSummary.

Return type

str